聊天室设计报告

网网 络络 聊聊 天天 系系 统统 设设 计计 报报 告告 组长 靳子豪 组员 冯凯强 许玉军 王明 明 完成时间 2015 年 11 月 3 日 一 可行性研究报告一 可行性研究报告 可行性研究报告可行性研究报告 ISO 标准标准 编者说明 在立项时 应该对项目进行综合分析 探讨项目的经济 社会 技术可行性 从而为 决策提供基础 该模板为 ISO 标准文档模板 其不仅适用于软件项目 对于其它的系统项 目也适用 1 引言 1 1 编写目的 该聊天室项目可行性研究报告是对项目课题的全面考虑 是项目分析员对下一步工作 进行的前提 是软件开发人员正确成功开发项目的前提与基础 写可行性研究报告可以使 软件开发团体尽可能早的估计研究课题的可行性 较早的认识到系统方案的缺陷 可以少 花时间和精力 也可减少成本资金 避免专业性的问题 1 2 背景 a 待开发系统的名称 信息交流系统 b 用户 大众 c 它基于 web 小浏览器的程序系统的设计与开发 服务平台 appserv win 开发语言 PHP 数据库 MY SQL 1 3 定义 技术可行性 分析功能 性能以及限制条件 能否是一个技术上可实现的系统 经济可行性 估计开发费用已及最终从开发成功的系统所获得的收入或利益 衡量 比较支出的费用和收到的利益 1 4 参考资料 软件工程导论 第 6 版 清华大学出版社 张海藩 牟永敏 编著 可行性研究的前提 2 1 要求 a 聊天室功能 用户的聊天功能 包括数据输入 修改 删除 并要达到界面美观又好 使用方 便 b 软件的性能 开发该软件应具有的基本要求与功能是实现用户信息数据包括与用户有关的数据 的管理与操作处理 基于 MY SQL 的数据库的数据管理使该软件有更优异的性能 软件的基本数据流动为用户数据的输入 用户信息及数据的输出 c 输出 用户基本信息和聊天内容 d 输入 用户根据自身需要 发起聊天 e 安全保密方面的要求 设置管理员 2 2 目标 该软件的设计目标必须尽量达到人力与设备费用的节省 软件的整个设计过程必须 通过生产能力的提高 人员工作效率的提高等等使软件开发成本最小化 2 3 条件 假定和限制 a 本聊天室建议使用寿命为 5 10 年 b 法律方面的限制 1 严禁危害国家信息安全 2 严禁损害国家荣誉和利 益 3 严禁传播不良信息 5 严禁抄袭 2 4 进行可行性研究的方法 成本效益分析 对估算问题的看法 软件的作用范围 软件的成本估算 速度安 排 3 对现有系统的分析 3 1 处理流程和数据流程 该系统的数据处理与流程基本为用户数据录入与查询 管理员删除等 流程图如 下 图 1 处理流图 3 2 人员 鉴于该系统的技术含量比较低 故不需要高技术人才 3 3 设备 设备的科技含量也比较低 没有达到计算机大量普及的地步 3 4 局限性 经研究分析 可知原有的系统存在很大的局限性 比如技术过于陈旧 人员工作负 荷大 系统维护方面存在很多局限性 4 所建议的系统 4 1 对所建议系统的说明 网络聊天室主要是用户的聊天功能 包括数据和文本的传输 修改 删除等功能 要能高效 准确地完成这个功能 使使用方便 4 2 处理流程和数据流程 如下所示 查看聊天记录 增加用户 删除用户 回复 发言 发信息 用户管理 普通用户管理 管理员管理 管 理 员 聊天室 服 务 器 单用户 a单用户 b 管理用户 更改密码 删除记录 图 2 处理流图 4 3 技术条件方面的可能性 以现有的技术与开发人员的数量和质量条件下 可在规定的期限内完成该系统 的开发 5 投资及效益分析 5 1 支出 5 1 1 基本建设投资 房屋和设备 3 万 环境保护设备 1 万 安全与保密设备 1 万 数据库管理软件 1 万 5 1 2 其他一次性支出 研究费用 3 万 数据库建立 1 5 万 开发人员一次性支出 5000 元 5 1 3 非一次性支出 设备维护费用 1000 元 软件维护 100 元 人员工资 2000 元 房屋 水电费 500 元 网络杀毒软件 100 元 5 2 收益 5 2 1 一次性收益 运行效益 3 万 应用系统价值的增值引起的收益 5 万 设备出售回收的收益 5000 元 5 2 2 非一次性收益 系统维护 2000 元 6 社会因素方面的可能性 6 1 1 严禁危害国家信息安全 泄露国家秘密 2 严禁损害国家荣誉和利益 3 严 禁传播不良信息 5 严禁抄袭 6 2 经过管理员的同意者可以使用 7 结论 经过各方面的可行性分析 各成员对需要解决的问题取得基本一致看法 开发方案得 到批准 开发工程继续进行下去 二 需求规格说明书二 需求规格说明书 需求规格说明书需求规格说明书 ISO 标准版标准版 编者说明 当需求调查 分析工作告一段落时 你就需要将这些需求进行规格化描述 整理成文 即软件需求规格说明书 也就是 SRS 这是在软件项目过程中最有价值的一个文档 ISO 所提供的标准虽然已经时间久远 但还是颇具参考价值的 1 引言 1 1 编写的目的 随着互联网的迅速普及 以及网络技术的不断发展 人们通过网络的交流方式不断发 展 网络聊天室就是其中的一种 聊天室的系统即使交流的方式满足了网络中多人同时交 流的需要 本设计所完成的聊天室具有常用聊天室的所有功能 包括多人在线的同时聊天 两人 间的私密聊天 在聊天的时候可以发送表情 还能显示在线用户数量 满足了不同人群的 交流方式 1 2 背景 a 待开发系统的名称 聊天室 b 用户 大众 c 它基于 web 小浏览器的程序系统的设计与开发 服务平台 appserv win 开发语言 PHP 数据库 MY SQL 1 3 定义 客户端 服务器 数据设计 数据通信 1 4 参考资料 软件工程导论 第 4 版 张海藩编著 清华大学出版社 软件工程实践导论 有关方法 设计 实现 管理之三十六计 金尊和编著 清华大 学出版社 实用软件工程 LeszekA Maciaszek Bruc Lee Liong 著 机械工业出版社 2 任务概述 2 1 目标 主要是设计一个基于 WINDOWS 平台的局域网即时聊天工具 利用各种平台上的网络 通信接口 构建基于下层 TCP IP 的原件产品 在局域网内 这些功能的实现跟广域网比较 就很简单 但仍然很有研究价值 2 2 假定和约束 首先程序要完全可靠 可以应付系统问题产生的各种错误 要求前提设想到类似尽 可能多的可能发生的各种事件并做出相应的应对措施 并为用户提供简单易懂清晰明白 的提示信息 程序要有良好的容错性 当用户进行非法操作时或系统本省出现问题时能以最好的 方式退出程序 避免发生假死的现象 3 需求规定 3 1 对功能的规定 用户端之间的信息发送 是本程序实现的基本的功能 显示在线用户的数量 在 C S 模式中 服务器与客户端时相互依赖的 在使用过程中 客户端在指定时间内未 向服务器端发送信息的 服务器认为客户端下线 聊天室具有常用聊天室的所有功能 包括多人在线的同时聊天 两人间的私密聊天 在聊天的时候可以发送表情 还能显示在线用户数量 满足了不同人群的交流方式 用户基本信息和发言内容 用户根据自身需要 发表言论 3 2 对性能的规定 3 2 1 精度 按相关提示输入 3 2 2 时间特性要求 运行的时间 a 登录模块 小于 5 秒 b 在线用户模块 小于 5 秒 c 聊天功能模块 小于 5 秒 d 退出模块 小于 5 秒 响应时间 所有的发送操作响应时间一般不超过 7 秒 大量的信息发送 呈 现应该在提示 10 秒内显示或者提示相关出错信息 更新处理时间 所有提交的数据一般都在 10 秒内相应 3 2 3 灵活性 用户做发出某些控制动作 如按回车键 单击或右击 时 都要相应得到回 复 3 3 输入输出要求 输入 编辑用户的个人信息以及各用户之间的即时聊天内容 输出 显示相应的用户信息以及对相应的用户的聊天内容 3 4 数据管理能力要求 针对软件系统 能及时更新相关的数据库信息 3 5 故障处理要求 聊天记录及配置文件必须按日 按周进行及时的备份 4 运行环境规定 4 1 设备 a 处理器型号 英特尔酷睿 I 3 5 内存容量 2G b 外存容量 8 G c 输入及输出设备的型号 WINDOWS 平台和数量 联机 4 2 支持软件 选择好的操作系统和编程语言是系统优劣的关键 该设计在 Wins 平台下运行 利 用基于服务器的软件 面向对象的可视化软件开发与程序运行 功能强大 开发效率比 较高 它不仅是网络环境下优秀前段开发语言和工具 也是服务器 WEB 编程的优秀工 具 操作系统 wins xp 以及以上的系统 开发工具 appserv win mysql 4 3 接口 a 用户接口 本系统采用图形用户接口 以鼠标和键盘为用户接口 方便用户对系统数据的操 作 b 外部接口 保持一致性 界面规范应遵循 WINDOWS 软件界面的规范 完整的对话过程 系统的每一次通信都有一个明确的次序 有开始到中间处 理过程再到结束 设计良好地联机帮助 画面简介清晰明快 c 硬件接口 支持一般的 pc 机 笔记本电脑 d 软件接口 本产品能在 windows 及以上的系统运行 4 4 控制 a 在用户登录成功后 进入聊天平台主界面 b 通过菜单选择特定的功能模块 c 结束程序运行 三 数据要求说明书三 数据要求说明书 编者说明 如果在你的项目中有大量要求数据存储 数据采集等方面的需求 那么你就应该专门 将这些需求进行整理 以数据要求说明书的形式表现出来 1 引言 1 1 编写目的 目的 明确 php 聊天室 中各项功能和非功能实现时所需要的数据 并可以以此数据为依 据设计数据库 同时为概要设计和详细设计人员提供设计依据 预期读者 参与聊天室开发的同学 1 2 背景 a 待开发系统的名称 交流系统 b 用户 大众 c 它基于 web 小浏览器的程序系统的设计与开发 服务平台 appserv win 开发语言 PHP 数据库 MY SQL 1 4 参考资料 软件工程导论 第 4 版 张海藩编著 清华大学出版社 软件工程实践导论 有关方法 设计 实现 管理之三十六计 金尊和编著 清华大 学出版社 实用软件工程 LeszekA Maciaszek Bruc Lee Liong 著 机械工业出版社 2 数据的逻辑描述 静态数据 所谓静态数据 指在运行过程中主要作为参考数据 他们在很长的一段时间 内不会变化 一般不随运行而改变 动态数据 包括所有运行中发生变化的数据以及在要输入 输出的数据 2 1 静态数据 用户个人信息 管理员信息 2 2 动态输入数据 用户输入的信息 2 3 动态输出数据 输出信息 2 4 数据约定 合法的数据输入范围 3 数据的采集 3 1 要求和范围 1 输入数据的来源 用户的输入信息 2 数据输入所用的媒体和硬设备 键盘 3 接受者说明输出数据的接受者 信息接收用户 4 输入和输出数据形式和硬设备 文字信息 文件信息 5 数据值的范围给出每一个数据元的合法值范围 合理的数据输入范围内 3 2 输入的承担者 此软件没有固定的输入承担者 其输入的相应数据都是由通信用户双方来完成 3 3 预期处理 在这里预处理的数据包括 默认坚挺的服务器 ip 和端口号 以及监听状态的标志 位和数据库名称 3 4 影响 1 设备 2 现有软件 能够运行 MYSQL 3 用户 建议系统使用的新技术是完全基于原有的系统上的 故用户不必考虑系统带来 的人员培训等 4 概要设计概要设计 编者说明 这是 ISO 提供的规范 是最原始的概要设计说明书的编写格式 其适用于结构化设计 思想下的软件设计 不过其中还是有很多具有参考价值的内容 1 引言 1 1 编写目的 本报告以实现聊天室功能为目的 对该系统如何实现各业务环节以及功能如何划分做 了概要性的说明 通过该报告能够使详细设计人员和开发人员了解本系统的体系结构 技 术方案 软件的功能结构 各业务间的数据接口 数据库结构等 并对整个系统的功能实 现按照功能模块进行了较为详细的划分和描述 为下一步的开发任务指明了方向 提出了 纲要 1 2 背景 a 待开发软件系统的名称 交流系统 b 用户 大众 1 3 参考资料 软件工程导论 第 4 版 张海藩编著 清华大学出版社 软件工程实践导论 有关方法 设计 实现 管理之三十六计 金尊和编著 清华大 学出版社 实用软件工程 LeszekA Maciaszek Bruc Lee Liong 著 机械工业出版社 2 总体设计 2 1 需求规定 2 1 1 系统功能 如图 3 图 3 系统功能图 2 1 2 系统性能 2 1 2 1 精度 按相关提示输入 2 1 2 2 时间特性要求 响应时间 所有的发送操作响应时间一般不超过 7 秒 大量的信息发送 呈 现应该在提示 10 秒内显示或者提示相关出错信息 更新处理时间 所有提交数据一般在 10 秒内响应 2 1 2 3 可靠性 该系统应该保证用户信息的安全性 2 1 2 4 灵活性 可以随意更改个人资料 指定人进行私聊 2 1 3 输入输出要求 输入 修改个人资料信息 及发送信息内容 输出 信息修改成功界面 2 1 4 数据管理能力要求 在线聊天平台 用 户 注 册 注 私 聊 显 示 聊 天 信 息 显 示 在 线 用 户 用 户 登 录 陆 群 聊 用 户 退 出 及时更新数据 保证数据的安全可靠 2 1 5 故障处理要求 聊天记录及配置文件必须按日 按周进行及时的备份 2 2 运行环境 2 2 1 设备 开发该系统应尽可能采用高档的硬件 因此 在应用时应采用更好的配置 处理器 酷睿 I5 内存 2G 或更高 网络 局域网 2 2 2 支持软件 操作系统 Windows XP 或 Window2000 2 2 3 接口 外部接口 1 尽量保持一致性 界面规范应遵循 Winows 软件界面的规范 2 设计完整的对话过程 系统的每 d 一次对话都应该有明确的次序 开始 中间处理过程 结束 3 提供简单的错误处理机制 硬件接口 支持一般的 PC 机 笔记本电脑 软件接口 本产品只能在 Windows 2000 及以上 windows 系列操作系统运行 2 2 4 控制接口 a 在用户登陆成功后 进入聊天平台主界面 b 通过菜单选择特定的功能模块 c 结束程序运行 2 3 基本设计概念和处理流程 总体结构 图 4 结构图 聊天室 客户端 服务器 客户端 接收并显示消息 发送消息 显示在线用户 操作流程 如图 5 所示 N Y 图 5 操作流程图 数据流程图 如图 6 所示 注册新账户 新账户信息 资料不 合法 账号密资料 码信息 合法 账号密码 不正确 登陆成功 及用户信息 数据信息 个人资料 资料信息 退出信息 开始 输入用户名和密码选择角色 判断输入 是否正确 进入聊天室 选择聊天对象 结束 登陆注册 登陆注册 资料检查 账号资 料库 用户操作 数据库 查看修改资料 在线用户信息聊天信息 公私聊 图 6 数据流程图 2 5 功能需求与系统模块的关系 如表 1 所示 登陆注册模块聊天模块在线用户模块退出模块 注册 登陆 私聊 公聊 查看聊天记录 选择表情 显示在线好友 修改个人资料 退出聊天平台 表 1 功能需求与系统模块的关系表 2 6 人工处理过程 注册和修改个人资料 2 7 尚未解决的问题 查看个人资料和修改个人资料 发送文件 3 接口设计 3 1 用户接口 提供一个用户操作界面 包括用户可以在界面中登陆聊天室 输入消息 浏览聊 天内容和聊天对象 以鼠标和键盘为用户接口 方便用户对系统数据的操作 4 运行设计 4 1 运行模块组合 客户端 1 登录模块 能够存储一定数量的用户档案信息 并方便有效地进行相应数据操作和管理 主要包 括 1 用户的登录 注册 密码修改 2 管理员登录 注册 密码修改 2 在线用户模块 用户通过该用例对该用户好友进行管理 主要包括 1 显示在线好友 2 查看和修改个人信息 3 聊天功能模块 1 与好友进行即时聊天 2 在聊天室中进行多人聊天 3 好友之间可以进行信息的发送与接收 4 退出模块 1 实现用户退出功能 后台系统 1 系统管理 聊天列表退出平台 聊天内容 对系统进行维护 或添加 删除修改各个功能模块 主要包括 1 系统的维护 2 添加 删除 修改各个功能模块 2 公告管理 向用户进行广播操作 主要包括 1 向用户进行广播宣布系统维护 系统更新 2 向用户发布公共话题或资料 供用户讨论或给大部分用户提供需求资料 3 用户管理 通过管理员对用户进行管理 主要包括 1 系统管理员完成对用户账号的管理 可以添加 删除用户 2 对用户上传的文件进行管理 可以删除 打开或下载文件 4 2 运行控制 在客户端登录后直接进入主界面 结束程序运行 4 3 运行时间 本系统的各个模块之间功能是相互联系的 故各模块占用各种资源的时间是累计的 所以运行时间由用户的操作和网络的运行速度决定 A 登录模块 小于 5 秒 B 在线用户模块 小于 5 秒 C 聊天功能模块 小于 5 秒 D 退出模块 小于 5 秒 5 系统出错处理设计 5 1 出错信息 如表 2 所示 错误原因处理方法 用户没有输入用户名系统提示 请输入登录名称 用户输入的昵称与已登录用户同名系统提示 该名已被使用 发送空语句系统提示 不能发送空语句 表 2 出错信息表 5 2 补救措施 对一般错误 给用户提示信息 让用户重新输入或退出 五 详细设计文档五 详细设计文档 编者说明 概要设计通常是项目中专门的人员完成 是对系统的高层描述 而详细设计的任务则 通常由每一个任务实施人来完成 其是对某个具体的模块 类等局部元素的设计描述 该 模板是 ISO 推荐的格式 其仍然是以结构化设计为主要思想 1 引言 1 1 编写目的 本文档是为了初步明细项目功能模块 便于下一步的代码实现 预期读者 参与聊天室开发的同学 1 2 背景 a 待开发系统的名称 交流系统 b 用户 大众 1 3 定义 SQL SERVER 系统服务器所使用的数据库管理系统 DBMS SQL 一种用于访问查询数据库的语言 事务流 数据进入模块后可能有多种路径进行处理 主键 数据库表中的关键域 值互不相同 外部主键 数据库表中与其他表主键关联的域 ROLLBACK 数据库的错误恢复机制 1 4 参考资料 软件工程导论 第 4 版 张海藩编著 清华大学出版社 软件工程实践导论 有关方法 设计 实现 管理之三十六计 金尊和编著 清华大 学出版社 实用软件工程 LeszekA Maciaszek Bruc Lee Liong 著 机械工业出版社 2 系统的结构 软件结构 1 登录界面 2 主面板 3 用户列表 4 聊天窗口 3 模块 1 标识符 设计说明 3 1 功能 1 注册 注册新账号 用户从申请账号页面填写必要的信息 申请账号 服务器收到注册请求 后 并将用户填写的信息保存至数据库中 2 登录 3 增删用户 3 2 性能 时间特性耍求 响应时间 所有的发送操作响应时间一般不超过 7 秒 大量的信息发送 呈现应该在 10 秒内显示或者提示相关出错信息 更新处理时间 所有提交数据一般在 10 秒内相应 故障处理要求 聊天记录及配置文件必须按日 按周进行及时的备份 精度 按相关提示输入 3 3 输入项 默认扫描当前 IP 段 输入需要发送的消息内容 点击发送按钮 点击是或否按钮或按回 车键 3 4 输出项 在对话框中的消息记录中显示聊天记录 在消息记录中显示聊天记录 3 5 流程逻辑 如图 7 所示 N Y 输入用户名和密码选择角色 判断输入 是否正确 进入聊天室 选择聊天对象 开始 图 7 流程图 3 6 接口 1 登录 输入 用户账号 有数字组成 输出 界面显示 2 注册 输入 注册用户资料 用户名 密码 输出 注册成功界面 3 聊天 输入 聊天信息 输出 好友恢复的信息 4 显示用户列表 输入 用户的登陆信息 输出 显示在线用户 5 资料修改 输入 修改个人资料信息 输出 信息修改成功界面 6 退出 输入 退出命令 3 7 测试计划 一 环境配置测试 1 网络连接是否正常 2 网络流量负担是否过重 3 软件测试平台是否可选 4 如果 3 是否在不同的软件测试平台进行软件测试 5 所选软件测试平台的版本是否正确 6 所选软件测试平台的参数设置是否正确 7 所选软件测试平台上正在运行的其它程序是否会影响测试结果 二 代码测试 静态测试 1 同一程序内的代码书写是否为同一风格 2 代码布局是否合理 美观 3 程序中函数 子程序块分界是否明显 4 注释是否正确反映代码的功能 5 变量定义是否正确 长度 类型 存储类型 6 是否引用了未初始化变量 7 数组和字符串的下标是否为整数 8 数组和字符串的下标是否在范围内 不 越界 4 模块 2 标识符 设计说明 1 注册模块 使用验证控制对部分内容进行验证 将注册的信息存储到已建好的数据库中 若键入的信息不符合要求需重新注册 注册成功后站到登录页面 2 登录模块 已经注册成功的用户 数据库中已经存储其注册信息 输入正确的用户名和 密码后就可以进入聊天室 未注册的系统自动返回注册页面 要求用户进行注册 3 聊天模块 私聊和公聊 结束 4 退出模块 退出该系统 六 软件测试报告六 软件测试报告 软软 件件 测测 试试 报报 告告 项目名称 网络聊天系统 1 安装 1 程序运行环境已