模块设计报告

{ 项目名称} 模块设计报告

机构公开信息

版本历史

目录

0. 文档介绍 (4)

0.1文档目的 (4)

0.2文档范围 (4)

0.3读者对象 (4)

0.4参考文献 (4)

0.5术语与缩写解释 (4)

1. 模块命名规则 (6)

2. 模块汇总 (6)

2.1模块汇总表 (6)

2.2模块关系图 (6)

3. 子系统A的模块设计 ....................................................................... 错误！未定义书签。

3.N 模块A-N ..................................................................................... 错误！未定义书签。

4. 子系统B的模块设计 ....................................................................... 错误！未定义书签。

4.N 模块B-N...................................................................................... 错误！未定义书签。

5. 其他 (20)

0. 文档介绍

0.1 文档目的

作为企业即时通软件设计文档的重要组成部分，本文档主要对该软件各个模块以及模块与模块之间的关系进行了详细描述，并对相关内容做出了统一的规定。

0.2 文档范围

本文档包含以下几个部分:

0.文档介绍

1.模块命名规则

2.模块汇总

3.其它

0.3 读者对象

本文档的主要读者包括：

1. 本系统的设计人员：包括模块设计人员

2. 本系统的系统开发人员：编码人员。

3. 本系统的测试人员

0.4 参考文献

提示：列出本文档的所有参考文献（可以是非正式出版物），格式如下：[标识符] 作者，文献名称，出版单位（或归属单位），日期

例如：

[AAA]作者，《立项建议书》，机构名称，日期

[SPP-PROC-SD] SEPG，系统设计规范，机构名称，日期

0.5 术语与缩写解释

1. 模块命名规则

1.1 类和接口

1) 类和接口名均采用名词，首字母大写，其他单词首字母大写。

例如：

BufferedStreamReader，缩写词必须全部大写。例如：TargetURL。

1.2 包

1）所有包名只能用小写字母。尽量别使包名长度超过8个字符，避免使用多个词作为包名；

2）顶级包名采用开发者所在机构的域名的逆序，若没有域名，可采用公司英文名称；

例如：

com.sun.jdbc、org.jboss

3）非顶级包名采用名词，或名词的缩写。

2. 模块汇总

2.1 模块汇总表

表 1-1 表示层（客户端）模块汇总表

表 1-2 表示层（服务器端）模块汇总表

表 1-3 自定义界面模块汇总表

表 1-4 业务规则模块汇总表

表1-5 数据实体汇总表

表1-6 工具类汇总表2.2 模块关系图

2.2.1 包关系

1. 表示层（客户端）如下图（图2-3）所示：

图 2-3 客户端表示层

2. 表示层（服务器端）如下图（图2-4）所示：

图 2-4 服务器端表示层3. 自定义界面（图2-5）所示：

图 2-5 自定义界面类4. 业务规则类如下图（图2-6）所示：

图2-6 业务规则类5. 数据实体类如下图（图2-7）所示：

图 2-7 数据实体类6. 工具类如下图（图2-8）所示：

图2-8 工具类7. 图像资源和资源文件

图像资源主要包含程序中用到的图像文件，本项目中使用的图像文件格式均为gif 格式。

2.2.2表示层模块设计

2.2.2.1 客户端表示层

模块1：LoginJFrame 如下表：

表 2-10 LoginJFrame类

模块2：MainJFrame

表 2-11 MainJFrame类

2.2.2.2 服务器端表示层

模块1：MainJFrame

表 2-12 MainJFrame类

模块2：OnlineWatchJFrame

表 2-13 OnlineWatchJFrame类

2.2.3 工具类模块设计

模块1：DbUtils

表 2-14 DbUtils类

图2-9 DbUtils类图模块2：PropConfig

表 2-15 PropUtils模块

图2-10 PropConfig类图模块3：CommonUtils

表 2-16 CommonUtils类

图2-11 CommonUtils类图

限于篇幅，表2-16中只列出了大部分的方法，其它方法的使用请参照本案例的《模块设计文档》。

2.2.4 数据实体模块设计

模块1：Corperation

表 2-17 Corperation类

图2-12 Corperation类图模块2：Department

表 2-18 Department类

图2-13 Department类图模块3：UserInfo