项目设计文档

1、 设计说明书设计说明书 编制人：杨文彦 2007年08月08日 审核人：年 月 日 批准人:年 月 日 编 号： 版本号： 1.0 发布日期： 版本修改记录 审 核 人审核意见审核日期 批 准 人批准意见批准日期 备 注 版本修订记录 修 改 人修改内容概要（或原因）修改日期审 核 人 目录 第一章第一章 引言引言.4 1.1 定义.4 1.2 参考资料.5 第二章第二章 总体设计总体设计.6 2.1 系统总体架构设计（技术框架）.6 2.2 系统模块结构设计（业务框架）.6 第三章第三章 数据结构设计数据结构设计.9 3.1 物理结构设计.9 第四章第四章 接口设计接口设计.16 4.1 外

2、部接口设计.16 4.2 出错处理设计.16 第五章第五章 模块设计模块设计.17 5.1 非公用模块.17 页面输入输出 .17 类描述 .17 5.2 公用部分.17 第六章第六章 数据移植数据移植.17 第一章第一章 引言引言 1.1 前言前言 GBP 是通用 B/S 开发平台(General Browse/Server Platform)的简写，是我们多年开发经历的总结和 提炼，旨在为开发人员提供一个底层的开发支撑环境和配套的开发工具支持，降低 j2ee 多层结构软件 开发的难度，加速项目进度，提升软件质量。 GBP 应用框架不仅包含应用系统所需要的核心

3、运行时容器，分层开发支持，以及数据缓存，系统 安全，对象持久化等公共组件模块，还包括可视化的代码生成工具，帮助开发人员针对特定项目，迅 速生成高质量的、可运行的软件代码。 应用 GBP 框架，开发人员可以摆脱大量重复性的劳动，由代码生成工具根据数据库结构或其他元 数据信息，迅速生成完整的代码框架，开发人员只需加入特定的业务逻辑，即可完成开发工作。 GBP 框架能够为软件项目的开发带来如下好处： 规范和最优化应用程序的设计和开发。 框架提供的通用组件和软件设计模板，都是长时间的开发过程中的经验沉淀，吸收了众多开 源项目的精华，并解决了他们中存在的问题，更适合实际项目应用。 降低开发技术难度，降低

4、开发风险。 框架对多层结构的前端处理层，业务层，数据访问层都做了相当的工作，旨在对开发人员屏 蔽底层技术，减少由于开发人员自身能力的原因对项目造成的风险。 提高软件生产率，保证开发进度。 框架附带的代码生成工具可以迅速生成从 JSP 页面到后台数据库在内的所有程序代码，包括 各个层次的 java 类文件，各种配置文件和 jsp 页面显示文件。 提高软件开发质量，降低维护成本。 使用框架生成工具生成的代码质量更高，其关键算法和功能都使用经过多次调试后的最优经 验和做法，经过了实践考验。而且，每一行代码都经过适当的格式化，保证良好的可读性。 帮助企业进行软件技术积累和业务积累。 1.2 定义定义

5、1.3 参考资料参考资料 GBP 框架设计开发指南.doc 第二章第二章 总体设计总体设计 2.1 系统总体架构设计（技术框架）系统总体架构设计（技术框架） GBP 架构基本上和 J2EE 的 n 层架构相对应，它包括四个层次：核心组件层，前端处理层，业务 层，数据访问层，各层之间的关系如图： 核心层是一个基础层，它提供其它各层都需要的功能，比如容器管理、数据缓存、日志处理 等。 前端处理层提供一个 MVC 框架，处理来自客户端的 HTTP 请求。 业务层处理具体的业务逻辑。 数据访问层负责与数据库之间的交互，进行对象持久化。 2.2 系统模块结构设计（业务框架）系统模块结构设计（业务框架）

6、GBP 本身是个底层的应用平台，无法直接应用。但附带的后台管理系统是可以直接运行的，将它 部署到 web 服务器下，配置好数据库就可以使用。后台管理系统提供如下功能： 用户登录验证 单位管理 用户管理 角色管理 菜单管理 权限管理 日志管理 字典管理 消息管理 附件管理 第三章第三章 数据结构设计数据结构设计 3.1 物理结构设计物理结构设计 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 int int varchar(128) varchar(16) varchar(512) datetime 上 上 上 上 上 上 上 上 上

7、上 上 上 上 上 上 上 上 上 上 上 上 上 上 int int int int 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 int int varchar(50) datetime varchar(800) 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 int varchar(50) varchar(50) varchar(200) varchar(200) int int tinyint tinyint 上 上 上 上 上 上 上 上 上 int va

8、rchar(50) varchar(200) 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 int int int 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 int varchar(50) varchar(50) tinyint 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 int varchar(50) varchar(100)

9、tinyint int tinyint varchar(200) varchar(32) int varchar(32) varchar(64) varchar(64) varchar(128) varchar(128) varchar(1024) int varchar(32) varchar(32) 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 int varchar(50) varchar(50) int tinyint

10、 varchar(50) varchar(200) varchar(32) varchar(32) varchar(32) varchar(32) varchar(32) varchar(32) varchar(32) varchar(32) int 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 int varchar(32) int varchar(32) varchar(128) varchar(32) int varchar(32) int 上 上 上 上 上 上 上 上 上 上

11、 上 上 上 int int 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 int varchar(32) varchar(32) int int int varchar(128) varchar(1000) varchar(128) varchar(1000) int varchar(32) 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上

12、 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 int int int varchar(32) int varchar(32) varchar(32) int int varchar(32) 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 int varchar(60) decimal(11,0) varchar(255) char(1) varchar(255) int int char(1)

13、 varchar(255) varchar(32) 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 上 int varchar(32) varchar(255) varchar(255) char(1) varchar(255) varchar(20) varchar(20) int int varchar(255) varchar(32) varchar(32) 3.2 物理结构说明物理结构说明 .1 单位表单

14、位表 名称代码数据类型长度 主键IDint 上级单位外键PARENTIDint 上级单位名称PARENTNAMEvarchar(32)32 单位编码DEPARTNOvarchar(32)32 名称NAMEvarchar(100)100 全称TOTALNAMEvarchar(200)200 层级编码CODEvarchar(50)50 级次IDCLASSint 是否叶子节点ISLEAFtinyint 是否有效ENABLEDtinyint 电话TELvarchar(64)64 传真FAXvarchar(64)64 电子邮箱EMAILvarchar(128)128 地址ADDRESSvarchar(1

15、28)128 单位级次UNITCLASSvarchar(32)32 负责人外键MANAGERIDint 负责人姓名MANAGERNAMEvarchar(32)32 备注NOTEvarchar(1024)1024 .2 系统用户表系统用户表 名称代码数据类型长度 主键IDint 单位外键UNITIDint 用户名NAMEvarchar(50)50 真实姓名REALNAMEvarchar(50)50 密码PASSWORDvarchar(50)50 排序编号SORTNOint 是否有效ENABLEDtinyint 证件号码CERTNOvarchar(32)32 状态STATUSvar

16、char(32)32 电话TELvarchar(32)32 移动电话MOBTELvarchar(32)32 传真FAXvarchar(32)32 其它电话OTHERTELvarchar(32)32 电子邮箱EMAILvarchar(32)32 职务DUTYvarchar(32)32 备注REMARKvarchar(200)200 .3 角色表角色表 名称代码数据类型长度 主键IDint 名称NAMEvarchar(50)50 备注REMARKSvarchar(200)200 .4 系统功能表系统功能表 名称代码数据类型长度 主键IDint 名称NAMEvarch

17、ar(50)50 提交路径ACTIONvarchar(200)200 是否有效ENABLEDtinyint 层级编码CODEvarchar(50)50 级次IDCLASSint 是否叶子节点ISLEAFtinyint 菜单类型MTYPEint 备注REMARKvarchar(200)200 .5 用户角色表用户角色表 名称代码数据类型长度 用户外键USERIDint 角色外键ROLEIDint .6 角色功能表角色功能表 名称代码数据类型长度 主键IDint 菜单外键MENUIDint 角色外键ROLEIDint .7 模块按钮编码定义表模块按钮

18、编码定义表 名称代码数据类型长度 主键IDint 名称NAMEvarchar(128)128 菜单编号MENU_IDint 操作代码CODEvarchar(16)16 添加时间ADDDATEdatetime 备注REMARKSvarchar(512)512 .8 模块按钮权限表模块按钮权限表 名称代码数据类型长度 主键IDint 角色外键ROLE_IDint 菜单外键MENU_IDint 模块按钮外键FUNCTION_IDint .9 系统字典表系统字典表 名称代码数据类型长度 主键IDint 字典名称DICTNAMEvarchar(32)32 业务编码HARD

19、CODEvarchar(32)32 字典序号DICTNOint 删除标志CANDELETEint 描述信息DESCRIPTIONvarchar(128)128 上级层级编码PARENTCODEvarchar(32)32 层级编码CODEvarchar(32)32 级次CODECLASSint .10 系统日志表系统日志表 名称代码数据类型长度 主键IDint 操作时间LTIMEdatetime 操作类型LTYPEvarchar(50)50 明细INFOvarchar(800)800 用户外键USERIDint .11 系统管理用户表系统管理用户表 名称代码数

20、据类型长度 主键USERIDint 用户名USERNAMEvarchar(50)50 密码PASSWORDvarchar(50)50 是否有效ENABLEDtinyint .12 存储控制表存储控制表 名称代码数据类型长度 主键CCLBBH_PKint 存储类型名称CCLBMCvarchar(60)60 类型版本编号LBMCBBdecimal(11,0)11 存储根路径CCGMLvarchar(255)255 二级目录规则EJMLGZchar(1)1 规则辅助字段GZFZZDvarchar(255)255 是否加密ISENCRYPTint 是否压缩ISZIPint 状态ZTc

21、har(1)1 备注BZvarchar(255)255 备留XM_FKvarchar(32)32 .13 存储明细表存储明细表 名称代码数据类型长度 主键YSBH_PKint 存储控制外键CCLBBH_PKvarchar(32)32 存储名称WYBSvarchar(255)255 原始名称WJMCvarchar(255)255 存储路径CCLJvarchar(255)255 是否加密ISENCRYPTint 是否压缩ISZIPint 创建时间CJSJvarchar(20)20 上次修改时间SCXGSJvarchar(20)20 状态WJZTchar(1)1 业务备注YWBZvarchar(32)32 备注BZvarchar(255)255 备留字段XM_FKvarchar(32)32 .14 消息表消息表 名称代码