软件系统详细设计说明书

xxxxx系统

具体设计阐明书文献状态：[√]初稿[]正式公布[]正在修改文献标记：现在版本：1.0作者：完毕日期：版本历史版本/状态作者参加者起止日期备注1.0开始编写修改记录日期修订版本修改章节修改描述作者

目录TOC\o"1-4"\h\z\u1 引言 51.1 编写目的 51.2 背景 51.3 参考资料 51.4 术语定义及阐明 52 设计概述 52.1 任务和目的 52.1.1 需求概述 52.1.2 运行环境概述 52.1.3 条件与限制 62.1.4 具体设计办法和工具 63 系统具体需求分析 63.1 具体需求分析 63.2 具体系统运行环境及限制条件分析接口需求分析 64 总体方案确认 64.1 系统总体构造确认 64.2 系统具体界面划分 74.2.1 应用系统与支撑系统的具体界面划分 74.2.2 系统内部具体界面划分 75 系统具体设计 75.1 系统程序代码架构设计 75.1.1 UI(UserInterface)顾客界面表达层 75.1.2 BLL(BusinessLogicLayer)业务逻辑层 85.1.3 DAL(DataAccessLayer)数据访问层 85.1.4 Common类库 85.1.5 EntityClass实体类 85.2 系统构造设计及子系统划分 85.3 系统功效模块具体设计 95.3.1 XX子系统 9.1 XX模块 9列表和分页 9创立XX 9.2 XX模块 9XX列表 9XX修改 95.3.2 XX子系统 95.3.6.1 顾客管理模块 95.3.6.2 角色管理模块 145.3.6.3 系统设立模块 145.3.6.4 系统登录注销模块 145.4 系统界面具体设计 145.4.1 外部界面设计 145.4.2 内部界面设计 145.4.3 顾客界面设计 146 数据库系统设计 146.1 设计规定 146.2 信息模型设计 146.3 数据库设计 146.3.1 设计根据 146.3.2 数据库种类及特点 156.3.3 数据库逻辑构造 156.3.4 物理构造设计 156.3.5 数据库安全 156.3.6 数据字典 157 信息编码设计 157.1 代码构造设计 157.2 代码编制 15引言编写目的阐明编写具体设计方案的重要目的。阐明书编制的目的是阐明一种软件系统各个层次中的每个程序（每个模块或子程序）和数据库系统的设计考虑，为程序员编码提供根据。如果一种软件系统比较简朴，层次极少，本文献能够不单独编写，和概要设计阐明书中不重复部分合并编写。方案重点是模块的执行流程和数据库系统具体设计的描述。背景应包含下列几个方面的内容：A.待开发软件系统名称；B.该系统基本概念，如该系统的类型、附属地位等；C.开发项目组名称。参考资料列出具体设计报告引用的文献或资料，资料的作者、标题、出版单位和出版日期等信息，必要时阐明如何得到这些资料。术语定义及阐明列出本文档中用到的可能会引发混淆的专门术语、定义和缩写词的原文。设计概述任务和目的阐明具体设计的任务及具体设计所要达成的目的。需求概述对所开发软件的概要描述,涉及重要的业务需求、输入、输出、重要功效、性能等，特别需要描述系统性能需求。运行环境概述对本系统所依赖于运行的硬件，涉及操作系统、数据库系统、中间件、接口软件、可能的性能监控与分析等软件环境的描述，及配备规定。条件与限制具体描述系统所受的内部和外部条件的约束和限制阐明。涉及业务和技术方面的条件与限制以及进度、管理等方面的限制。具体设计办法和工具简要阐明具体设计所采用的办法和使用的工具。如HIPO图办法、IDEF（I2DEF）办法、E－R图，数据流程图、业务流程图、选用的CASE工具等，尽量采用原则规范和辅助工具。系统具体需求分析重要对系统级的需求进行分析。首先应对需求分析提出的公司需求进一步确认，并对由于状况变化而带来的需求变化进行较为具体的分析。具体需求分析涉及：具体功效需求分析具体性能需求分析具体资源需求分析具体系统运行环境及限制条件分析具体系统运行环境及限制条件分析接口需求分析涉及：系统接口需求分析现有硬、软件资源接口需求分析引进硬、软件资源接口需求分析总体方案确认着重解决系统总体构造确认及界面划分问题。系统总体构造确认对系统构成、逻辑构造及层次进行确认，对应用系统、支撑系统及各自实现的功效进行确认，细化集成设计及系统工作流程，特别要注意因软件的引进造成的系统本身构造和公司其它系统的构造变化。涉及：系统构成、逻辑构造及层次确认应用系统构造确认支撑系统构造确认系统集成确认系统工作流程确认系统具体界面划分应用系统与支撑系统的具体界面划分应用系统与支撑系统之间的界面涉及系统主服务器与其它服务器的服务范畴及访问方式，网络及数据库对应用系统的支撑方式，全局数据的管理与存取方式等。系统内部具体界面划分系统各功效之间的界面涉及覆盖范畴，模块间功效调用涉及到的系统模块及办法，全局数据格式，系统性能规定等。系统具体设计系统程序代码架构设计系统采用三层架构模型，将应用系统划分为顾客界面表达层、业务逻辑层、数据访问层，以及EntityClass实体类、Common类库构成，各层的关系以下图所示：UI(UserInterface)顾客界面表达层负责与顾客进行交互，显示、接受数据，与此同时，做某些简朴逻辑解决，如：输入数据有效性判断、显示多个异常、解决Dataset统计集数据。它只与BLL(BusinessLogicLayer)业务逻辑层、EntityClass实体类两个项目发生关联，可能与Common类库发生关联。BLL(BusinessLogicLayer)业务逻辑层是整个系统的核心，它承当了全部的逻辑判断，实现了程序的功效，它是灵活的。BLL层既是调用者，又是被调用者，因此，要适宜的进行设计达成解耦的效果。BLL层只关联DAL层和实体类，可能关联Common类库。即使BLL层被U层调用，但是BLL层无需关心UI层的状况。数据库中每个表都对应一种BLL类，为了达成解耦效果，BLL类不能直接调用其它表的DAL类，能够BLL类之间互相调用。DAL(DataAccessLayer)数据访问层提供数据访问的接口，没有任何逻辑。在接口中对数据库操作语句进行组合装配。DAL层普通关联Common类库中的最底层，最基础的数据库类（例如：链接数据库），必须关联EntityClass实体类项目。DAL层只是数据库的管理者，但不是访问者，不直接与数据库发生关联。数据库中每个表都对应一种DAL层的接口(访问控制)类。Common类库用于寄存公用的类。最惯用的就是数据库访问类，例如：链接字符串，数据库引擎类。它直接与数据库进行机械式的交换，无任何逻辑。EntityClass实体类相称于加强的数据构造，实现了对数据的封装。数据库中每个表都对应一种实体类，表的字段就是实体类的属性，类型一一对应。UI、BLL、DAL这三层的交互重要就是通过实体类作为参数，并Return回信息。系统构造设计及子系统划分根据业务和功效，将系统的逻辑构造划分为XX子系统、XX子系等6个子系统，以下图所示：XXXXXXXXXXXXXXXX系统XX管理子系统XX管理子系统XX子系统XX子系统XX子系统XX子系统各个子系统按照功效角度分解，划分出若干不同的功效模块，以下面各图所示：系统功效模块具体设计按构造化设计办法，在系统功效逐级分解的基础上，对系统各功效模块或子系统进行设计。此为具体设计的重要部分之一。用层次图描述系统的总体构造、功效分解及各个模块之间的互相调用关系和信息交互，用IPO图或其它办法描述各模块完毕的功效。以上建议采用HIPO图进行功效分解与模块描述，更高的规定建议采用IDEF0办法进行功效模型设计。具体设计应用系统的各个构成模块完毕的功效及其互相之间的关系，用IPO或构造图描述各模块的构成构造、算法、模块间的接口关系，以及需求、功效和模块三者之间的交叉参考关系。每个模块的描述阐明可参考下列格式：模块编号：模块名称：输入：解决：算法描述：输出：其中解决和算法描述部分重要采用伪码或具体的程序语言完毕。对具体设计更高的规定建议用IDEF0图进行各功效模块的设计。如果对软件需进行二次开发（涉及功效扩展、功效改造、顾客界面改造等），则对应的设计工作应当设立子课题完毕。注意：算法描述重要是阐明BLL层的代码逻辑，UI层只做简朴的输入验证和界面显示功效。XX子系统XX模块列表和分页创立XXXX模块XX列表XX修改XX子系统顾客管理模块模块描述：管理系统顾客，涉及添加顾客并赋予角色、修改顾客资料和角色、删除顾客。重要功效：添加顾客、修改顾客、删除顾客、列表和分页。列表和分页流程图省略输入项分页索引 页面传参数 页面加载时为1输出项列表具体统计；现在页码；分页总数；统计总数。算法描述系统管理顾客数据量不大，并且该功效使用频率不高，能够不用优化分页，直接获取顾客表全部统计，建议UI层使用gridview控件，调用ExamSys.BLL.System_admin_infoGetAllList()绑定控件，运用gridview自带分页功效，显示分页按钮、现在页、分页总数、统计总数、添加顾客流程图输入顾客输入顾客资料选择角色加密密码填写合规顾客信息保存至表System_admin_info验证必填项验证顾客名与否存在与否成功分拆角色ID字符串循环字符串数组信息保存至表Dict_admin_vs_roles返回成功信息是否是返回失败信息否是否操作统计日志输入项顾客ID string 必填姓名 string 必填顾客密码 string 必填确认密码 string 必填联系电话 stringE-mail string状态 char顾客角色ID string 输出项成功，UI提示添加顾客完毕；失败，UI提示具体信息。算法描述前端js判断必填项的输入和二次密码与否相似，角色能够不选；BLL须验证必填项，顾客名是唯一的不能重复；加密密码使用MD5.Encrypt(stringString,stringKey)，Key="XXXXXXXX"；顾客信息保存至表System_admin_info，ExamSys.DAL.System_admin_infoAdd(ExamSys.Model.System_admin_infomodel)；分拆角色ID字符串并循环字符串数组，信息保存至表Dict_admin_vs_roles，ExamSys.BLL.Dict_admin_vs_rolesAdd(ExamSys.Model.Dict_admin_vs_rolesmodel)。修改顾客流程图输入顾客输入顾客资料选择角色填写合规顾客信息保存至表System_admin_info验证必填项加密密码与否成功分拆角色ID字符串循环字符串数组信息保存至表Dict_admin_vs_roles返回成功信息是是返回失败信息否否根据顾客ID删除表Dict_admin_vs_roles统计与否成功是否操作统计日志输入项顾客ID string 页面传参数姓名 string 必填顾客密码 string 必填确认密码 string 必填联系电话 stringE-mail string状态 char顾客角色ID string 输出项成功，UI提示修改顾客完毕；失败，UI提示具体信息。算法描述前端js判断必填项的输入和二次密码与否相似，角色能够不选；加密密码使用Chukeh.Security.MD5.Encrypt(stringString,stringKey)，Key="LinLiYan"；根据顾客ID删除表Dict_admin_vs_roles的统计ExamSys.BLL.Dict_admin_vs_rolesDeleteByAdminID(stringadmin_id)；分拆角色ID字符串并循环字符串数组，信息保存至该表ExamSys.BLL.Dict_admin_vs_rolesAdd(ExamSys.Model.Dict_admin_vs_rolesmodel)。删除顾客流程图列表中列表中点击删除按钮与否成功返回成功信息是返回失败信息否根据顾客ID删除表Dict_admin_vs_roles统计与否成功是否根据顾客ID删除表System_admin_info统计操作统计日志输入项顾客ID string 页面传参数输出项成功，UI提示删除顾客完毕，刷新列表；失败，UI提示具体信息。算法描述根据顾客ID删除表System_admin_info的统计ExamSys.DAL.System_admin_infoDelete(stringadmin_id)；根据顾客ID删除表Dict_admin_vs_roles的统计ExamSys.BLL.Dict_admin_vs_rolesDeleteByAdminID(stringadmin_id)。角色管理模块系统设立模块系统登录注销模块系统界面具体设计系统界面阐明应用系统软件的多个接口。整个系统的其它接口（如系统硬件接口、通讯接口等）在对应的部分阐明。外部界面设计根据系统界面划分进行系统外部界面设计，对系统的全部外部接口（涉及功效和数据接口）进行设计。内部界面设计设计系统内部各功效模块间的调用关系和数据接口。顾客界面设计规定人机界面的内容、界面风格、调用方式等，涉及所谓的表单设计、报表设计和顾客需要的打印输出等设计。此部分内容可能比较多。数据库