软件详细设计说明书实例

1、软件详细设计说明书实例2020年5月目录1引言 .错误 !未定义书签。编写目的 .错误 !未定义书签。项目背景 .错误 !未定义书签。定义 .错误 !未定义书签。参考资料 .错误 !未定义书签。2总体设计.错误 !未定义书签。需求概述 .错误 !未定义书签。软件结构 .错误 !未定义书签。3程序描述.错误 !未定义书签。01 登陆模块 .错误 !未定义书签。02 管理模块 .错误 !未定义书签。031图书信息查询模块 .错误 !未定义书签。032学生信息查询模块 .错误 !未定义书签。021入库管理模块 .错误 !未定义书签。022学生借书模块 .错误 !未定义书签。023学生还书模块 .错误

2、 !未定义书签。024图书注销模块 .错误 !未定义书签。接口设计 .错误 !未定义书签。测试要点 .错误 !未定义书签。文档名称：详细设计规格说明书项目名称：图书馆管理系统项目负责人：陈新光编写校对审核批准TEST所有小组成员所有小组成员XXX_年 _月 _日_年_月_日_年_月_日_年_月 _日开发单位 _组员：TEST1 TEST2TEST31 引言1.1 编写目的图书管理系统详细设计是设计的第二个阶段，这个阶段的主要任务是在图书管理系统概要设计书基础上，对概要设计中产生的功能模块进行过程描述，设计功能模块的内部细节，包括算法和详细数据结构，为编写源代码提供必要的说明。概要设计解决了软件

3、系统总体结构设计的问题，包括整个软件系统的结构、模块划分、模块功能和模块间的联系等。详细设计则要解决如何实现各个模块的内部功能，即模块设计。具体的说，模块设计就是要为已经产生的图书管理各子系统设计详细的算法。但这并不等同于系统实现阶段用具体的语言编码，它只是对实现细节作精确的描述，这样编码阶段就可以将详细设计中对功能实现的描述，直接翻译、转化为用某种程序设计语言书写的程序。1.2 项目背景根据 XX 学校希望能够充分利用现代科技来提高图书管理的效率，在原有的办公系统基础上进行扩展，将一些可以用计算机来管理的都进行计算机化，使得图书馆管理人员工作更加方便，工作效率也更加的高。1.3 定义? My

4、sql ：数据库管理软件? DBMS：数据库管理系统? Windows 2000/ 2003/XP：运行环境? JSP ：软件开发语言? Myeclipse ：开发工具1.4 参考资料软件工程导论第5 版张海藩编著清华大学出版社实用软件工程LeszekBruc Lee Liong 著机械工业出版社2 总体设计2.1 需求概述按照需求分析文档中的规格要求，使用条形码扫描器进书、借书、还书，使得信息传递准确、流畅。同时，系统最大限度地实现易安装，易维护性，易操作性，运行稳定，安全可靠。2.2 软件结构图书馆信息系统参数设置基础信息设置管理员设置书架设置图书词库设置系统登陆新书购入学生借书管理子系统

5、学生还书图书馆管理系统图书注销学生信息查询查询子系统图书信息查询系统由 3 大模块， 6 小模块组成：序号编号名称1，01登陆模块2，02管理模块3，031图书信息查询模块4，032学生信息查询模块5，021入库管理模块6，022学生借书模块7，023学生还书模块8，024图书注销模块9，040基础信息设置3 程序描述3.101 登陆模块具体格式见下表：功能编号01功能名称登陆模块内容功能流程图所属业务图书馆管理所属项目图书馆管理系统编写人陈新光完成时间2007-11-26页码第 5 页3.1.1 功能流程图功能流程图如下图所示。失败登陆 .jsp提交所填内容录入项检验成功登陆数据处理 .js

6、p执行数据库操作是否成功成功管理 .jsp（非空）失败需要说明的问题：（1） 录入项检测使用javascript 实现（各项必须非空）（2） 登陆 .jsp 页面也包含查询按钮，在此的登陆.jsp 提交的数据只是用户名和密码。3.1.2 功能描述（ 1） 功能类型：查询数据（ 2） 功能描述：提高系统的安全性（ 3） 前提业务：无（ 4） 后继业务： 02 （管理模块）（ 5） 功能约束：权限约束（ 6） 约束描述：（ 7） 操作权限：图书馆管理员3.1.3 界面设计（ 1） 基础信息处理动作说明：动作编号动作名称动作描述A01登陆点击登陆按钮提交数据到登陆数据处理 .jsp 页面A02重至点

7、击退重至按钮 将当前信息恢复原先状态A03图书信息查询点击 将页面转至到图书信息查询 .jsp 页面A04学生信息查询点击 将页面转至学生信息查询 .jsp 页面A05基础信息点击 将显示基础信息（2） 数据要求(1) 功能类型：数据查询(2) 数据描述：页面显示录入字段如下：字段名称长度录入方式是否非空项数据检验默认显示管理员 ID10文本框YN管理员密码15passwordYN3.1.4 登陆数据处理 .jsp 的内部逻辑登陆数据处理：关键点两点： 1，数据库连接； 2，记录登陆信息及信息处理；1， 数据库连接：如下：public class lib_system_Conn extends

8、 Objectpublic lib_system_Conn()private Connection conn = null ;private ResultSet rs;String re = "" ;ewInstance();String url="jdbc:" +dbip +":3306/" +dbName +"user=" +use+"&password=" +pass+"&useUnicode=true&characterE ncoding=GBK&quo

9、t; ;conn = (url);catch(Exception e)();return;sp 页面。 取得帐号密码这两个从页面传入的值，然后跟数据库当中管理员表中的账号和密码比较。如果正确的话，在JSP的 SESSION中存入一个标记属性，表示当前已经有管理员登陆了。处理完毕后，跳转到管理页面，如果失败，则提示登陆失败，并重新进入到登陆页面。具体的逻辑如下：<%String username=(request,"admin_ID");2007-11-26管理 .jsp查询 .jsp入库管理 .jsp学生借书 .jsp学生还书 .jsp图书注销 .jspsp 页面A0

10、2学生借书点击按钮将页面转至学生借书 .jsp 页面A03学生还书点击按钮将页面转至学生还书 .jsp 页面A04图书注销点击按钮将页面转至图书注销 .jsp 页面A05图书查询点击按钮将页面转至图书查询 .jsp 页面（ 1） 数据要求功能类型：其他3.2 031 图书信息查询模块具体格式如下：功能编号031功能名称图书信息查内容功能流程图询模块所属业务图书馆管理所属项目图书馆管理系统编写人陈新光完成时间2007-11-26页码第 10页3.2.1 功能流程图功能流程图如下图：失败图书查询 .jsp提交所填内容录入项检验成功图书查询数据处执行数据库操作是否成功成功查询结果 .jsp（非空）理

11、 .jsp失败需要说明的问题：录入项检测使用javascript 来实现（各项非空）；操作权限：面向所有用户3.2.2 功能描述（1） 功能类型：查询数据（2） 功能概述：显示查询结果（3） 前提业务：无（4） 后继业务：（5） 功能约束：没有约束；（6） 约束描述：（7） 操作权限：面向所有用户3.2.3 界面设计（1） 基础信息处理下表是动作说明：动作编号动作名称动作描述A01确定点击按钮提交数据到图书查询数据处理 .jsp 页面A02学生信息查询点击按钮将页面转至学生信息查询 .jsp 页面（2） 数据要求（ 1） 功能类型：数据查询（ 2） 数据描述：页面显示字段见下表：字段名称长度录

12、入方式是否非空项数据检验默认显示请选择查询20下拉列表YN类型请输入查询200文本框YN内容（3） 图书信息查询的输出项书名图书类型作者译者ISBN出版社价格书架名称现存量简介书名图书类型3.2.4 模块内部逻辑Search.jspLib_query.jspChuli.jspView.jsp1， 用于显示界面的内容，给用户显示一个查询接口2， 用来调度所有的页面，它根据传入的参数来决定包含哪一个 jsp 页面来显示内容；在页面中，它根据传入的参数来决定包含哪一个 jsp 页面来显示内容；则可以通过 <jsp:include page=”<%= %>”/>,利用 jsp:

13、include 标签来被动态加载发送到相应页面；3，用来处理数据查询和显示查询到的结果列表。在这个页面中，数据要求是以列表的形式显示到输出页面。由于查询到的结果可能过多，所以采用分页形式显示；对于分页功能的内部逻辑：4， 用来显示查询到的图书的各项属性。3.2.5 存储分配图书目录文件（ Book）：序号字段名类型长度精度小数位数默认值允许空主键说明1(BookID)图书编号Int101自动编号2(TXM)条形码nvarchar203(Title) 书名nvarchar2004(TSLX)图书类型Nvarchar505(Author) 作者Nvarchar206(Translator)译者Nv

14、archar207(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自动借 阅

15、编编号号2(BookID)Int10图 书 编号3(StuID)Int10学 生 编号4(JYSJ)借Datatime8阅时间5(DQSJ)到Datatime8期时间6(XJCS)续Smallint2借次数7(CZY) 操Nvarchar10作员8(ZT)状态navarchar503.3 032 学生信息查询模块具体格式如下：功能编号032功能名称学生信息查内容功能流程图询模块所属业务图书馆管理所属项目图书馆管理系统编写人陈新光完成时间2007-11-26页码第 12页3.3.1 功能流程图功能流程图如下图：失败学生信息查询 .jsp提交所填内容录入项检验成功学生信息查询数据执行数据库操作是否

16、成功成功学生信息查询结（非空）处理 .jsp果 .jsp失败需要说明的问题：录入项检测使用javascript 来实现（各项非空）；操作权限：面向所有用户3.3.2 功能描述（8） 功能类型：查询数据（9） 功能概述：显示查询结果（10） 前提业务：无（11） 后继业务：（12） 功能约束：没有约束；（13） 约束描述：（14） 操作权限：面向所有用户3.3.3 界面设计（4） 基础信息处理动作编号A01A02下表是动作说明：动作名称确定图书信息查询动作描述点击按钮提交数据到图书查询数据处理 .jsp 页面点击按钮将页面转至图书信息查询 .jsp 页面（5） 数据要求（ 3） 功能类型：数据查

17、询（ 4） 数据描述：页面显示字段见下表：字段名称长度录入方式是否非空项请输入学号10文本框Y数据检验 N默认显示（6） 学生信息查询的输出项学生学号姓名性别生日证件号码联系电话登记日期有效期至已借书数3.3.4 模块内部逻辑Search.jspIndex.jspList.jspView.jsp5， 用于显示界面的内容，给用户显示一个查询接口6， 用来调度所有的页面，它根据传入的参数来决定包含哪一个 jsp 页面来显示内容；在页面中，它根据传入的参数来决定包含哪一个 jsp 页面来显示内容；则可以通过 <jsp:include page=”<%= %>”/>,利用 js

18、p:include 标签来被动态加载发送到相应页面；7，用来显示查询到的结果列表。8， 用来显示查询到的学生的各项属性。注释：学生信息查询模块与图书查询模块属于同一类功能。实现可以完全类似。3.3.5 存储分配学生文件：序号字段字段名类型长度精度小数默认允许主键说明位数值空1XSID学生编号Int101自动编号2Name姓名nvarchar103Sex性别nvarchar24ZJH证件号码nvarchar255LXDH联系电话nvarchar406DJRQ登记日期datetime87YXQZ有效期至datetime88YJSS已借书数smallint29RuleID学生规则int10ID10Z

19、T是否挂失nvarchar2借书文件：序号字段名类型长度精度小数位默认值允许空主键外键说明数1借阅编Int101自动号编号2图书编Int10号3学生编Int10号4借阅时Datatime8间5到期时Datatime8间6续借次Smallint2数7操作员Nvarchar108状态navarchar503.4 021 入库管理具体格式如下：功能编号021功能名称入库管理模内容功能流程图块所属业务图书馆管理所属项目图书馆管理系统编写人陈新光完成时间2007-11-27页码第 16页3.4.1 功能流程图失败入库管理 .jsp提交所填内容录入项检验成功入库数据处理 .jsp执行数据库操作是否成功成功

20、显示结果 .jsp（非空）失败（1） 执行数据库操作的时候要验证权限（2） 录入项检验用 javascript 来实现（选项非空）3.4.2 功能描述（1） 功能类型：添加数据（2） 功能描述：增加图书目录文件中的图书信息。（3） 前提业务：管理模块（4） 后继业务：无（5） 功能约束：权限约束（6） 约束描述：无（7） 操作权限：图书馆管理人员3.4.3 界面设计1， 基础信息处理动作说明如下表：动作编号动作名称动作描述A01保存点击按钮提交数据到入库数据处理 .jsp 页面A02退出点击按钮将当前页面关闭2， 数据描述（1） 功能类型：数据增加。（2） 数据描述：页面录入字段见下表：字段名

21、称长度录入方式是否非空项数据检验默认显示书号30文本框YN条形码20文本框YN书名200文本框YN作者20文本框YN出版社30文本框YN版次50文本框YN图书类别20文本框YN单价8文本框YN录入时间默认系统时年月只需程序记显示在入库间，格式：日录界面录入人默认系统登只需程序记显示在入库陆人员录界面3， 入库数据处理内部逻辑：图书入库采用表格进行多行添加：利用 javaBean来编写一个 BookBean来管理图书。在 BookBean类中增加记录的公共接口来实现入库数据的添加。具体的类设计如下：Public int insert (Hashtable hash)int intID = mak

22、eID("Book","BookID","","",true);Vector vect = new Vector();("Book");(addVector("BookID",(intID),"NUM");(addVector("Title",(String)("TITLE"),"CHAR");(addVector("Author",(String)("AUTHOR&

23、quot;),"CHAR");(addVector("ISBN",(String)("ISBN"),"CHAR");。2007-11-27超额借书 .jsp提交所填内容录入项检验成功检查学生欠款信息执行数据库操作欠款是否超额未超额处理借书数据 .jsp（非空）失败失败是否成功显示学生借书信息 .jsp（1）1”2007-11-27失败还书 .jsp提交数据录入项检测成功处理 .jsp执行数据库操作是否 成功成功显示结果（非空）失败（1）sp 中利用 javascript 来实现显示功能！（2） 处理要包含：对图书状

24、态和借书文件表中信息的修改以及学生的欠款金额的计算，并更新Publish 表。3.4.4 功能描述（1） 功能类型：修改数据（2） 功能概述：完成学生的还书业务并计算学生的欠款信息（3） 前提业务：管理模块（4） 后继业务：无（5） 功能约束：权限约束（6） 约束描述：（7） 操作权限：图书馆管理人员3.4.5 界面设计（1） 基础信息处理动作编号动作名称动作描述A01重置点击按钮将文本框内的所有数据清空A02提交点击按钮将数据提交到处理还书信息页面（2） 界面描述：（3） 数据描述字段名称长度书籍条形码10录入方式文本框是否非空项 Y数据检验 N默认显示号对于还书业务的处理， 实质上与借书业

25、务的实现基本上相同， 只是调用了 backBorrow(hash)来实现还书功能；If(“1”)Int intdel=(hash);If(intdel=null)ifSuccess=false;elseFor（int i=0;i<i+）If(intdeli!=1)ifSuccess=false;If(!ifSuccess)%><script>alert(“归还操作失败！ ”);</script><%else%><script>alert(“归还操作成功！ ”);</script><%针对 backBorrow（has

26、h）算法如下：public int backBorrow(String TXM)" 批量处理还书。"); String sql=""String strBOOKID=(String)toName("BOOK","TXM","BOOKID",TXM);String strNow = ();strNow = (0,10);createStatement();clearBatch();sql="update JSWJB set ZT='"+strOne+"'

27、;,DQSJ='"+strNow+"' where BOOKID="+strBOOKID+" and ZT='"+strZero+"'""sql1:"+sql);addBatch(sql);sql="update BOOK set ZT='可借 ' where BOOKID="+strBOOKID;"sql2:"+sql);addBatch(sql);int result=executeBatch();closeStm

28、();return result;3.4.6 存储分配借书文件：序号字段名类型长度精度小数位默认值允许空主键外键说明数1借阅编Int101自动号编号2图书编Int10号3学生编Int10号4借阅时Datatime8间5到期时Datatime8间6续借次Smallint2数7操作员Nvarchar108状态navarchar50学生文件：序号字段字段名类型长度精度小数默认允许主键说明位数值空1XSID学生编号Int101自动编号2Name姓名nvarchar103Sex性别nvarchar24ZJH证件号码nvarchar255LXDH联系电话nvarchar406DJRQ登记日期datetime87YXQZ有效期至datetime88YJSS已借书数smallint29RuleID学生规则int10ID10ZT是否挂失nvarchar2图书目录文件：序号字段名类型长度精度小数位数默认值允许空主键说明1图书编号Int101自动编号2条形码nvarchar203书名nvarchar2004图书类型Nvarchar505作者Nvarchar206译者Nvarchar207ISBNNvarchar208出版社Nvarchar309价格Money810书架名称Nvarchar2011现存量Smallint212库存总量Smallint213入库