XX系统详细设计说明书V.docVIP

XX系统 详细设计说明书 (版本号 V1.0) XXX XXXX年XX月XX日  文档信息 文档名称 XX系统详细设计说明书 作者 XXX 说明 本文档是关于XX系统的详细设计说明文档 文件名称 XX系统详细设计说明书 V1.0.docx 修订历史 (REVISION HISTORY) Rev Section Type Date Author Remarks Draft 全部 建立文档 XXXX-XX-XX XXX 创建系统详细设计草稿。  目录 1 引言 5 1.1目的 5 1.2背景 5 1.3术语 5 1.4参考资料 6 2 总体设计 7 2.1运行环境 7 2.2设计思想 7 2.2.1系统能力要求 7 2.2.2满足系统能力要求的一般性策略 8 2.3系统结构 8 2.3.1系统的参与角色 8 2.3.2系统模块划分 8 2.4功能需求与程序的关系 11 3 接口设计 13 3.1用户接口 13 3.2外部接口 13 3.3内部接口 14 3.3.1业务处理引擎与接口模块关系 14 3.3.2内部其它接口 15 4 运行设计 16 4.1系统初始化 16 4.2运行结束 16 5 数据库设计 17 5.1数据库规划 17 5.2数据库设计 17 5.3安全保密设计 23 6 系统出错处理设计 25 6.1错误一览表 25 6.2异常一览表 25 引言 1.1目的 通过对《XX系统需求规格说明书_V0.1.docx》文档的全面分析，在充分理解系统所要功能及性能的基础之上，完成了详细设计说明书。 本文档充分反映了用户需求，是开发人员实现系统详细设计的纲领性文件，属于考核系统总体质量的重要技术文档。该文档预期读者为客户、软件工程师、测试工程师、用户文档编写者、项目管理人员。 1.2背景 产品名称：XX系统 任务提出者：XXX 开发者：XXX 用户： XX 1.3术语 缩写 解释 中文说明 1.4参考资料 [1] XX系统需求规格说明书_V0.1.docx [2] 总体设计 2.1运行环境 运行硬件环境： 1、应用和数据库分别部署在不同的服务器上； 2、应用服务器为F5管理负载均衡的多台服务器； 3、数据库服务器为负载均衡的多台服务器； 数据库服务器型号： 数量：2台 应用服务器型号： 数量：4台 软件环境： 应用服务器操作系统：RedHat Linux 4 AS 应用服务中间件软件：Apache Tomcat 6 数据库服务器操作系统：RedHat Linux 4 AS 数据库软件：Oracle 10g 系统拓扑图 2.2设计思想 2.2.1系统能力要求 2.2.2满足系统能力要求的一般性策略 影响系统能力的因素有很多，主要包括： 1、 底层平台的性能（硬件、应用服务器等） 2、 软件实现的能力（数据结构设计、算法设计、编程水平） 3、 软件架构 4、后端资源响应时间 2.3系统结构 2.3.1系统的参与角色 2.3.2系统模块划分 2.4功能需求与程序的关系 接口设计 3.1用户接口 3.2外部接口 3.3内部接口 3.3.1业务处理引擎与接口模块关系 3.3.2内部其它接口 运行设计 4.1系统初始化 4.2运行结束 数据库设计 5.1数据库规划 对于表驱动的信息管理系统，基本表的设计规范是3NF，即非主键属性只依赖于主键属性。3NF可以消除冗余数据，节约空间。但数据的冗余可以提高查询速度。 数据库应当按两种类别组织：频繁访问的数据和频繁修改的数据。对于频繁访问但是不频繁修改的数据，内部设计应当物理不规范化；频繁修改但不频繁访问的数据，内部设计应当物理规范化。规范与反规范都是建立在实际的操作基础上的约束，只有把两者结合，才能更好的应用。 5.2数据库设计 1、XX表 T_XXX 字段名 字段类型 NOT NULL PK UNIQUE 说明 ID NUMBER NOT YES ID 2、 5.3安全保密设计 系统出错处理设计 6.1错误一览表 错误类型 范围 处理方式 　用户接口错误 不满足输入发生的错误 　系统运行错误 与外部资源交互时发生的错误文件系统数据库等 记录并抛出异常 与客户模块交互时不满足前置条件后置条件发生的错误，如类库被其他程序员调用时参数超出范围等 6.2异常一览表 ErrorCode ErrorDesc Remark 00000 成功 XX系统详细设计说明书 11