Java程序设计-模块设计报告

{项目名称}模块设计报告文件状态：[√]草稿[]正式发布[]正在修改文件标识：Company-Project-SD-MODULE当前版本：X.Y作者：完成日期：Year-Month-Day机构图标机构公开信息项目名称，《模块设计报告》机构名称，2002Page2of20版本历史版本/状态作者参与者起止日期备注项目名称，《模块设计报告》机构名称，2002Page3of20目目录录0.文档介绍............................................................................................................................40.1文档目的.......................................................................................................................40.2文档范围.......................................................................................................................40.3读者对象.......................................................................................................................40.4参考文献.......................................................................................................................40.5术语与缩写解释............................................................................................................41.模块命名规则.....................................................................................................................62.模块汇总............................................................................................................................62.1模块汇总表...................................................................................................................62.2模块关系图...................................................................................................................63.子系统A的模块设计.........................................................................错误!未定义书签。3.N模块A-N........................................................................................错误!未定义书签。4.子系统B的模块设计.........................................................................错误!未定义书签。4.N模块B-N.........................................................................................错误!未定义书签。5.其他..................................................................................................................................20项目名称，《模块设计报告》机构名称，2002Page4of200.文档介绍0.1文档目的作为企业即时通软件设计文档的重要组成部分，本文档主要对该软件各个模块以及模块与模块之间的关系进行了详细描述，并对相关内容做出了统一的规定。0.2文档范围本文档包含以下几个部分:0.文档介绍1.模块命名规则2.模块汇总3.其它0.3读者对象本文档的主要读者包括：1.本系统的设计人员：包括模块设计人员2.本系统的系统开发人员：编码人员。3.本系统的测试人员0.4参考文献提示：列出本文档的所有参考文献（可以是非正式出版物），格式如下：[标识符]作者，文献名称，出版单位（或归属单位），日期例如：[AAA]作者，《立项建议书》，机构名称，日期[SPP-PROC-SD]SEPG，系统设计规范，机构名称，日期0.5术语与缩写解释缩写、术语解释SPP精简并行过程，SimplifiedParallelProcessSD系统设计，SystemDesign项目名称，《模块设计报告》机构名称，2002Page5of20…项目名称，《模块设计报告》机构名称，2002Page6of201.模块命名规则1.1类和接口1)类和接口名均采用名词，首字母大写，其他单词首字母大写。例如：BufferedStreamReader，缩写词必须全部大写。例如：TargetURL。1.2包1）所有包名只能用小写字母。尽量别使包名长度超过8个字符，避免使用多个词作为包名；2）顶级包名采用开发者所在机构的域名的逆序，若没有域名，可采用公司英文名称；例如：com.sun.jdbc、org.jboss3）非顶级包名采用名词，或名词的缩写。2.模块汇总2.1模块汇总表用户界面（客户端）模块名称功能简述LoginJFrameLoginJFrame类为用户提供登录界面。MainJFrameMainJFrame类为客户端主窗体界面。ChatJFrameChatJFrame类为用户提供发送、显示聊天消息的操作界面。ChatRecordJFrameChatRecordJFrame类为用户提供导出聊天记录、清除聊天记录的操作界面。UpdateInfoJFrameUpdateInfoJFrame类为用户提供更新用户信息的操作界面。UserInfoJFrameUserInfoJFrame类为用户提供查看在线用户信息的界面。ClientReceiveThreadClientReceiveThread类负责接收服务器端转发的消息。表1-1表示层（客户端）模块汇总表用户界面（服务器端）模块名称功能简述MainJFrameMainJFrame类为用户提供服务器端的主窗体界面。CorperationJFrameCorperationJFrame类为用户提供更新公司信息的操作界面。DepartmentJFrameDepartmentJFrame类为用户提供增加、删除、修改、显示部门信息的操作界面。UserInfoJFrameUserInfoJFrame类为用户提供增加、删除、修改、显示用户的操作界面。DepartmentAddFrmDepartmentAddJFrame类为用户提供增加部门的操作界面。项目名称，《模块设计报告》机构名称，2002Page7of20UserInfoAddJFrameUserInfoAddJFrame类为用户提供增加用户的操作界面。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数据实体汇总表工具类项目名称，《模块设计报告》机构名称，2002Page8of20模块名称功能简述ConstantValuesConstantValues类中定义了程序中常用的符号与数字常量。DbUtils类DbUtils类定义了访问数据库的常用方法。CommonUtils类CommonUtils类定义了和字符串、日期、文件、Swing界面开发相关的常用方法。PropConfig类PropConfig类定义了与资源文件操作相关的属性与方法。表1-6工具类汇总表2.2模块关系图2.2.1包关系1.表示层（客户端）如下图（图2-3）所示：图2-3客户端表示层2.表示层（服务器端）如下图（图2-4）所示：项目名称，《模块设计报告》机构名称，2002Page9of20图2-4服务器端表示层3.自定义界面（图2-5）所示：图2-5自定义界面类4.业务规则类如下图（图2-6）所示：项目名称，《模块设计报告》机构名称，2002Page10of20图2-6业务规则类5.数据实体类如下图（图2-7）所示：图2-7数据实体类6.工具类如下图（图2-8）所示：图2-8工具类7.图像资源和资源文件项目名称，《模块设计报告》机构名称，2002Page11of20图像资源主要包含程序中用到的图像文件，本项目中使用的图像文件格式均为gif格式。2.2.2表示层模块设计2.2.2.1客户端表示层模块1：LoginJFrame如下表：模块名称LoginJFrame功能描述LoginJFrame为用户提供登录界面，用户输入帐号、密码、服务器IP和服务器端口号进行登录。接口与属性函数名访问性返回值参数功能verifiedInput私有有无客户端验证数据结构无补充说明无表2-10LoginJFrame类模块2：MainJFrame模块名称MainJFrame功能