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

1、软件详细设计说明书实例软件详细设计说明书实例1.1编写目的 .1.2项目背景 .1.3定义 . 1.4参考资料 .2 总体设计 2.1 需求概述 . 2.2 软件结构 . 3 程序描述 3.101 登陆模块 3.202 管理模块 3.3031 图书信息查询模块3.4032 学生信息查询模块3.5021 入库管理模块 .3.6022 学生借书模块 .3.7023 学生还书模块 .3.8024 图书注销模块 .3.9接口设计 . 3.10测试要点 文档名称：详细设计规格说明书项目名称：图书馆管理系统项目负责人：陈新光编写 TEST 年_月_日校对所有小组成员 _年_月_日审核所有小组成员 _年_月

2、_日批准 XXX 年 _月_日开发单位 组员： TEST1TEST2TEST31 引言1.1编写目的图书管理系统详细设计是设计的第二个阶段，这个阶段的主要任务是在图书管理系统概要设计书基础 上，对概要设计中产生的功能模块进行过程描述，设计功能模块的内部细节，包括算法和详细数据结构， 为编写源代码提供必要的说明。概要设计解决了软件系统总体结构设计的问题，包括整个软件系统的结构、模块划分、模块功能和模 块间的联系等。详细设计则要解决如何实现各个模块的内部功能，即模块设计。具体的说，模块设计就是 要为已经产生的图书管理各子系统设计详细的算法。但这并不等同于系统实现阶段用具体的语言编码，它 只是对实现

3、细节作精确的描述，这样编码阶段就可以将详细设计中对功能实现的描述，直接翻译、转化为 用某种程序设计语言书写的程序。1.2项目背景根据XX学校希望能够充分利用现代科技来提高图书管理的效率， 在原有的办公系统基础上进行扩展,1.3定义Mysql ：数据库管理软件DBMS数据库管理系统Windows2000/2003/XP ：运行环境JSP:软件开发语言Myeclipse ：开发工具1.4参考资料软件工程导论第 5 版张海藩编着清华大学出版社实用软件工程 LeszekA.MaciaszekBrucLeeLiong 着机械工业出版社2 总体设计2.1需求概述按照需求分析文档中的规格要求，使用条形码扫描

4、器进书、借书、还书，使得信息传递准确、流畅同时，系统最大限度地实现易安装，易维护性，易操作性，运行稳定，安全可靠。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功能名称登陆模块内容功能流程图所属业务图书馆管理所属项目图书馆管理系统编写人陈新光完成时间2007-11-26页码第5页3.1.1功能流程图功能流程图如

5、下图所示需要说明的问题:(1)录入项检测使用javascript 实现(各项必须非空)(2) 登陆.jsp页面也包含查询按钮，在此的登陆.jsp提交的数据只是用户名和密码。3.1.2功能描述(1)功能类型：查询数据(2)功能描述：提高系统的安全性(3)前提业务：无(1)基础信息处理动作说明：动作编号动作名称动作描述A01登陆点击登陆按钮提交数据到登陆数据处理.jsp页面A02重至点击退重至按钮将当前信息恢复原先状态A03图书信息查询点击将页面转至到图书信息查询.jsp页面A04学生信息查询点击将页面转至学生信息查询.jsp 页面A05基础信息点击将显示基础信息(2)数据要求(1)功能类型：数据

6、查询(2)数据描述：页面显示录入字段如下:字段名称长度录入方式是否非空项数据检验默认显示管理员ID10文本框YN3.1.4登陆数据处理.jsp的内部逻辑登陆数据处理：关键点两点：1,数据库连接；2,记录登陆信息及信息处理；1,数据库连接：如下：publicclass lib_system_C onn exte nds Objectpublic lib_system_C onn()private Conn ecti on conn =n ull ;private ResultSet rs ;String re =;/设置你的数据库ipStri ng dbip =;/设置你的数据库用户名和密码：S

7、tring use = root ;Stri ng pass =860409;/设置您的数据库名Stri ng dbName =lib_system ;public getC onn()try Class. forName ().newlnstance();Stri ngurl=+ dbip +:3306/ +dbName +user= +use +&password= +pass +&useUni code=true&characterE ncod in g=GBK ;conn =DriverMa nager. getC onn ecti on (url);catch (Excepti on

8、 e)e.pri ntStackTrace();returnthis . conn ;/在Mysql建立lib_system 数据库，之后将与数据操作相关数据与该数据库相连；2，记录登陆信息及信息处理: 当用户点击“登陆”按钮之后，数据将提交到登陆数据处理 .jsp 页面。取 得帐号密码这两个从页面传入的值，然后跟数据库当中管理员表中的账号 和密码比较。如果正确的话，在 JSP的SESSION中存入一个标记属性，表 示当前已经有管理员登陆了。处理完毕后，跳转到管理页面，如果失败， 则提示登陆失败，并重新进入到登陆页面。具体的逻辑如下：3.1.5存储分配管理员表：（adm in）序号字段名类型长

9、度精度小数位数默认值允许空主键说明1(admin_ID)管理员IDInt10V2(admin_password)管理员密码Char153(admin_quanxian)Nvarchar153.202管理模块具体格式见下表功冃匕编号02功能名称管理模块内容功能流程图所属业务图书馆管理所属项目图书馆管理系统编写人陈新光完成时间2007-11-26页码第8页3.2.1功能流程图功能流程图如下所示:需要说明的问题：在选择相应的业务时，需要在当前的页面显示；并且在管理页面内,默认显示图书查询页面。3.2.2功能描述(1)功能类型：其他(2)功能概述：总体归纳图书馆管理功能(3)前提业务：登陆模块(01)

10、(4)后续业务：021, 022，023，024，03(5)功能约束：权限约束(6)约束描述：(7)操作权限：图书馆管理人员323界面设计(1)基本信息处理动作说明如下：动作编号动作名称动作描述A01入库管理点击按钮将页面转至入库管理.jsp页面A02学生借书点击按钮将页面转至学生借书.jsp页面A03学生还书点击按钮将页面转至学生还书.jsp页面A04图书注销点击按钮将页面转至图书注销.jsp页面A05图书查询点击按钮将页面转至图书查询.jsp 页面(2)数据要求功能类型：其他3.3031图书信息查询模块具体格式如下：功冃匕编号031功能名称图书信息查询模块内容 功能流程图所属业务图书馆管理

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

12、录入方式是否非空项数据检验默认显示请选择查询类型20下拉列表YN请输入查询200文本框YN内容（3）图书信息查询的输出项书名 图书类型 作者 译者ISBN 岀版社 价格 书架名称 现存量 简介 书名 图书类型3.3.4模块内部逻辑1， Search.jsp 用于显示界面的内容，给用户显示一个查询接2, Lib_query.jsp 用来调度所有的页面，它根据传入的参数来决定包含哪一个jsp页面来显示内容；在 lib_query.jsp 页面中，它根据传入的参数来决定包含哪一个 jsp页面来显示内容；则可以通过 jsp:includepage二 ” /,禾V 用jsp:i nclude 标签来被动

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

14、r) 译者Nvarchar20V7(ISBN)ISBNNvarchar208(CBS)出版社Nvarchar30V10(SJMC)书架名称Nvarchar20V11(XCL)现存量Smallint2V12(KCZL)库存总量Smallint2V13(RKSJ)入库时间DatatimeV14(CZY)操作员Nvarchar10V15(JJ)简介Nvarchar200V16(JCCS )借出次数Smallint2V17(SFzhuxiao)是否注销Nvarchar2V18(BookZT)图书状态nvarchar50借书文件表(JSWJB):序号字段名类型长度精度小数位数默认值允许空主键外键说明1(

15、JYID)借阅编号Int101V自动编号2(BookID)图书编号Int10V3(StuID)学生编号Int10V4(JYSJ)借阅时间Datatime8V5(DQSJ)到期时间Datatime8V6(XJCS)续借次数Smallint2V7(CZY)操作员Nvarchar10V8(ZT)状态navarchar50V3.4032学生信息查询模块具体格式如下:功冃匕编号032功能名称学生信息查询模块内容功能流程图所属业务图书馆管理所属项目图书馆管理系统编写人陈新光完成时间2007-11-26页码第12页3.4.1功能流程图功能流程图如下图:需要说明的问题:录入项检测使用javascript 来实

16、现(各项非空)；操作权限：面向所有用户3.4.2功能描述(8)功能类型：查询数据(9)功能概述：显示查询结果(10)前提业务：无(11)后继业务：(12) 功能约束：没有约束;（13） 约束描述：（14） 操作权限：面向所有用户3.4.3界面设计（4）基础信息处理下表是动作说明：动作编号动作名称动作描述A01确定点击按钮提交数据到图书查 询数据处理.jsp页面A02图书信息查询点击按钮将页面转至图书信息查询.jsp页面（5）数据要:求（3）功能类型：数据查询（4）数据描述：页面显示字段见下表：字段名称长度录入方式 是否非空项数据检验默认显示请输入学号10文本框 YN（6）学生信息查询的输出项学

17、生学号姓名性别生日证件号码联系电话登记日期有效期至已借书数344模块内部逻辑5, Search.jsp 用于显示界面的内容，给用户显示一个查询接 口6， In dex.jsp用来调度所有的页面，它根据传入的参数来决定包含哪一个jsp页面来显示内容；在index.jsp 页面中，它根据传入的参数来决定包含哪一个 jsp页面来显示内容；则可以通过 jsp:includepage二 ” /,禾V 用jsp:i nclude 标签来被动态加载发送到相应页面；乙List.jsp 用来显示查询到的结果列表。8，View.jsp用来显示查询到的学生的各项属性。注释：学生信息查询模块与图书查询模块属于同一类功

18、能。 实现可以完全类似。3.4.5存储分配学生文件:序号字段字段名类型长度精度小数位数默认值允许空主键说明1XSID学生编号Int101V自动编号2Name姓名nvarchar103Sex性别nvarchar2V4ZJH证件号码nvarchar25V5LXDH联系电话nvarchar40V6DJRQ登记日期datetime8V7YXQZ有效期至datetime88YJSS已借书数smallint2V9RulelD学生规则IDint1010ZT是否挂失nvarchar2V借书文件:序号字段名类型长度精度小数位数默认值允许空主键外键说明1借阅编号Int101V自动编号2图书编号Int10V3学生编

19、号Int10V4借阅时间Datatime8V5至U期时间Datatime8V6续借次数Smallint2V7操作员Nvarchar10V8状态navarchar50V3.5021入库管理具体格式如下:功冃匕编号021功能名称入库管理模块内容 功能流程图所属业务图书馆管理所属项目图书馆管理系统编写人 陈新光 完成时间2007-11-27 页码第16页3.5.1功能流程图（1）执行数据库操作的时候要验证权限（2）录入项检验用javascript来实现（选项非空）3.5.2功能描述(1)功能类型:添加数据(2)功能描述:增加图书目录文件中的图书信息(3)前提业务：管理模块(4)后继业务：无(5)功能

20、约束:权限约束(6)约束描述:无(7)操作权限:图书馆管理人员3.5.3界面设计1,基础信息处理动作说明如下表：动作编号动作名称动作描述A01保存点击按钮提交数据到入库数据处理.jsp页面A02退出点击按钮将当前页面关闭2，数据描述(1)功能类型：数据增加(2)数据描述：页面录入字段见卜表：字段名称长度录入方式是否非空项数据检验默认显示书号30文本框YN条形码20文本框YN书名200文本框YN作者20文本框YN出版社30文本框YN版次50文本框YN图书类别20文本框YN单价8文本框YN录入时间默认系统时年月日只需程序记显示在入库间，格式:录界面录入人默认系统登只需程序记显示在入库陆人员录界面3

21、,入库数据处理内部逻辑：图书入库采用表格进行多行添加：利用javaBean来编写一个BookBean来管理图书。在BookBean类中增加记录的公共接口来实现入库数据的添 加。具体的类设计如下：Public in ti nsert(Hashtablehash)intin tID二makelD(Book,BooklD,true);Vectorvect 二n ewVector();vect.add(Book);vect.add(addVector(BooklD,Stri ng.valueOf(i ntID),NUM);vect.add(addVector(Title,ds.toStri ng(St

22、ri ng)hash .get(TITLE),CHAR);vect.add(addVector(Author,ds.toStri ng(Stri ng)hash.get(AUTHOR),CHAR);vect.add(addVector(ISBN,ds.toStri ng(Stri ng)hash.get(ISBN),CHAR);returni nsertRecord(vect);在insert 方法的最后，调用 ParentBean 中 的 insertRecord 方法，insertRecord 可以根据传入的参数自 动的生成增加记录的 SQL语句并通过JDBC发送到数据库。正对ParentBean类：主要是实现对数据库的各种操作：如与数据库的连接，对数据库的操作3.5.4存储分配图书目录文件：1