Java程序设计-模块设计报告(共20页).doc

精选优质文档-倾情为你奉上机构图标 项目名称 模块设计报告文件状态： 草稿 正式发布 正在修改文件标识：Company-Project-SD-MODULE当前版本：X.Y作 者：完成日期：Year-Month-Day机构公开信息版 本 历 史版本/状态作者参与者起止日期备注 目 录 0. 文档介绍0.1 文档目的作为企业即时通软件设计文档的重要组成部分，本文档主要对该软件各个模块以及模块与模块之间的关系进行了详细描述，并对相关内容做出了统一的规定。0.2 文档范围本文档包含以下几个部分:0.文档介绍1.模块命名规则2.模块汇总3.其它0.3 读者对象本文档的主要读者包括：1. 本系统的设计人员：包括模块设计人员2. 本系统的系统开发人员：编码人员。3. 本系统的测试人员0.4 参考文献提示：列出本文档的所有参考文献（可以是非正式出版物），格式如下：标识符 作者，文献名称，出版单位（或归属单位），日期例如：AAA 作者，立项建议书，机构名称，日期 SPP-PROC-SD SEPG，系统设计规范，机构名称，日期0.5 术语与缩写解释缩写、术语解 释SPP精简并行过程，Simplified Parallel ProcessSD系统设计，System Design1. 模块命名规则1.1 类和接口1) 类和接口名均采用名词，首字母大写，其他单词首字母大写。例如：BufferedStreamReader，缩写词必须全部大写。例如：TargetURL。1.2 包1）所有包名只能用小写字母。尽量别使包名长度超过8个字符，避免使用多个词作为包名；2）顶级包名采用开发者所在机构的域名的逆序，若没有域名，可采用公司英文名称；例如：com.sun.jdbc、org.jboss3）非顶级包名采用名词，或名词的缩写。2. 模块汇总2.1 模块汇总表用户界面（客户端）模块名称功能简述LoginJFrameLoginJFrame类为用户提供登录界面。MainJFrameMainJFrame类为客户端主窗体界面。ChatJFrameChatJFrame类为用户提供发送、显示聊天消息的操作界面。ChatRecordJFrameChatRecordJFrame类为用户提供导出聊天记录、清除聊天记录的操作界面。UpdateInfoJFrameUpdateInfoJFrame类为用户提供更新用户信息的操作界面。UserInfoJFrame UserInfoJFrame类为用户提供查看在线用户信息的界面。ClientReceiveThreadClientReceiveThread类负责接收服务器端转发的消息。表 1-1 表示层（客户端）模块汇总表用户界面（服务器端）模块名称功能简述MainJFrameMainJFrame类为用户提供服务器端的主窗体界面。CorperationJFrameCorperationJFrame类为用户提供更新公司信息的操作界面。DepartmentJFrameDepartmentJFrame类为用户提供增加、删除、修改、显示部门信息的操作界面。UserInfoJFrameUserInfoJFrame类为用户提供增加、删除、修改、显示用户的操作界面。DepartmentAddFrmDepartmentAddJFrame类为用户提供增加部门的操作界面。UserInfoAddJFrameUserInfoAddJFrame类为用户提供增加用户的操作界面。ServerListenThreadServerListenThread类负责侦听客户端的连接请求ServerReceiveThreadServerReceiveThread类负责接收、转发客户端的消息。表 1-2 表示层（服务器端）模块汇总表自定义界面模块名称功能简述AboutPanelAboutPanel类定义了“关于”面板上图像的布局方式InfoPanelInfoPanel类定义了“信息”面板上图像与程序信息的布局方式HelpDailogHelpDailog类为自定义对话框，作为AboutPane和InfoPanel的容器PicPanelPicPanel类为自定义图像框，作为图像显示的容器 表 1-3 自定义界面模块汇总表业务规则类模块名称功能简述CorperationBLCorperationBL类用于处理与公司相关的业务操作，例如查询或更新公司信息。继承自DbUtils类DepartmentBLDepartment类负责处理与部门相关的业务操作，例如部门信息的增、删、改。继承自DbUtils类UserInfoBLUserInfoBL类负责处理与用户相关的业务操作，例如用户信息的增、删、改。继承自DbUtils类DeptsUsersBLDeptssUsersBL类负责处理与部门用户信息相关的业务规则。表 1-4 业务规则模块汇总表数据实体类模块名称功能简述CorperationCorperation类定义公司对象，包含了访问公司属性的方法。DepartmentDepartment类定义部门对象，包括部门的编号、名称、描述等属性，其中包括访问这些属性的方法。UserInfoUserInfo类定义用户对象，包括用户的基本属性和访问这些信息的方法。OnlineUserOnLineUser类定义在线用户对象，该类继承自UserInfo，它不仅包括用户的基本属性，而且加入了一些与网络通信相关的属性。它也包含访问这些属性的方法。表1-5 数据实体汇总表工具类模块名称功能简述ConstantValuesConstantValues类中定义了程序中常用的符号与数字常量。DbUtils类DbUtils类定义了访问数据库的常用方法。CommonUtils类CommonUtils类定义了和字符串、日期、文件、Swing界面开发相关的常用方法。PropConfig类PropConfig类定义了与资源文件操作相关的属性与方法。表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 如下表：模块名称LoginJFrame功能描述LoginJFrame为用户提供登录界面，用户输入帐号、密码、服务器IP和服务器端口号进行登录。接口与属性函数名访问性返回值参数功能verifiedInput私有有无客户端验证数据结构无补充说明无表 2-10 LoginJFrame类模块2：MainJFrame模块名称MainJFrame功能描述MainJFrame为用户提供基本客户端操作界面，用户登录成功后显示该窗体，该窗体侦听服务器发送的信息，并做相应处理。接口与属性函数名访问性返回值参数功能refreshInterface私有无无刷新界面addChildTree公有无有添加子结点openNewChatJFrame公有无有打开聊天窗体checkAccount私有布尔值有检查有效用户数据结构无补充说明无表 2-11 MainJFrame类2.2.2.2 服务器端表示层模块1：MainJFrame模块名称MainJFrame功能描述MainJFrame为用户提供基本操作界面，负责启动、停止服务、侦听客户端发送的消息并进行处理。接口与属性函数名访问性返回值参数功能startServer私有无无启动服务stopServer私有无无停止服务getConfiguration私有无无显示服务器配置initComponentsState私有无有初始化界面控件数据结构无补充说明无表 2-12 MainJFrame类模块2：OnlineWatchJFrame模块名称OnlineWatchJFrame功能描述OnlineWatchJFrame为用户提供了显示在线用户详细信息的功能接口与属性函数名访问性返回值参数功能refreshOnlineTable私有无无刷新在线人员界面数据结构无补充说明表 2-13 OnlineWatchJFrame类2.2.3 工具类模块设计模块1：DbUtils模块名称DbUtils功能描述DbUtils类提供了访问数据库数据的操作，该类被业务规则类继承。接口与属性函数名访问性返回值参数功能connOpen私有无无打开数据库连接connClose私有无无关闭数据库连接prepstmtClose私有无无关闭Sql执行对象resultsetClose私有无无关闭结果集对象getSqlStatement私有无无得到替换sql语句excuteQuery私有有有执行查询excuteUpdate私有有有执行更新query受保护有有查询update受保护有有更新closeALL受保护无有关闭所有数据库对象closeALL受保护无无同上数据结构无补充说明无表 2-14 DbUtils类图2-9 DbUtils类图模块2：PropConfig模块名称PropConfig功能描述PropConfig类提供了访问资源配置文件的常用操作。接口与属性函数名访问性返回值参数功能initSocketConfig私有无无初始化Socket资源实体initDbConfig私有无无初始化数据库资源实体initMsgConfig私有无无初始化消息资源实体initSqlConfig私有无无初始化Sql资源实体getSocket_resource公有有无得到Socket资源实体getDb_resource公有有无得到Db资源实体getMsg_resource公有有无得到消息资源实体getSql_resource公有有无得到Sql资源实体getComplexMsg公有有有取得复合消息数据结构无补充说明无表 2-15 PropUtils模块图2-10 PropConfig类图模块3：CommonUtils模块名称CommonUtils功能描述CommonUtils类提供了一些公用方法，包括Swing开发相关方法、文件操作相关方法、日期操作相关方法、字符串操作相关方法、与网络操作相关方法，这里只列举一部分接口与属性函数名访问性返回值参数功能getScreenHeight私有有无取得屏幕高度getScreeWidth私有有无取得屏幕宽度setScreenCenter公有无有将组件位置设置在屏幕中心setScreenRight公有无有将组件位置设置在屏幕右上角getCurrentTime公有有无得到当前机器时间writeToFile公有无有写文件操作getContentFromFile公有有有从文件中读取内容checkNumsLetters公有有有检查字符串是否包含特殊字符checkNums公有有有检查字符串是否只包含数字checkLetters公有有有检查字符串是否只包含字母getServerIP公有有有取得服务器端IP地址getServerPort公有有有取得服务器端口号数据结构无补充说明无表 2-16 CommonUtils类图2-11 CommonUtils类图限于篇幅，表2-16中只列出了大部分的方法，其它方法的使用请参照本案例的模块设计文档。2.2.4 数据实体模块设计模块1：Corperation模块名称Corperation功能描述Corperation类用于保存公司信息。此类提供了访问公司属性的方法。接口与属性提供了访问公司属性的get/set方法数据结构无补充说明无表 2-17 Corperation类图2-12 Corperation类图模块2：Department模块名称Departement功能描述Department类用于保存部门信息，此类提供了访问部门属性的方法。接口与属性提供了访问部门属性的get/set方法数据结构无补充说明无表 2-18 Department类图2-13 Department类图模块3：UserInfo模块名称UserInfo功能描述UserInfo类用于保存用户信息，此类提供了访问用户属性信息的方法。接口与属性提供了访问用户属性的get/set方法数据结构无补充说明无表 2-19 UserInfo类图2-14 UserInfo类图模块4：OnlineUser模块名称OnlineUser功能描述OnLineUser类是用来保存在线用户信息的，此类继承UserInfo类，提供了访问在线用户属性的方法。接口与属性提供了访问在线用户属性的get/set方法数据结构无补充说明无表 2-20 OnlineUser类图2-15 OlineUser类图2.2.5 业务逻辑模块设计模块1：CorperationBL模块名称CorperationBL功能描述CorperationBL类提供操纵公司信息数据的功能，此类继承了DbUtils类。接口与属性函数名访问性返回值参数功能getCorperation公有有有取得公司信息实体数据结构无补充说明无表 2-21 CorperationBL类图2-16 CorperationBL类图模块2：DepartmentBL模块名称DepartmentBL功能描述DepartmentBL类提供了操纵部门信息数据的功能，此类继承了DbUtils类。接口与属性函数名访问性返回值参数功能getALLDepartment公有有有取得所有部门信息数据结构无补充说明无表 2-22 DepartmentBL类图2-17 DepartmentBL类图模块3：UserInfoBL模块名称UserInfoBL功能描述UserInfoBL类提供了操纵用户、在线用户数据的功能，此类继承了DbUtils类接口与属性函数名访问性返回值参数功能addUser公有有有向在线用户集合中加入用户deleteUser公有无无从在线集合中删除一个用户verifiedUser公有有有验证用户身份getALLUserInfo公有有无取得所有用户信息setUserOlineState公有无有设置用户在线状态数据结构无补充说明无表 2-23 UserInfoBL类图2-18 UserInfoBL类图模块4：DeptsUsersBL模块名称DeptsUsersBL功能描述DeptsUsers类提供了获取部门信息字符串的相关方法接口与属性函数名访问性返回值参数功能getALLDeptsOnlineUsersInfo公有有有获取所有在线部门用户详细信息getALLDeptsOnlineUsersString私有有有获取部门信息字符串数据结构无补充说明无表 2-24 DeptsUsersBL类图2-19 DeptsUsersBL类图3. 其它专心-专注-专业