[例子]详细设计说明书剖析.doc

详细设计说明书1引言1. 1编写目的根据需求规格说明书、概要设计说明书，在仔细考虑讨论之后，我们对图书管理系统软件的功能划分、数据结构、软件总体结构的实现有了进一步的想法。我们将这些想法记录下来，作为详细设计说明书，为进一步设计软件、编写代码打下基础。1.2背景随着社会信息量的与日俱增，作为信息存储的主要媒体之一图书，数量、规模比以往任何时候都大的多，不论个人还是图书管理部门都需要使用方便而有效的方式来管理自己的书籍。在计算机日益普及的今天，对个人而言若采用一套行之有效的图书管理系统来管理自己的书籍，会方便许多。对图书管理部门而言，以前单一的手工检索已不能满足人们的要求，为了便于图书资料的管理需要有效的图书管理软件。本图书管理系统软件是一套功能比较完善的数据管理软件，具有数据操作方便高效迅速等优点。该软件采用功能强大的数据库软件开发工具进行开发，具有很好的可移植性，可在应用范围较广的DOS、WINDOWS系列等操作系统上使用1.3定义 文档中采用的专门术语的定义及缩略词简要如下：LMS：Library Management System，图书管理系统1.4参考资料1费贤举关于图书管理系统的批文 2郑人杰，殷人昆，陶永雷。实用软件工程（第二版）。北京：清华大学出版社，1997。3王立福，麻志毅。软件工程（第二版）。北京：北京大学出版社，2001。4唐学忠，王文。Visual Basic程序设计教程北京：中国电力出版社，2002。2程序系统的结构 系 统 操 作 模 块系统设置图书查询更改口令 系统操作读者库 操作数据统计读者查询 输 入 输 出图书库 操作数据备份数据恢复3程序（标识符）设计说明3.1主模块初始化图书查询模块还书模块借书模块系统查询模块l 功能建立与数据库连接获取系统设置运行主对话框根据输入调用子模块退出系统时断开与数据库的连接l 输入项目用户鼠标点击输入l 程序逻辑见右图l 存储分配内部数据：数据库连接m_pConnection_ConnectionPtr数据库连接指针m_IsConnectedBOOL数据库连接指示系统设置m_MaxLBNumint可借图书数上限m_MaxLBDayint借书天数上限子对话框m_BookOutDlgCBookOutDlg借书对话框m_BookInDlgCBookInDlg还书对话框m_BookQuiryDlgCBookQuiryDlg图书查询对话框m_SysDlgCSysDlg系统操作对话框l 测试要点数据库连接情况：正常情况，数据库文件缺少，外部系统异常。系统设置获取：正常情况，外部系统异常。对用户输入的响应：合法输入，能够正常调用子模块； 非法输入，系统能否辨别，并作出响应(提出警告)； 子模块的异常状况，系统能否及时做出响应。3.2借书模块l 功能查验输入的读者证号运行借书对话框获取该读者的相关信息查验输入的图书号登记借书l 输入项目读者证号、图书书号(用户输入)l 输出项目读者信息(姓名)；读者已借图书信息(书名、借书日期)；l 程序逻辑对话框初始化操作取消输入不合理点击返回出错输入读者证号查 验借书对话框查验借书登记更新相关信息及显示关闭对话框l 接口调用形式：void CBookDlg:LendBook(const _ConnectionPtr pConnection, const int MaxLBNum)传入参数：pConnection数据库连接指针 MaxLBNum系统参数(可借图书上限)传出参数：无l 存储分配内部数据：数据库m_pConnection_ConnectionPtr数据库连接指针用户界面m_strReaderNameCString读者姓名m_strLBInfCString已借图书信息m_strLBNumCString已借图书数显示m_lBookIDlong欲借图书书号内部参数m_lReaderIDlong当前读者证号m_MaxLBNumint可借图书数上限l 测试要点模块正常运行流程用户输入数据检查(读者证号、图书书号)，包括数据合理性检查，以及合法性检查数据库操作数据库连接异常时的响应情况3.2.1 读者查验模块l 功能查验输入的读者证号是否合法(即是否存在与该读者证号对应的读者记录)l 输入项目读者证号(整型常数)，读者姓名(引用型字符串)l 输出项目查验结果(BOOL值)l 程序逻辑生成数据库查询语句调用数据库查询模块IF返回结果集为空(不存在该读者证号)置读者姓名字符串为空返回”非法读者证号”ELSE置读者姓名字符串返回”合法读者证号”l 接口调用形式：BOOL CheckReader(const long ReaderID,CString &strReaderName)传入参数：ReaderID(常量参数传入)待查验的读者证号 m_pConnection(借书模块内的全局变量)数据库连接指针传出参数：读者证号存在/不存在标志(返回值) strReaderName(传入的引用参数)读者证号对应的读者姓名(读者证号不存在时置为空)l 存储分配局部变量：数据库pReader_RecordsetPtr数据库查询结果集指针 查询参数vtQuiry_variant_t查询命令vNull_variant_t查询连接 类型转换strQuiryCstring查询命令类型转换 vtemp_variant_t查询结果类型转换l 测试要点数据库连接正常时输入合理合法参数输入参数不合理输入参数不合法数据库连接异常；数据库数据异常(读者姓名为空)3.2.2图书查验模块l 功能查验输入的图书书号是否合法l 输入项目图书书号(整型常量)l 输出项目查验结果(BOOL值)l 程序逻辑生成数据库查询语句调用数据库查询模块IF返回结果集为空(不存在该图书书号)返回”非法图书书号”ELSE返回”合法图书书号”l 存储分配局部变量:数据库pBook_RecordsetPtr数据库查询结果集指针查询参量vtQuiry_variant_t查询字符串vNull_variant_t查询连接参量类型转换strQuiryCstring查询命令类型转换l 测试要点数据库连接正常数据库数据正常输入的书号合理合法输入的书号不合理输入的书号不合法数据库数据异常数据库连接异常3.2.3相关信息获取模块l 功能获取合法读者的借书记录l 输入项目合法读者证号(整型常量)；读者已借图书信息(引用型字符串)l 输出项目查询操作结果(BOOL值)l 程序逻辑生成数据库查询语句调用数据库查询模块IF 操作成功WHILE 查询结果集未读至文件尾读取各项值置入读者已借图书信息字符串返回”操作成功”ELSE置空读者已借图书信息字符串返回”操作失败”l 接口调用形式：BOOL GetLBInf(const long ReaderID,CString &strLBInf)传入参量：ReaderID(整型常量)查询参数 strLBInf(引用型字符串)返回用的格式化的查询信息传出参量：查询成功/失败标志(BOOL值)查询操作结果信息l 存储分配局部变量:数据库pRecords_RecordsetPtr数据库查询结果集指针查询参数vtQuiry_variant_t查询命令字符串vNull_variant_t查询连接参量类型转换strQuiryCString 查询命令类型转换l 测试要点数据库连接正常数据库数据正常输入正常(读者证号合法)输入异常(读者证号非法)数据库数据异常数据库连接异常3.2.4借书登记模块l 功能登录借书信息l 输入项目读者证号(整型常量)；图书书号(整型常量)l 输出项目操作结果(BOOL值)l 程序逻辑生成数据库操作命令调用数据库操作模块IF 操作成功返回”操作成功”ELSE返回”操作失败”l 接口调用形式：BOOL WriteBlrecord(const long ReaderID,const long BookID)传入参数：ReaderID(整型常量)操作参数(借阅者读者证号) BookID(整型常量)操作参数(借阅图书书号)传出参数：操作成功/失败标志(返回值)l 存储分配局部变量:操作命令参数vRecsAffected_variant_t操作影响vtCommand_variant_t操作命令类型转换strCommandCString操作命令类型转换strTodayCString借书日期类型转换oleTodayCOleDateTime借书日期l 测试要点数据库连接正常数据库操作正常输入参数合法输入参数非法数据库操作异常数据库连接异常4 还书模块l 功能运行还书对话框查验输入的图书书号对合法输入登录还书信息显示相关信息(本次还书操作信息，尚未归还图书的相关信息，读者信息)l 输入项目图书书号(用户输入)l 输出项目相关信息(本次还书操作信息，尚未归还的图书信息，读者信息)l 程序逻辑点击退出初始对话框出错返回借书记录查验模块登记还书更新还书信息及显示关闭对话框l 接口调用形式：CBookInDlg:ReturnBook(const _ConnectionPtr pConnection,const int MaxLBDay)传入参量：pConnection(数据库连接指针常量)提供数据库连接 MaxLBDay(整型常量)系统参数(借书天数上限)传出参量：无l 存储分配内部变量：数据库m_pConnection_ConnectionPtr数据库连接指针 m_pRecords_RecordsetPtr数据库查询结果集指针 用户界面m_lBookIDlong欲还图书书号m_strLenderIDCString借阅者图书证号显示m_strLenderCString借阅者姓名m_strRBInfCString已还图书信息显示m_strNRBInfCString未还图书信息显示m_strRBNumCString已还图书数显示m_strNRBNumCString未还图书数显示 内部参数m_lCurrIDlong当前还书者读者证号m_intRBNumint已还图书计数m_MaxLBDayint借书天数上限l 测试要点模块正常工作流程对输入的查验，包括输入值的合法性与合理性检验数据库连接异常能否做出适当处理数据库数据异常时能否判断并给予适当处理4.1 借书记录查验模块l 功能查验借书记录是否存在(即是否存在与指定书号相对应的借书记录)l 输入项目图书书号(传入参数)l 输出项目查验结果(返回值)；查询结果集(图书书号、书名、状态、出借日期)l 程序逻辑生成数据库查询语句调用数据库查询模块IF 操作成功IF查询结果集不为空(存在该借书记录)返回”记录存在”ELSE警告”记录不存在”ELSE警告”查询失败”返回”记录不存在”l 接口调用形式：BOOL CheckBlrcord(const long BookID)传入参量：BookID(整型常量)传出参量：书号合法/非法标志(BOOL型)l 存储分配局部变量：查询参数vtQuiry_variant_t查询命令vNull_variant_t查询连接类型转换strQuiryCString查询命令类型转换引用的全局变量：m_pConnection_ConnectionPtr使用m_pRecords_RecordsetPtr写(打开)l 测试要点数据库连接正常数据库数据正常合法的图书书号返回“真”查验结果不合法的图书书号返回“假”查验结果，给出警告提示数据库数据异常返回“假”查验结果，给出数据异常警告数据库连接异常返回“假”查验结果，给出数据库连接异常警告4.2 相关信息获取模块l 功能获取指定读者(读者证号)的借书记录，获取的信息包括所借图书书名，借书日期以及所借图书的总本数。l 输入项目读者证号(传入参数)；相关(借书)信息(公共变量)l 输出项目已借图书数(返回值)l 程序逻辑生成数据库查询命令IF 操作成功初始化(相关信息字符串置为空已借图书计数置为0)WHILE 未读至查询结果集尾置相关信息字符串计数累加返回计数值ELSE置相关信息字符串为”操作异常”返回”失败标志”(-1)l 接口调用形式：int GetLBInf(const long ReaderID)传入参数：ReaderID(整型常量)指定的读者证号传出参数：获取的相关记录数(整型)如发生异常，返回值置为负l 存储分配局部变量：查询参数vtQuiry_variant_t查询命令vNull_variant_t查询连接 类型转换strQuiryCString查询命令类型转换vtemp_variant_t查询结果类型转换oleDateCOleDateTime借书时间类型转换 记录计数countint计算获取的记录数引用的全局变量:m_pConnection_ConnectionPtr使用m_pRecords_RecordsetPtr写(打开、关闭)m_strNRBInfCString写l 测试要点数据库连接正常数据库数据正常可获取的借书记录数为零返回结果为0，引用字符串置空可获取的借书记录数不为零返回记录数，并将相关信息记录在引用字符串中数据库数据异常返回异常指示，给出警告数据库连接异常返回异常指示，给出警告4.4 还书信息记录模块l 功能记录本次还书操作的信息，包括图书书名，超期天数。l 输入项目包含相关信息(书名、借书日期)的查询结果集(公共变量)l 输出项目更新后的格式化还书信息(公共变量)l 程序逻辑WHILE 传入的查询结果集未读至文件尾读取书名,置入还书信息字符串读取借书日期计算超期天数置入还书信息字符串光标移至下一个记录l 接口调用形式：void SaveRBInf(void)传入参数：无传出参数：无l 存储分配局部变量：类型转换vtemp_variant_t查询结果类型转换strExcessCString超期天数类型转换计算变量oleDateCOleDateTime借书日期oleExcessCOleDateTimeSpan超期天数intExcessint超期天数引用的全局变量：m_pRecords_RecordsetPtr读(关闭记录集)m_strRBInfCString更新m_MaxLBDayint读l 测试要点查询结果集正常查询结果集异常4.5 还书登记模块l 功能登记还书(删除借书记录，更新图书状态)l 输入项目图书书号(输入参数)l 输出项目操作成功/失败标志(返回值)l 程序逻辑生成数据库操作命令(更新)IF 操作成功生成数据库操作命令(删除)IF 操作成功返回”操作成功”返回”操作失败”l 接口调用形式：BOOL DelBlrecord(const long BookID)传入参数：BookID(整型常量)返还图书书号传出参数：操作成功/失败标志(BOOL值)l 存储分配局部变量：操作参数vtCommand_variant_t操作命令vRecsAffected_variant_t操作影响参数类型转换strCommandCString操作命令类型转换引用的全局变量：m_pConnection_ConnectionPtr使用l 测试要点数据库连接正常图书书号合法图书书号不合法数据库连接异常5 图书查询模块l 功能根据给定查询条件，查询数据库，获取图书信息l 输入项目查询方式指定以及查询关键字l 输出项目查询结果列表显示初始化对话框l 程序逻辑查询生成查询命令查询数据库显示结果列表退 出l 接口调用形式：CBookQuiryDlg:QuiryBook(const _ConnectionPtr pConnection)传入参数：pConnection(数据库连接指针)传出参数：无l 存储分配内部变量：数据库m_pBooks_RecordsetPtr数据库查询结果集指针 用户界面m_strAuthorCString作者关键字m_bAuthorBOOL作者查询选择状态m_strBookNameCString书名关键字m_bBookNameBOOL书名查询选择状态m_strPublisherCString出版社关键字m_bPublisherBOOL出版社查询选择状态m_intYear1int出版时间关键字m_intYear2int出版时间关键字m_intMonth1int出版时间关键字m_intMonth2int出版时间关键字m_bPubTimeBOOL出版时间查询选择状态m_intTimeTypeint出版时间查询方式选择局部变量：查询参数vtQuiry_variant_t查询命令vNull_variant_t查询连接 类型转换strQuiryCString查询命令类型转换l 测试要点数据库连接正常数据库数据正常获得正确的查询结果并显示数据库数据异常给出警告数据库连接异常给出警告5.1查询命令生成模块l 功能根据用户界面的输入生成查询命令l 输入项目用户界面的输入值(公共变量)l 输出项目查询命令(返回值)l 程序逻辑读取各复选框的值IF 选中 AND 关键字不为空生成查询条件生成数据库查询命令返回生成的查询命令l 接口调用形式：CString GetQuiryString()传入参数：无传出参数：查询命令(CString)l 存储分配局部变量：strQuiryCString查询命令字符串strTempCString临时字符串l 测试要点用户输入合理用户输入不合理(没有指定查询方式，没有输入查询关键字)5.2数据库查询模块l 功能根据输入的查询命令查询数据库l 输入项目查询命令(传入参数)l 输出项目数据库查询结果(返回值)；数据库查询结果集(公共变量)l 程序逻辑查询数据库IF 操作成功返回”操作成功”ELSE返回”操作失败”l 接口调用形式：BOOL DBQuiry(const CString strQuiry)传入参数：strQuiry(字符串型常量)数据库查询命令传出参数：查询操作成功/失败标志(BOOL值)l 存储分配局部变量：查询参数vtQuiry_varaint_t数据库查询命令vRecsAffected_variant_t数据库查询连接引用的全局变量：m_pConnection_ConnectionPtr使用m_pBooks_RecordsetPtr读l 测试要点数据库连接正常输入查询命令合法获取非空查询结果集返回“真”返回值，查询结果保存在查询结果集中获取空查询结果集返回“真”返回值，查询结果集为空输入查询命令不合法返回“假”返回值，查询结果集指针指向空，给出警告数据库连接异常5.3数据显示模块l 功能按一定格式列表显示查询结果，并根据用户要求重排列l 输入项目查询结果集(传入参数)；输出项名称(传入参数)；查询结果表参数，包括行数、列数(传入参数)l 输出项目用户界面显示l 程序逻辑初始化(设置行数、列数、列名称，载入输入的查询结果集内的数据)显示列表WHILE 用户未输入“返回”IF 用户拖动列的标题栏重新设置列的位置排序刷新显示返回l 接口调用形式：CListShowDlg:ShowList(const _RecordsetPtr pRecords,CString *strArray,const int cols,const int rows)传入参数：pRecords(数据库查询结果集指针)需要显示的查询结果 strArray(字符串数组头指针)显示项的名称(列名) cols(整型常量)列表列数 rows(整型常量)列表行数传出参数：无l 存储分配内部数据：数据库m_pRecords_RecordsetPtr数据库查询结果集 内部参数m_strArrayCString20列名存储数组m_intColsint列表列数m_intRowsint列表行数m_cltFGridCMSFlexGrid列表控件m_iMouseColint用户鼠标所在列l 测试要点查询结果正常查询结果集为空显示消息框提示查询结果集不为空正常显示结果列表，并根据用户输入调整输出查询结果异常显示警告6 系统操作模块l 功能验证输入的系统操作员账号以及口令，完成权限管理运行系统操作对话框，根据用户输入调用各子模块，完成：图书库操作(浏览、修改、增加、删除)；读者库操作(浏览、修改、增加、删除)；数据统计；更改口令；系统管理(修改系统设置，浏览、修改、增加、删除系统操作员)；l 输入项目数据库连接(传入参数)l 输出项目无l 程序逻辑初始化要求输入账号口令系统操作权限查验模块初始化系统操作对话框关闭对话框返回操作取消UNTIL 输入”返回”图书操作模块读者操作模块数据统计模块系统设置模块数据备份数据恢复更改口令警告返回账号口令错误?l 接口调用形式：CSysDlg:ManageSys(const _ConnectionPtr pConnection)传入参数：pConnection (数据库连接指针)传出参数：无l 存储分配内部数据：数据库m_pConnection_ConnectionPtr数据库连接指针 子模块m_BookDlgCBookDlg图书库操作子模块m_ReaderDlgCReaderDlg读者库操作子模块m_QuiryDlgCQuiryDlg数据统计子模块m_SysSettingDlgCSysSettingDlg系统设置子模块 内部参数m_strCurrUserCString当前操作者账号m_RightLevelint操作权限局部变量：输入pwdDlgCPasswordDlg账号口令输入对话框l 测试要点数据库连接正常正常执行过程输入的账号口令合法根据权限进行显示控制，正常调用各子模块输入的账号口令不合法警告数据库连接异常6.1系统操作权限查验模块l 功能查验输入的系统操作员账号以及口令是否合法，并返回合法操作员的权限级别l 输入项目系统操作员口令(传入参数)l 输出项目操作员权限级别(返回值)l 程序逻辑生成数据库查询命令查询数据库IF 操作成功IF 查询结果集非空返回权限级别ELSE显示警告”非法的账号或口令”返回 -1ELSE显示警告”不能查询数据库”返回 -1l 接口调用形式：CheckRight(const CString oldPwd)传入参数：oldPwd(字符串常量)待查验的系统操作员口令传出参数：系统操作权限(整型,0-7)如口令非法，置为-1l 存储分配局部变量：数据库pTemp_RecordsetPtr数据库查询结果集指针 查询参数vNull_variant_t数据库查询连接vtQuiry_variant_t数据库查询命令 类型转换strQuiryCString查询命令类型转换 内部参数resultint权限级别引用的全局变量：m_pConnection_ConnectionPtr数据库连接指针m_strCurrUserCString当前操作员账号l 测试要点数据库连接正常数据库数据正常合法的账号口令获取相应的权限级别非法的账号口令返回错误指示，给出警告数据库数据异常数据库连接异常6.2图书库操作模块l 功能根据输入提供对图书库的浏览、数据修改、增加、删除记录等操作增加记录时，提供对生成的图书书号的唯一性验证删除记录时，提供对所删除记录的相关性检验l 输入项目数据库连接(传入参数)l 输出项目无l 程序逻辑初始化(获取数据库连接,显示对话框)WHILE 用户未输入退出IF 用户输入”下一个”更新当前记录移动至下一个记录刷新显示IF 用户输入”上一个”更新当前记录移动至上一个记录刷新显示IF 用户输入”移动到”更新当前记录要求输入图书书号IF 该书号存在移动到指定的记录刷新显示ELSE显示警告”该图书书号不存在”IF 用户输入”加入”更新当前记录要求输入图书书号IF 该书号已存在显示警告”该书号已存在”ELSE插入指定图书书号的新记录记录总数加一光标移动至新记录处IF 用户输入”删除”更新当前记录给出警告”确定继续”IF 用户确认继续IF 该图书借出给出警告”删除相关借书记录”IF 用户确认删除相关借书记录ELSE中止操作删除该图书记录记录总数减一IF 最后一条记录被删除移动至前一条记录ELSE移动至下一条记录显示刷新更新记录l 接口调用形式：CBookDlg:ManageBooks(const _ConnectionPtr pConnection)传入参数：pConnection(数据库连接指针)传出参数：无l 存储分配内部数据：数据库m_pConnection_ConnectionPtr数据库连接指针m_pRs_RecordsetPtr数据库查询结果集指针 用户界面m_lBookIDlong当前记录中书号项m_strAuthorCString当前记录中作者项m_strBookNameCString当前记录中书名项m_strPublisherCString当前记录中出版社项m_uPublishYearUINT当前记录中出版年项m_uPublishMonthUINT当前记录中出版月项m_intStatusint 当前记录中状态项m_fBookPricefloat当前记录中单价项m_strCurrentBookCString当前记录位置显示m_strTotalBookCString记录总数显示 内部参数m_intPositionint当前记录位置计数m_lRecordCountlong记录总数计数l 测试要点数据库连接正常记录集为空是否工作状态正常记录集非空对各种用户输入的响应数据库连接异常6.2.1获取图书记录集模块l 功能获取所有图书记录，置记录总数以及当前位置的初始值l 输入项目操作成功/失败标志(返回值)l 输出项目图书记录集(公共变量)；记录总数(公共变量)；当前位置(公共变量)l 程序逻辑生成数据库查询命令查询数据库IF 操作成功返回”成功”ELSE返回”失败”l 接口调用形式：BOOL OpenRecords()传入参数：无传出参数：操作成功/失败标志(BOOL值)引用的全局变量：m_pRs_RecordsetPtr写(打开)m_intPositionint写m_lRecordCountlong写l 存储分配局部变量：查询参数vNull_variant_t查询连接vtQuiry_variant_t查询命令 类型转换strQuiryCString查询命令类型转换l 测试要点数据库连接正常图书记录集为空图书记录集非空数据库连接异常6.2.2更新显示模块l 功能更显当前显示l 输入项目图书记录集(公共变量)；用户界面显示字符串(公共变量)l 输出项目更新后的用户界面显示字符串(公共变量)l 程序逻辑逐项读取记录中的数据域置入显示字符串中IF 当前记录为第一条禁止”前一个”按钮IF 当前记录为最后一条禁止”后一个”按钮IF 记录总数为0禁止”加入”以外的所有按钮刷新显示界面l 接口调用形式：void RefreshDataView()传入参数：无传出参数：无引用的全局变量：m_pRs_RecordsetPtr读m_lBookIDlong写m_strAuthorCString写m_strBookNameCString写m_strPublisherCString写m_uPublishYear UINT写m_uPublishMonth UINT写m_intStatus int写m_fBookPricefloat写m_strCurrentBookCString写m_strTotalBook CString写l 存储分配局部变量：类型转换vtemp_variant_t记录集数据域类型转换l 测试要点记录集正常记录集为空记录集非空记录集异常6.2.3更新当前记录模块l 功能根据用户界面的输入更新当前记录l 输入项目用户界面的输入，即用户界面各显示变量的值(公共变量)l 输出项目数据库中更新后的图书记录(存储文件)；操作成功/失败标志(返回值)l 程序逻辑保存当前图书书号