局域网聊天系统详细设计

项目编号项目编号 JYWLTXT 局域网聊天系统局域网聊天系统 卷卷 号号 卷内编号卷内编号 密密 级级 详细设计说明书详细设计说明书 Version 项 目 承 担 部 门 08 软件第 5 小组 撰 写 人 签名 全体成员 完 成 日 期 2010 7 21 本文档 使 用部门 08 软件第 5 小组 评 审 日 期 2010 7 21 概要设计说明书 1 目录目录 1 引言 1 1 1编写目的 1 1 2背景 1 1 3定义 1 1 4参考资料 1 2 程序 模块 系统的组织结构 1 3 界面设计要求 2 4 本软件系统中各程序 模块 的设计说明 2 4 1系统配置管理模块的设计说明 2 4 1 1个人资料模块 2 4 1 2信息屏蔽模块 4 4 1 3上线提示模块 6 4 2用户扫描的设计说明 8 4 3在线交流的设计说明 11 4 4消息群发模块 14 4 5消息记录模块的设计说明 16 4 5 1消息查询模块 16 4 5 2消息记录模块 20 5 模块相互关系表 20 概要设计说明书 2 1 引言引言 1 1 编写目的编写目的 软件详细设计是软件概要设计的进一步细化 他对系统的各个功能进行了逻辑上 的实现 规定了编码的结构和思路 是应用系统进行物理实现的直接基础 1 2 背景背景 软件系统的名称 局域网聊天系统 本项目的任务提出者 实习单位 本项目的任务开发者 西南交大 08 级软件工程第五组 软件系统的用户 同局域网下用户 1 3 定义定义 列出文件中用到的专业术语的定义和外文字母的原词组 UDP 数据报协议 TCP 传输控制协议 SOCKET 套接字 1 4 参考资料参考资料 相关项目案例 计算机软件产品开发文件编制指南 Visual C 6 开发使用手册 机械工业出版社 1999 2 CIP 40581 TCP IP 进行网际互连 电子工业出版社 1998 4 ISBN 7 5063 4607 5 TP 2188 2 程序 模块 系统的组织结构程序 模块 系统的组织结构 局域网聊天系统 用 户 扫 描 系 统 在 线 交 流 系 统 消 息 群 发 系 统 系 统 配 置 系 统 消 息 记 录 系 统 概要设计说明书 3 3 界面设计要求界面设计要求 1 系统窗口所使用的图标统一 2 系统 分辨率为 800 600 小字体 3 该系统用户界面可根据模块大致分为 1 用户总体界面 2 用户聊天界面 3 系统配置界面 4 消息记录界面 5 消息群发界面 总体界面根据功能界面的设计基础上 统一做以下要求 1 按钮根据摆放位置在考虑美观性的基础上设置大小及字体 2 弹出的对话框采取统一样式 告知信息必须明确 3 界面要做到简洁美观大方 4 编辑框根据形式及摆放位置设置大小及宽度 必须顾及整体的协调性 4 本软件系统中各程序本软件系统中各程序 模块模块 的设计说明的设计说明 4 1 系统配置管理模块的设计说明系统配置管理模块的设计说明 模模 块块 详详 细细 设设 计计 说说 明明 表表 4 1 1个人资料模块 编号 模块名称 个人资料 模块代号 适用范围 全局 局部 类型 窗口 函数 用户对象 模块功能用于用户填写相关个人资料 作者周扬编写时间修改人 修改时间修改批准人修改次数 性能要求 对精度 灵活性 时间特性等的要求 限制条件 已经上线的用户 输 入 给出每一输入项的名称 数据类型和格式 概要设计说明书 4 输 出 给出每一输出项的名称及意义 数据类型和格式 数据值的有效范 围 输出方式 数量的说明等 算法逻辑 1 填写信息 2 通过相关变量存入文件 相关对象 及接口 包括 昵称 m Name 性别 m Sex 年龄 m Age 电子邮件 m Emai 个人说明 m Information 通过相关结构体保存至文件 备注 无 窗窗 口口 对对 象象 说说 明明 表表 编号 窗口名 IDD PersonalInfor 说明书编号 1 1 窗口对象控件列表 窗口对象控件列表 对象类型对象名称对象事件对象功能描述 用户使用 控制 m NameInput 接收输入用户 昵称 输入信息 m SexInput 接收输入用户 性别 输入信息 m AgeInput 接收输入用户 年龄 输入信息 编辑框 m EmailInput 接收输入用户 EMAIL 输入信息 概要设计说明书 5 m InformationInput 接收输入用户 个人说明 输入信息 IDOK2clicked 将用户输入的 信息输出到文 件 点击 命令按钮 IDOKclicked 取消点击 2 2 窗口事件列表 窗口事件列表 事件名 事件 类型 事件功能描述事件算法逻辑 无 3 窗口函数列表 窗口函数列表 函数名 函数类型 全局 窗口 函数功能描述函数算法逻辑 Save File 窗口 将用户填写的数据存 入文件 将输入数据保存至 相关结构体 运用 相关文件操作函数 输出至文件 4 1 2信息屏蔽模块 编号 模块名称 信息屏蔽 模块代号 适用范围 全局 局部 类型 窗口 函数 用户对象 模块功能可以将用户不想接受的用户的全部消息进行屏蔽 作者周扬编写时间修改人 修改时间修改批准人修改次数 概要设计说明书 6 性能要求 对精度 灵活性 时间特性等的要求 限制条件 已经上线的用户 输 入 选择想屏蔽的用户 输 出 对屏蔽的用户的消息不再显示 算法逻辑 1 将用户选择的用户加入屏蔽列表 2 用户接收消息时首先读取屏蔽列表 若发送消息用户不在屏蔽列表 中 则显示该用户消息 反之则不显示 相关对象 及接口 备注 窗口对象说明表 窗窗 口口 对对 象象 说说 明明 表表 编号 窗口名 IDD BlackList 说明书编号 1 1 窗口对象控件列表 窗口对象控件列表 对象类型对象名称对象事件对象功能描述 用户使用 控制 编辑框 m BlackIpInput 接收输入想屏 蔽的 IP 地址 输入信息 数据显示 BlackListView 显示已经添加 至黑名单的 IP 查看 概要设计说明书 7 On Addclicked 执行添加黑名 单 IP 点击 命令按钮 On Delclicked 执行删除黑名 单 IP 点击 2 2 窗口事件列表 窗口事件列表 事件名 事件 类型 事件功能描述事件算法逻辑 无 3 窗口函数列表 窗口函数列表 函数名 函数类型 全局 窗口 函数功能描述函数算法逻辑 Add List 窗口添加屏蔽黑名单信息 将用户输入的 IP 添 加至列表 Del List 窗口删除屏蔽黑名单信息 删除选定信息 4 1 3上线提示模块 编号 模块名称 上线提示 模块代号 适用范围 全局 局部 类型 窗口 函数 用户对象 模块功能 上线提示可以设置用户上线的时候是否提示其他用户你上线了 用户 有是 否两个选择 作者周扬编写时间修改人 修改时间修改批准人修改次数 概要设计说明书 8 性能要求 对精度 灵活性 时间特性等的要求 限制条件 已经上线的用户 输 入 勾选或者取消上线提示复选框 输 出 对其他用户提示该用户上线或不提示 算法逻辑 1 由该用户机向所有其他在线用户广播消息 具体参见消息群发系统 算法 相关对象 及接口 无 备注 无 窗口对象说明表 窗窗 口口 对对 象象 说说 明明 表表 编号 窗口名 IDD Setting 说明书编号 1 1 窗口对象控件列表 窗口对象控件列表 对象类型对象名称对象事件对象功能描述 用户使用 控制 复选框 IDC CHECK1Check 是否对用户上 线提示 勾选与否 命令按钮 On Submitclicked 提交点击 概要设计说明书 9 On cancelclicked 取消点击 2 2 窗口事件列表 窗口事件列表 事件名 事件 类型 事件功能描述事件算法逻辑 无 3 窗口函数列表 窗口函数列表 函数名 函数类型 全局 窗口 函数功能描述函数算法逻辑 Save Setting 窗口将设置保存至文件 使用文件操作相关 函数保存 4 2 用户扫描的设计说明用户扫描的设计说明 模模 块块 详详 细细 设设 计计 说说 明明 表表 编号 模块名称用户扫描模块代号 适用范围全局类型窗口 模块功能 用户扫描模块扫描局域网 并将在线用户显示在列表中 在软件打开 时 自动调用该模块扫描 根据本机 IP 扫描本 IP 段 并可以随时进 行刷新 还能够自己确定所需扫描 IP 段起始地址进行扫描 作者傅泽华编写时间修改人 修改时间修改批准人修改次数 性能要求 限制条件流程方法 流程节点维护好 输 入所需扫描 IP 起始地址 点击扫描按钮 概要设计说明书 10 输 出将在线用户的 IP 主机名 用户名显示在列表中 算法逻辑 若用户自行填写所需 IP 的起始地址 可缺省 并点击扫描按钮 则 1 首先判断输入框是否为空 若是 则跳到第三步 若否 则检查 所输入的 IP 是否在一个网段上 2 如果不在一个网段 提示用户 IP 不在一个网段上 仍旧扫描该网 段 系统循环向输入的 IP 地址段的 IP 发送消息 然后跳到第四 步 3 如果在一个网段上 系统循环向输入的 IP 地址段的 IP 发送消息 根据返回消息判断用户是否在线 如果用户在线 则将该 IP 地址 的计算机名 和 IP 地址显示在列表中 相关对象 及接口 无 备注无 窗口对象说明表 窗窗 口口 对对 象象 说说 明明 表表 编号 窗口名 IDD MYQQ DIALOG 说明书编号 1 1 窗口对象控件列表 窗口对象控件列表 对象类型对象名称对象事件对象功能描述 用户使用 控制 列表控件IDC USER LISTdouble clicked 打开对所选用 户聊天的对话 框 概要设计说明书 11 right clicked 打开对所选用 户操作的可选 菜单 菜单功 能有是否屏蔽 该用户 发起 与该用户的对 话 查看该用 户个人资料和 是否进行上线 提示 编辑框 IDC EDIT IP modified 编辑扫描的 IP 起始地址 IDC SCAN BUTT ON clicked 对所输入的 IP 段进行扫描 若输入为空则 默认扫描本 IP 段 并将在线 用户显示在用 户列表 IDC USER LI ST 中 按钮 IDC REFRESH BU TTON clicked 刷新当前 IP 段 并将刷新后的 在线用户显示 在用户列表中 IDC USER LI ST 静态文本 IDC USER NUM 无 显示当前在线 用户个数 2 2 窗口事件列表 窗口事件列表 事件名 事件 类型 事件功能描述事件算法逻辑 概要设计说明书 12 close 系统 释放所用的数据存储 open 系统 接收参数 获得当前 操作员所保存的评审 方法信息 并恢复在 评审方法数据窗口中 3 窗口函数列表 窗口函数列表 函数名 函数类型 全局 窗口 函数功能描述函数算法逻辑 OnInitDialog 窗口初始化表格列名 OnPaint 窗口画出用户列表的表单 4 3 在线交流的设计说明在线交流的设计说明 模模 块块 详详 细细 设设 计计 说说 明明 表表 编号 模块名称在线交流模块代号 适用范围全局类型窗口 模块功能 用户双击在线用户列表中的一项 然后弹出一个对话框 在该对话框 中与指定用户进行交流 该交流窗口可显示指定用户的个人资料 可 以清屏 可以显示与该用户的历史聊天记录 可直接关闭 作者傅泽华编写时间修改人 修改时间修改批准人修改次数 性能要求 限制条件流程方法 流程节点维护好 概要设计说明书 13 输 入双击在线用户列表中的一项 输入消息内容并点击发送按钮 输 出在对话框中的消息记录中显示聊天记录 算法逻辑 在线交流在双击在线用户列表中的一项后 弹出一个对话框 1 在对话框中输入需要发送的消息内容 点击发送按钮 2 消息将会在对话框中的消息记录里面显示 我在 时间 说 对方接受到消息后 如果还没有打开与发送端机器的对话 则重 新打开一个对话框 并将消息显示在对话框的消息记录里面 否 则 直接在消息记录中增加接收到的消息 消息记录为 计算 机名 IP 地址 在 时间 说 相关对象 及接口 无 备注无 窗口对象说明表 窗窗 口口 对对 象象 说说 明明 表表 编号 窗口名 IDD CHARTING DIALOG 说明书编号 1 1 窗口对象控件列表 窗口对象控件列表 对象类型对象名称对象事件对象功能描述 用户使用 控制 概要设计说明书 14 列表控件IDC SHOW LIST无 显示用户聊天 记录 当前本 机用户记录格 式为 我在 时间 说 对方 用户记录格式 为 计算机名 或者昵称 IP 地址 在 时间 说 编辑框 IDC CHART EDIT modified 编辑用户发送 消息内容 IDC SEND BUTT ON clicked 发送所编辑的 消息 并将其 显示在聊天记 录 列表中 IDC SHOW L IST IDC CLOSE BUTT ON clicked 关闭当前的消 息对话框 IDC SHOWNOTES BUTTON clicked 打开一个新窗 口并在新窗口 中显示本机用 户与该选中用 户的历史聊天 记录 按钮 IDC CLEAR BUTT ON clicked 清除聊天记录 列表中 IDC SHOW L IST 的全部聊 天记录 静态文本 IDC NAME STATI C 无 显示聊天对象 的昵称 概要设计说明书 15 IDC SEX STATIC 无 显示聊天对象 的性别 IDC PCNAME STA TIC 无 显示聊天对象 的主机名称 IDC IP STATIC 无 显示聊天对象 的 IP 地址 IDC ADDITION S TATIC 无 显示聊天对象 的个人说明 2 2 窗口事件列表 窗口事件列表 事件名 事件 类型 事件功能描述事件算法逻辑 close 系统 释放所用的数据存储 open 系统 接收参数 获得当前 操作员所保存的评审 方法信息 并恢复在 评审方法数据窗口中 3 窗口函数列表 窗口函数列表 函数名 函数类型 全局 窗口 函数功能描述函数算法逻辑 OnInitDialog 窗口初始化表格列名 OnPaint 窗口画出用户列表的表单 概要设计说明书 16 4 4 消息群发模块消息群发模块 编号 模块名称 消息群发 模块代号 适用范围 局部 类型 窗口 函数 模块功能向所有在线用户发送消息 作者杨凯编写时间修改人 修改时间修改批准人修改次数 性能要求 对精度 灵活性 时间特性等的要求 限制条件 已经上线的用户 输 入 用户将要发送的消息 输 出 将消息发送并显示 算法逻辑依次向每个用户发送消息 相关对象 及接口 备注 窗窗 口口 对对 象象 说说 明明 表表 编号 概要设计说明书 17 窗口名 IDD sendall 说明书编号 1 1 窗口对象控件列表 窗口对象控件列表 对象类型对象名称对象事件对象功能描述 用户使用 控制 编辑框 m editsend 无 输入想发送的 消息 点击 编辑框 m editprint 无 显示发送的消 息 On sendclicked 执行发送点击 命令按钮 On closeclicked 关闭窗口点击 2 2 窗口事件列表 窗口事件列表 事件名 事件 类型 事件功能描述事件算法逻辑 无 3 窗口函数列表 窗口函数列表 函数名 函数类型 全局 窗口 函数功能描述函数算法逻辑 Sendall 窗口发送消息 Send print 窗口显示发送的消息 概要设计说明书 18 4 5 消息记录模块的设计说明消息记录模块的设计说明 4 5 1消息查询模块 模模 块块 详详 细细 设设 计计 说说 明明 表表 编号 模块名称消息查询模块代号 适用范围全局类型对话框 模块功能用于查询消息记录及浏览消息记录 作者杨凯编写时间修改人 修改时间修改批准人修改次数 性能要求 限制条件流程方法 输 入所查询的计算机名称或者日期范围 输 出查询出来的消息记录 算法逻辑1 显示异常信息 2 接受输入里所选定的计算机名称或日期区间 相关对象 及接口 备注 窗口对象说明表 窗窗 口口 对对 象象 说说 明明 表表 编号 概要设计说明书 19 窗口名w chatview说明书编号 1 1 窗口对象控件列表 窗口对象控件列表 对象类型对象名称对象事件对象功能描述 用户使用 控制 IDC EDIT1 无显示聊天记录 编辑框 IDC EDIT2 选中 接受输入日期 区间 IDC STATIC1 无 提示用户选中 所要查看聊天 记录的计算机 名 静态文本 框 IDC STATIC2 无 提示用户输入日 期的格式 IDC BUTTON1 ckicked 翻到上一页 IDC BUTTON2 ckicked 翻到下一页 IDC BUTTON3 ckicked 按日期查询 聊天记录 IDC BUTTON4 ckicked 关闭对话框 命令按钮 IDC BUTTON4ckicked 删除当前页聊 天记录 2 2 窗口事件列表