概要设计--IM模块(XJ)

概要设计说明书1．引言 (1)1.1编写目的 (1)1.2项目背景 (1)1.3定义 (1)1.4参考资料 (1)2．任务概述 (2)2.1目标 (2)2.2运行环境 (2)2.3需求概述 (2)2.4条件与限制 (2)3．总体设计 (3)3.1处理流程 (3)3.2总体结构和模块外部设计 (8)3.3功能分配 (9)4．接口设计 (12)4.1外部接口 (12)4.2内部接口 (12)5．数据结构设计 (13)5.1逻辑结构设计 (13)5.2物理结构设计 (19)5.3数据结构与程序的关系 (19)6．运行设计 (19)6.1运行模块的组合 (19)6.2运行控制 (20)6.3运行时间 (20)7．出错处理设计 (20)7.1出错输出信息 (20)7.2出错处理对策 (20)8.安全保密设计 (21)9.维护设计 (21)1．引言1.1编写目的为了迎合市场的需求，特开发此企业平台项目。

1.2项目背景主要监管人：。

主要验收人：。

主要开发单位：第五期第二项目小组。

1.3定义Enterprise Platform：企业平台软件的名称。

General Notice Module：通用通知组件的名称(GNM) LogIn：登录LogOut：登出SearchLocalFriend：搜索本地好友FindFriend：查找好友AddFriend：添加好友DeleteFriend：删除好友SeeFriendInfo：查看好友信息SendFileAsk：发送文件请求SendFileCancel：取消文件传输SendFileConfirm：确认文件传输ChatMsg：聊天消息View chat logs：查看聊天记录Delete chat logs：删除聊天记录MsgSetting：消息提示设置PersonalInfoSetting：个人信息设置ATM（Asynchronous Transfer Mode）：网络异步传输网络1.4参考资料暂无2．任务概述2.1目标通用通知组件（GNM）用于替代传统的MessageBox，当企业平台运行中发生事件，根据事件对用户影响的关键程度，屏幕上将弹出相应的特殊消息。

用户成功登录企业平台之后，使用IM进行在线聊天、发送离线消息、发送在线文件等操作。

2.2运行环境硬件环境：Inter 奔四及其后续处理器，512M内存。

软件环境：Windows2000/Windows2003/Windows XP/Windows Vista/Windows7,并向上兼容。

2.3需求概述通用通知组件（GNM）根据事件对用户影响的关键程度，用户会收到以下通知类型：信息提示：用户进行某些重要操作可能导致数据无法恢复的时候，比如删除好友、删除本地聊天记录等操作，此时系统会给出提示，弹出该类型对话框，希望得到用户的确认才能进行操作，这些提示框是蓝色的。

当对方不在线的时候如果给对方发送文件，会给出文件无法发送的提示信息。

2.4条件与限制暂无3．总体设计3.1处理流程一、登录登出图3-1-1 登陆登出功能二、聊天消息图3-1-2 聊天消息三、文件传输图3-1-3文件传输四、好友管理图3-1-4 搜索本地好友图 3-1-5 查找好友图 3-1-6 添加好友图 3-1-7 删除好友图 3-1-8 查看好友信息五、系统设置图 3-1-9 系统设置3.2总体结构和模块外部设计图 3-1-10 IM模块总体结构示意图图 3-1-11 好友管理功能划分3.3功能分配将整个IM模块作为组件，总体结构如上图，其功能介绍如下：1、登录登出登录（LogIn）：企业平台客户端启动之后用户A登录系统，成功登录之后会启动IM模块，IM模块从平台获得账号、密码、服务器的IP以及端口号，连接服务器，连接服务器成功之后用获得的账号密码登录服务器。

如果登录成功，则服务器先将登录成功的消息发送给用户A，当用户A收到登录成功的消息时，会向服务器请求其好友列表，此时服务器向用户A发送其好友列表（包含部门好友与自己的好友）发送给A，再查看A 是否有离线消息，如果有则将离线消息发送给A，然后将A的在线状态设置为在线，并且向A的所有(在线)好友发送A上线的消息。

登出（LogOut）：当用户A退出企业平台之后，IM模块也随之退出，服务器收到消息之后，会将A的在线状修改为离线，然后向A 所有（在线）好友发送A下线的消息。

2、好友管理搜索本地好友（SearchLocalFriend）：用户A成功登录IM后，如果用户A的好友比较多，又希望快速找到某个好友的时候，可以使用该功能搜索本地的好友。

用户A可以输入需要查找的用户名字或者是用户的ID进行搜索，程序会从本地存储好友的链表中分别按照用户名和用户ID进行查找，找到匹配的好友之后，将好友的名字部门以下拉列表的形式在搜索框下部显示出来，用户双击某个人，会弹出与该好友进行聊天的聊天框。

如果没有匹配项，列表项中给出没有匹配项的提示信息。

查找好友（FindFriend）：查找好友的功能与搜索好友的功能相似，但是其实质却不同，搜索好友时对本地的好友进行操作，查找好友则是对数据库中所有的好友进行操作。

当用户点击IM主界面上的查找好友的按钮时，会弹出一个查找好友的对话框，用户可以选择查找方式（按名字查找、按ID查找、按部门查找三种），然后再输入框中输入相应的信息，点击查找按钮进行查找，服务器如果找到了匹配条件的用户，则会将该列表发送回来，以列表的形式显示在查找好友的界面上，用户可以点击添加好友的按钮将向选择的对象发送添加好友的请求。

添加好友（AddFriend）：在查找好友步骤的基础上，用户可以对查找到的好友进行添加好友操作，该添加好友功能只是向对方发送一个添加好友的申请，需要对方的回应。

如果对方拒绝添加为好友，则双方都不在其好友列表中，如果对方同意，则双方都将对方添加到自己的好友列表，服务器也将双方添加到对方的好友列表中。

（注意*）在发送添加对方为好友之前，客户端需要首先校验对方的ID是否已经在自己的好友列表中，如果存在，则提示用户，该用户已经是您的好友，如果不存在，则发出请求消息。

删除好友（DeleteFriend）：删除好友功能是针对自己已经添加的好友来操作的，对部门好友无法完成该操作，除非将部门好友添加到自己的好友中之后，才能我的好友列表中进行删除，但是无法将其移动出部门好友列表。

在我的好友列表中选中某个好友之后，右键单击，会弹出一个包含删除好友的列表菜单，选择删除好友，会弹出确认是否将该好友删除的对话框，点击确定，会向服务器发送出删除该好友的消息，服务器收到该消息会向对方发送出一条被删除好友的消息，同时将双方从对方的好友列表中删除，对方收到被删除的消息时，也会及时更新好友列表。

查看好友信息（SeeFriendInfo）：查看好友信息功能，是在对方已经是自己的好友的条件下。

如果要查看的对方不在自己的好友列表中，则无法完成该功能。

操作方法是在我的好友列表中选中某个好友，右键单击弹出包含查看好友信息的下拉菜单，选择查看好友信息，则会向服务器发送出查看好友信息的消息，并且弹出一个对话框，当接收到服务器查找的信息时，显示该好友的信息。

3、文件传输用户A向用户B发送文件名为FileName，文件大小为FileSize的文件。

发送文件请求（SendFileAsk）：在用户A与用户B同时在线的情况下才能使用该功能，如果有一方不在线，则无法完成文件传输。

如果A和B都在线，A需要向B发送一个文件名为FileName，文件大小为FileSize的文件，则A首先需要向B发送一个包含文件名、文件大小的的文件传输请求，等待B的确认。

取消文件传输（SendFileCancel）：如果在等待B的确认的过程中，A取消了文件传输，或者关闭了文件传输的窗口，则需要向服务器发送一个包含文件名的取消文件传输的消息，服务器转发给B取消接受该文件。

在文件传输的过程中，发生类似的情况，也需要这么处理。

确认文件传输（SendFileConfirm）：在A收到了B的确认之后，进行判断。

如果B不同意接收文件，则A不能进行文件传输。

如果B同意接收文件，则A在得到确认消息之后就开始发送文件的内容（暂不考虑加密问题），B则将接收到的文件保存。

4、聊天聊天消息（ChatMsg）：在用户A和用户B已经互为好友的情况下，A和B就可以进行在线聊天或者发送离线消息。

如果A和B都在线，则聊天消息直接经过服务器转发到对方。

如果A在线，B不在线，则IM服务器会将A发出的聊天消息保存在B的数据库的离线消息中，当B上线的时候，服务器会自动校验B是否有离线消息，如果有责发给B。

聊天的消息记录会保存在本地的Access数据库中，通过查看聊天记录功能，可以查看历史聊天记录。

查看聊天记录（View chat logs）：用户打开与某个好友的聊天界面的时候，通过查看聊天记录功能，可以查看历史聊天记录。

点击聊天记录按钮，聊天界面右边会拉伸，并且显示出历史的聊天记录。

删除聊天记录（Delete chat logs）：用户打开与某个好友的聊天界面的时候，通过查看聊天记录功能，可以查看历史聊天记录。

点击聊天记录按钮，聊天界面右边会拉伸，并且显示出历史的聊天记录，点击删除历史记录按钮，会弹出确认删除的提示框，确认删除之后，用户与该好友的聊天记录会在本地Access聊天记录数据库中删除。

（注意*）该聊天记录只是记录在本地的Access数据库中，不会保存在服务器，删除后不可恢复。

5、系统设置对于企业软件，在IM方面的功能要求不太多，安全、适用就行。

所以在没有完成视频语音聊天的情况下，该系统的IM模块需要设置的内容比较少。

主要有消息提示的设置和个人信息的设置。

消息提示设置（MsgSetting）：该设置是针对接收到好友发来的消息如何进行处理的，分为两种处理方式，一种是不给用户进行提示，当有消息来临，就直接弹出该聊天窗口并显示收到的消息。

另一种是不弹出窗口，但是给用户一个提示信息在IM界面上用一个动态的消息图标给用户提示，如果窗口处在最小化状态，主界面上也会有一个该图标，提示用户有消息来临。

用户单击该图标，会弹出聊天消息的聊天对话框。

个人信息设置（PersonalInfoSetting）：该项设置的信息时用户自定义的，与企业平台中用户的真实信息不相干，用户可以选择不填，也可以填虚假信息，这样也是为安全考虑，当然，用户可以填自己的真实信息，该信息业只是针对自己的好友开放，不是自己的好友无法查阅。

用户可以在IM界面的系统菜单中选择此项进行编辑和修改，用户也可以通过点击自己的头像，弹出个人信息的对话框，进行编辑和修改，编辑完成之后，点击确定，该个人信息更新的数据包就会发送到数据库。