软件详细设计说明书实例.doc

(完整版)软件详细设计说明书实例软件详细设计说明书实例2024年5月目录1引言21。1编写目的21。2项目背景21。3定义21。4参考资料22总体设计22.1需求概述22。2软件结构23程序描述23.101登陆模块23.202管理模块23。3031图书信息查询模块23.4032学生信息查询模块23.5021入库管理模块23。6022学生借书模块23.7023学生还书模块23.8024图书注销模块23。9接口设计23.10测试要点2 2024/5/25 周六文档名称： 详细设计规格说明书项目名称： 图书馆管理系统项目负责人：陈新光 编写 TEST _年_月_日 校对 所有小组成员 _年_月_日 审核 所有小组成员 _年_月_日 批准 XXX _年_月_日 开发单位_组员： TEST1 TEST2 TEST31 引言1.1 编写目的图书管理系统详细设计是设计的第二个阶段，这个阶段的主要任务是在图书管理系统概要设计书基础上,对概要设计中产生的功能模块进行过程描述，设计功能模块的内部细节，包括算法和详细数据结构，为编写源代码提供必要的说明.概要设计解决了软件系统总体结构设计的问题，包括整个软件系统的结构、模块划分、模块功能和模块间的联系等。详细设计则要解决如何实现各个模块的内部功能,即模块设计。具体的说,模块设计就是要为已经产生的图书管理各子系统设计详细的算法。但这并不等同于系统实现阶段用具体的语言编码，它只是对实现细节作精确的描述，这样编码阶段就可以将详细设计中对功能实现的描述,直接翻译、转化为用某种程序设计语言书写的程序。1.2 项目背景根据XX学校希望能够充分利用现代科技来提高图书管理的效率，在原有的办公系统基础上进行扩展,将一些可以用计算机来管理的都进行计算机化，使得图书馆管理人员工作更加方便，工作效率也更加的高.1.3 定义Mysql：数据库管理软件DBMS：数据库管理系统Windows 2000/2003/XP:运行环境JSP ：软件开发语言Myeclipse :开发工具1.4 参考资料软件工程导论第5版 张海藩编著 清华大学出版社 实用软件工程Leszek A。Maciaszek Bruc Lee Liong著机械工业出版社2 总体设计2.1 需求概述按照需求分析文档中的规格要求,使用条形码扫描器进书、借书、还书，使得信息传递准确、流畅。同时，系统最大限度地实现易安装，易维护性，易操作性，运行稳定,安全可靠。2.2 软件结构系统由3大模块,6小模块组成：序号编号名称1， 01 登陆模块2， 02 管理模块3， 031图书信息查询模块4， 032学生信息查询模块5， 021入库管理模块6， 022学生借书模块7， 023学生还书模块8， 024图书注销模块9， 040基础信息设置3 程序描述3.1 01登陆模块具体格式见下表：功能编号01功能名称登陆模块内容功能流程图所属业务图书馆管理所属项目图书馆管理系统编写人陈新光完成时间20071126页码第5页3.1.1 功能流程图功能流程图如下图所示.需要说明的问题:（1） 录入项检测使用javascript实现(各项必须非空)（2） 登陆.jsp页面也包含查询按钮，在此的登陆.jsp提交的数据只是用户名和密码。3.1.2 功能描述（1） 功能类型：查询数据（2） 功能描述：提高系统的安全性（3） 前提业务：无（4） 后继业务：02 （管理模块）（5） 功能约束：权限约束（6） 约束描述：（7） 操作权限：图书馆管理员3.1.3 界面设计（1） 基础信息处理 动作说明:动作编号动作名称动作描述A01登陆点击登陆按钮 提交数据到登陆数据处理.jsp页面A02重至点击退重至按钮 将当前信息恢复原先状态A03图书信息查询点击 将页面转至到图书信息查询。jsp页面A04学生信息查询点击 将页面转至学生信息查询.jsp页面A05基础信息点击 将显示基础信息（2） 数据要求(1) 功能类型：数据查询(2) 数据描述：页面显示录入字段如下：字段名称长度录入方式是否非空项数据检验默认显示管理员ID10文本框YN管理员密码15passwordYN3.1.4 登陆数据处理。jsp的内部逻辑登陆数据处理：关键点两点：1，数据库连接；2，记录登陆信息及信息处理；1， 数据库连接： 如下：public class lib_system_Conn extends Objectpublic lib_system_Conn(） private Connection conn = null； private ResultSet rs； String re = ”; /设置你的数据库ip String dbip = ”127.0。0.1; /设置你的数据库用户名和密码: String use = ”root; String pass = ”860409”; /设置您的数据库名 String dbName = lib_system; public java.sql.Connection getConn() try Class.forName（”org.gjt。mm.mysql。Driver）。newInstance（）； String url =”jdbc：mysql:/+dbip+”：3306/”+dbName+？user=”+use+”password=”+pass+”useUnicode=true&characterEncoding=GBK” ； conn= DriverManager。getConnection（url)； catch(Exception e） e。printStackTrace()； return this。conn ; /在Mysql建立lib_system数据库，之后将与数据操作相关数据与该数据库相连；2， 记录登陆信息及信息处理:当用户点击“登陆”按钮之后，数据将提交到登陆数据处理。jsp页面。 取得帐号密码这两个从页面传入的值，然后跟数据库当中管理员表中的账号和密码比较.如果正确的话，在JSP的SESSION中存入一个标记属性，表示当前已经有管理员登陆了。处理完毕后，跳转到管理页面，如果失败，则提示登陆失败，并重新进入到登陆页面。具体的逻辑如下：String username=ParamUtil。getString(request，”admin_ID)；/取得用户名String password=ParamUtil。getString(request,”admin_password”）；/取得密码String erroMsg=”;/错误码if（username！=nullpassword!=null）trySkinUtil.login（request,response,admin_ID，admin_password）;/在JSP的session中存如一个标记属性，表示当前已经有管理员登陆了Session.setAttribute(“admin_ID”,admin_ID)；response.sendRedirect(login_process。jsp);catch（UserNotFoundException e）erroMsg=错误的用户名和密码”；response.sendRedirect(login_process。jsp?”+response。encodeURL(erroMsg）)；elseout。println（”请填写好你的个人信息!”)；%3.1.5 存储分配管理员表：(admin）序号字段名类型长度精度小数位数默认值允许空主键说明1（admin_ID）管理员IDInt102（admin_password)管理员密码Char153(admin_quanxian）权限Nvarchar153.2 02管理模块具体格式见下表功能编号02功能名称管理模块内容功能流程图所属业务图书馆管理所属项目图书馆管理系统编写人陈新光完成时间2007-1126页码第8页3.2.1 功能流程图功能流程图如下所示：需要说明的问题：在选择相应的业务时，需要在当前的页面显示；并且在管理页面内，默认显示图书查询页面。3.2.2 功能描述（1） 功能类型：其他（2） 功能概述：总体归纳图书馆管理功能（3） 前提业务：登陆模块（01）（4） 后续业务：021，022，023，024，03（5） 功能约束:权限约束（6） 约束描述:（7） 操作权限：图书馆管理人员3.2.3 界面设计（1） 基本信息处理动作说明如下：动作编号动作名称动作描述A01入库管理点击按钮 将页面转至入库管理.jsp页面A02学生借书点击按钮 将页面转至学生借书.jsp页面A03学生还书点击按钮 将页面转至学生还书.jsp页面A04图书注销点击按钮 将页面转至图书注销。jsp页面A05图书查询点击按钮 将页面转至图书查询.jsp页面（2） 数据要求功能类型：其他3.3 031图书信息查询模块具体格式如下：功能编号031功能名称图书信息查询模块内容功能流程图所属业务图书馆管理所属项目图书馆管理系统编写人陈新光完成时间20071126页码第10页3.3.1 功能流程图功能流程图如下图：需要说明的问题：录入项检测使用javascript来实现(各项非空)；操作权限：面向所有用户3.3.2 功能描述（1） 功能类型：查询数据（2） 功能概述:显示查询结果（3） 前提业务：无（4） 后继业务：（5） 功能约束：没有约束；（6） 约束描述：（7） 操作权限：面向所有用户3.3.3 界面设计（1） 基础信息处理下表是动作说明：动作编号动作名称动作描述A01确定点击按钮 提交数据到图书查询数据处理.jsp页面A02学生信息查询点击按钮 将页面转至学生信息查询。jsp页面（2） 数据要求（1） 功能类型：数据查询（2） 数据描述：页面显示字段见下表：字段名称长度录入方式是否非空项数据检验默认显示请选择查询类型20下拉列表YN请输入查询内容200文本框YN（3） 图书信息查询的输出项书名图书类型作者译者ISBN出版社价格书架名称现存量简介书名图书类型3.3.4 模块内部逻辑1， Search.jsp用于显示界面的内容，给用户显示一个查询接口2， Lib_query.jsp用来调度所有的页面，它根据传入的参数来决定包含哪一个jsp页面来显示内容；在lib_query.jsp页面中，它根据传入的参数来决定包含哪一个jsp页面来显示内容；则可以通过/，利用jsp：include标签来被动态加载发送到相应页面；3， chuli。jsp 用来处理数据查询和显示查询到的结果列表。在这个页面中，数据要求是以列表的形式显示到输出页面。由于查询到的结果可能过多,所以采用分页形式显示；对于分页功能的内部逻辑： 4， View。jsp用来显示查询到的图书的各项属性.3.3.5 存储分配图书目录文件(Book)：序号字段名类型长度精度小数位数默认值允许空主键说明1(BookID)图书编号Int101自动编号2(TXM）条形码nvarchar203(Title)书名nvarchar2004（TSLX）图书类型Nvarchar505（Author）作者Nvarchar206（Translator）译者Nvarchar207（ISBN)ISBNNvarchar208(CBS)出版社Nvarchar3010(SJMC)书架名称Nvarchar2011（XCL）现存量Smallint212（KCZL)库存总量Smallint213（RKSJ）入库时间Datatime14（CZY)操作员Nvarchar1015（JJ)简介Nvarchar20016(JCCS)借出次数Smallint217（SFzhuxiao)是否注销Nvarchar218（BookZT）图书状态nvarchar50借书文件表（JSWJB）：序号字段名类型长度精度小数位数默认值允许空主键外键说明1(JYID）借阅编号Int101自动编号2(BookID）图书编号Int103(StuID)学生编号Int104(JYSJ)借阅时间Datatime85(DQSJ)到期时间Datatime86(XJCS)续借次数Smallint27（CZY)操作员Nvarchar108（ZT)状态navarchar503.4 032学生信息查询模块具体格式如下：功能编号032功能名称学生信息查询模块内容功能流程图所属业务图书馆管理所属项目图书馆管理系统编写人陈新光完成时间200711-26页码第12页3.4.1 功能流程图功能流程图如下图：需要说明的问题：录入项检测使用javascript来实现(各项非空)；操作权限：面向所有用户3.4.2 功能描述（8） 功能类型:查询数据（9） 功能概述：显示查询结果（10） 前提业务:无（11） 后继业务：（12） 功能约束:没有约束；（13） 约束描述:（14） 操作权限：面向所有用户3.4.3 界面设计（4） 基础信息处理下表是动作说明：动作编号动作名称动作描述A01确定点击按钮 提交数据到图书查询数据处理。jsp页面A02图书信息查询点击按钮 将页面转至图书信息查询。jsp页面（5） 数据要求（3） 功能类型：数据查询（4） 数据描述:页面显示字段见下表:字段名称长度录入方式是否非空项数据检验默认显示请输入学号10文本框YN（6） 学生信息查询的输出项学生学号姓名性别生日证件号码联系电话登记日期有效期至已借书数3.4.4 模块内部逻辑5， Search.jsp用于显示界面的内容，给用户显示一个查询接口6， Index.jsp用来调度所有的页面，它根据传入的参数来决定包含哪一个jsp页面来显示内容；在index.jsp页面中,它根据传入的参数来决定包含哪一个jsp页面来显示内容；则可以通过jsp：include page=”%If（intdeli！=1）ifSuccess=false；If(!ifSuccess）%scriptalert（“借阅失败！)；/scriptelse%alert(“借阅成功！”);/script%执行的过程如下：首先要验证学生信息是否存在和学生的欠款是否超额,也就是说学生是否可以借书，图书是否在馆等，在 确定合法之后调用bb.addBorrow(hash)来完成借阅流程。流程其实就是对几个表进行增改的操作。关于addBorrow(hash）的算法：public int addBorrow(Hashtable hash)System。out.println（”批量处理新增借阅。”）；String sql=”；int intID = makeID(JYWJB，”JYID”,”,”，true)；String strID=String.valueOf（intID);String strZJH = ds.toString（(String)hash.get（ZJH”)）；/证件号String strTXM = ds.toString（String)hash.get(TXM”）);/条形码String strJYSJ = ds。toString(String)hash。get(JYSJ)）；/借阅时间String strXSID = ”;/学生IDString strBOOKID = ”;/图书IDString strDQSJ = ”；/到期时间String strXJCS = ;/续借次数/根据学生证件号取的学生ID/根据学生ID取得规则ID，然后取得可以借阅天数，sql=”select Student.RuleID,Student.XSID，Rule。KJYSJ ” + from Studengt,RULE +” where Student.ZJH=+strZJH+ and Student。RuleID=Rule。RuleID ;Hashtable hashReId=(Hashtable）searchOneData（sql）;strXSID=ds.toString(（String)hashReId.get(XSID)；String strKJYSJ=ds。toString(String)hashReId.get(”KJYSJ”)）；/根据条形码取得图书ID sql=”select BOOKID from Book where TXM=”+strTXM+”;Hashtable hashBKID=(Hashtable）searchOneData(sql);strBOOKID = ds。toString(String)hashBKID.get（BOOKID”);/新增操作createStatement（）；clearBatch(）；sql= insert into JSWJB（JYID，XSID,BOOKID,JYSJ,DQSJ,ZT，XJCS） +” values（+strID+”，+strXSID+,+strBOOKID+”,+strJYSJ+”，to_char（(to_date（”+strJYSJ+,yyyy-MM-dd）+strKJYSJ+），yyyyMMdd)+”，”+strZero+,+strZero+”）;addBatch（sql);sql=”update Book set ZT=借出 where BOOKID=+strBOOKID；addBatch（sql）;sql=”update Student set YJSS=YJSS+1 where XSID=+strXSID;addBatch（sql);int result=executeBatch(）;closeStm();return result；而对于取消按钮事件,由于要实现取消借阅，所以需要调用delBorrow(String id)来取消借阅操作；算法如下：public int delBorrow(String id)System。out。println（”批量处理取消借阅。.。）；String sql=”；sql=”select BOOKID from JSWJB where JYID=+id；H