基于Web聊天系统的设计与实现-概要设计说明书

计计 算算 机机 学学 院院 基于基于 WebWeb 聊天系统的设计与实现聊天系统的设计与实现 概要设计说明书概要设计说明书 学学 生生 姓姓 名名： 组组 号号： 4141 年年级级班班级级：2 20 01 13 3级级应应用用 3 3、4 4班班 指指导导教教师师：刘刘魁魁 ( (教教师师 ) ) 所所在在学学院院：计计算算机机学学院院 提提交交日日期期：2 20 01 15 5年年 1 12 2月月 9 9日日 目目 录录 论文总页数：页 1. . 引言引言.1 1.1. 编写目的.1 1.2. 背景概述.1 1.3. 术语.3 1.4. 参考资料.3 2. . 总体设计总体设计.4 2.1. 系统功能结构.4 2.2. 运行环境.4 2.2.1. 硬件环境.4 2.2.2. 软件环境.4 2.3. 系统的关键技术.5 3. . 构件设计构件设计.5 3.1. 构件列表.5 3.2. 构件集成说明.5 3.3. 构件 01.6 3.3.1. 功能模块列表.6 3.3.2. 功能模块 01.6 3.3.3. 功能模块 2.8 3.4. 构件 02.9 3.4.1. 功能模块列表.9 3.4.2. 功能模块 01.10 3.4.3. 功能模块 02.11 3.4.4. 功能模块 03.12 3.5. 构件 03.13 3.5.1. 功能模块列表.13 3.5.2. 功能模块 01.13 3.5.3. 功能模块 02.14 4. . 接口设计接口设计.15 4.1. 外部接口 .16 4.1.1. 数据库接口.16 4.2. 内部接口 .16 4.2.1. 构件内部模块接口.16 4.2.2. 传输文件接口.16 4.3. 用户接口 .17 4.3.1. 键盘、鼠标输入接口.17 5. . 数据库设计数据库设计.17 5.1. 数据库逻辑设计 .17 概要设计说明书 第 1 页 共 22 页 5.2. 数据库物理设计 .17 6. . 系统出错处理系统出错处理.18 6.1. 出错信息 .18 6.2. 补救措施 .18 6.3. 系统维护设计 .19 概要设计说明书 第 2 页 共 22 页 1.1. 引言引言 .编写目的编写目的 本文档的编写是为了说明系统模块的划分、选择的技术路线等，整体 说明软件的实现思路，并且需要指出关键技术难点等。使系统开发人员能 够在了解了系统的设计需求之后能够对软件的基础结构和数据结构有一定 的认识，建立一定的开发框架、明确数据库的设计基准。 .背景背景概述概述 1) 待开发软件名称： 网页聊天系统 2) 软件背景： 21 世纪将是网络化、信息化的世纪，信息的融合已经成为社会发 展的主流方向。即时消息系统将不断与信息交流领域的系统相互集成和 渗透，扩展其自己的功能和应用范围，满足未来话音，数据和视频的多 媒体应用需要，使即时消息以更丰富的接入方法，更高的服务质量，更 友好的面貌呈现在世人的面前。 从功能角度来看，即时消息系统向支持全媒体方向发展，随着多媒 体技术在网络应用中的发展，即时消息系统承载的媒体，不再局限于原 来的文字、语音和文件的信息交换，信息载体扩展到图形、图像和流媒 体等多媒体业务上。目前 ICQ 和 QQ 预设了部分简单的表情图像， 通过 传输图像代码来传递表情图像，可以被视为即时消息开发商开发支持图 形、图像为载体的即时消息软件的开端。 从应用范围角度来看，即时消息系统集中在 Internet 个人用户之间 的信息交流应用，随着网络技术应用的发展，即时消息系统应用范围向 园区化、集团化拓展，应用领域突破个人，而用于远程教学、远程医疗、 远程演示、网络会议等领域。 3) 软件功能描述： 用户通过网页登陆账号，利用服务器转发实现一对一和一对多聊天。 用户成功登陆之后可以添加好友、删除好友、查找好友，能够查看好友 的登陆状态和好友资料以及聊天记录，并且可以选择是否保存用户的账 号，便于下一次登陆；新消息来到时会将消息会话自动置顶并且有红点 显示和声音提示，查看消息后红点消失，用户可以通过设置界面改变消 息的提醒方式；在聊天窗口可以向对方发送文字、图片和表情这些信息， 并且在每一条聊天记录之前会显示发送时间；用户可以申请新的账号、 可以创建多人聊天的群组，创建者默认为管理员，管理员管理所有申请 概要设计说明书 第 3 页 共 22 页 加入群组的请求，最后可以解散群组，所有成员自动退出。聊天室的特 点就是要求能够实时显示出聊天者所谈的内容。即在同一个聊天室的使 用者，可以在短时间内立刻看到其他聊天者的发言。作为用户喜欢的 Web 应用程序，除了具有能够实时显示出聊天者所谈论的内容外，还 应具有以多种方式发布信息的功能。JSP 正好可以满足聊天室的这种要 求，它可以快速地创建和显示 Web 页面的动态内容。总的来说，本聊 天室主要实现了以下的功能： 用户输入帐号,密码登录聊天室 可以创建群组，多人聊天 可以添加、删除好友 更改个人资料及系统设置 把用户的聊天信息写入数据库 多人共同聊天 语言过滤功能，避免一些敏感词汇 显示当前聊天客户列表 显示聊天室人员变动信息（进入聊天室、离开聊天室等） 聊天系统接收实时消息 退出下线 3) 软件应用描述：系统具有系统管理以及事务处理功能，能对用户的 聊天记录和输出进行有效管理；系统有一定的数据安全策略，能够有效的 管理用户数据以及用户的账号安全。在整个系统的框架下，结合网页与服 务器端的实际情况，实现对用户数据进行实时更新、查询、统计以及分析； 软件提供用户友好的接口，满足用户日常使用需求。 .术语术语 术语、缩略语术语、缩略语解解 释释 MVC 模式视图控制器模式 迭代器一种方法顺序访问一个聚合堆箱的各个元素 桩模块软件测试技术的一种，主要用在单元测试阶段 Session Session 是服务器端实用的一种记录客户端状态的机制 URL 统一资源定位符 HTTP 超文本传输协议 TCP/IP 传输控制协议/网间协议 UDP 数据包协议 概要设计说明书 第 4 页 共 22 页 表 1-3 术语和缩略语 .参考资料参考资料 1王红梅,胡明,王涛.数据结构.清华大学出版社,2005.7 2Y.Daniel Liang.Java 语言程序设计.机械工业出版社,2009.11 3张海藩.软件工程导论(第五版).清华大学出版社,2008.2 4王珊,萨师煊.数据库系统概论(第四版).高等教育出版社,2006.5 5弗里曼.OReilly：Head First 设计模式(中文版).中国电力出版社, 2.2. 总体设计总体设计 .系统功能结构系统功能结构 网页聊天系统 登陆注册 好 友 聊 天 好友列表 查 看 好 友 资 料 发 起 聊 天 传 输 文 件 系统设置 添 加 好 友 好 友 聊 天 共 享 文 件 查 看 群 资 料 发 起 群 聊 天 群组列表 群 组 聊 天 退 出 群 组 创 建 群 组 图 2-1 系统运行流程图 .运行环境运行环境 .2.1. 硬件环境硬件环境 1）本软件运行对服务器、客户端的硬件要求： 服务器：软件运行需要 Tomcat 服务器的支持。 运行环境：各种主流浏览器例如火狐、谷歌、IE 浏览器等。 客户终端：最低要求 2G 内存的电脑、处理器 1Ghz 以上、 能够运行主流浏览器的操作系统例如：Windows、Mac os、Linux。 2）本软件运行所使用的外围设备，主要包括： 使用者需要用鼠标、键盘等输入设备操作软件，已到达相关的使用 概要设计说明书 第 5 页 共 22 页 目的和便利性。 .2.2. 软件环境软件环境 1) 操作系统 Windows、Mac os、Linux 2) 数据库系统 Oracle 数据库 2) 开发平台及工具 Myeclipse、Java jdk1.6、tomcat 服务器、windows 10 操作系统 4) 通信协议 Tcp/Ip 协议 5) 接口 本软件应用 windows Api 实现对数据库的操作，基于 ODBC 数据库 访问技术 6) 其他软件 网页编辑器：dreamweaver cs6 测试浏览器：IE 内核的 QQ 浏览器 .系统的关键技术系统的关键技术 1）html/css 网页的界面设计 2）jQuery/Ajax/javascript 网页的交互设计 2）Servlet/Jsp 服务器的部署，web 程序的执行 3.3. 构件设计构件设计 .构件列表构件列表 序号序号构件分类构件分类构件名称构件名称依赖关系说明依赖关系说明 01 被封装的功能模块系统用户入口与 02 构件形成约束依赖关系 02 被封装的功能模块点对点聊天与 01 构件形成约束依赖关系 与 03 构件形成共享依赖关系 03 被封装的功能模块多人聊天与 01 构件形成约束依赖关系， 与 02 构件形成共享依赖关系 表 3-1 构件列表 .构件集成说明构件集成说明 1）集成顺序： 概要设计说明书 第 6 页 共 22 页 01 系统用户入口构件先被集成，04 系统自定义设置在 01 之后被集 成，03、04 聊天构件在最后被集成 2）集成的策略： 采用自底向上的集成策略。划分各个模块的优先秩序，确定模块间 的依赖关系，由各个功能模块组成系统的四大构件，联合构件组成一个 完整的系统，最后进行测试与维护。 3）集成就绪准则： 根据划分的软件构件之间的关系，以及构件内部的模块依赖关系， 确定数据流，划分类别和优先级。 4）集成结束准则： 进行集成测试，看各个功能模块是否正常工作符合软件的功能需求， 系统数据流向是否正确，是否村子数据泄露和符合安全性需求。 .构件构件 0101 系统用户入口构件，类别为：被封装的软件功能模块，构件包括：用户登 录模块、用户注册模块。 .3.1. 功能模块列表功能模块列表 构件构件 名称名称 模块模块 编号编号 模块模块 名称名称 对应需求对应需求 功能编号功能编号 所对应所对应 需求功能需求功能 实现实现 优先级优先级 XTYHRK_YHDL_01 用户登录 01 登录高系统用户 入口 XTYHRK_YHZC_02 用户注册 02 注册高 表 3-3-1 模块列表 .3.2. 功能模块功能模块 0101 【模块编号】 XTYHRK_YHDL_01 【功能描述】 用户登录模块用于指定页面为用户提供进入系统的 account 和 password 输入接口，是系统运作的高优先级模块，由系统模块间的约束依赖决定。当用 户按规则输入以后，模块会接入数据库验证账号和密码，并且提供一定的安全 保证策略，包括：登录验证码、防止用户直接输入地址访问相应页面、对登录 密码进行 cookie 存储加密。只有在用户登录之后才能进行进一步的操作。 【前置条件】 数据库中已经存在用户账号数据，否则需要用户手动调用用户注册模块进 行相关数据的录入和存储。 概要设计说明书 第 7 页 共 22 页 【操作者】 已经注册用户。 【界面】 图 3-3-2 登录界面 【输入】 1）账号，数据类型：字符型，作用：用户 ID，格式：1-10 位的数字或字 母组合。 2）密码，数据类型：字符型，作用：用户密码，格式：1-10 位的数字或字 母组合。 3）验证码，数据类型：字符型，作用：验证登录，格式：1-10 位的数字或 字母组合。 【处理流程及说明】 流程图： 开始 验证用户名密码是否正确 点击登陆 结束 是 否 输入用户名和 密码 登陆成功 概要设计说明书 第 8 页 共 22 页 图 3-3-2 登录流程 【输出】 1）账号，正常输出数据类型：字符型，异常输出：null，格式：1-10 位 的数字或字母组合如 rzet317。 2）密码：正常输出数据类型：字符型，异常输出：null，格式：1-10 位 的数字或字母组合如 RZet317。 3）验证码：正常的输出数据类型：字符型，异常输出：null，格式 4 位的 字母和数字组合如 RZET317。 .3.3. 功能模块功能模块 2 2 【模块编号】 XTYHRK_YHZE_02 【功能描述】 用户注册模块用于为新用户建立账号数据存储，是系统运作的高优先级模 块，由系统模块间的约束依赖决定。当用户按规则输入注册信息以后，模块会 接入数据库验证账号是否已经存在，如果不存在则创建账号成功，并跳转到登 录界面，否则要求用户更改要注册的账号信息，并重新进行验证。 【前置条件】 数据库中已经不存在用户账号数据，否则不能创建注册信息。 【操作者】 未注册用户。 【界面】 图 3-3-3 注册界面 【输入】 概要设计说明书 第 9 页 共 22 页 1）账号，数据类型：字符型，作用：用户 ID，格式：1-10 位的数字或字 母组合。 2）密码，数据类型：字符型，作用：用户密码，格式：1-10 位的数字或 字母组合。 【处理流程及说明】 流程图： 开始 验证用户名密码是否正确 点击注册 结束 是 否 输入用户名和 密码 注册成功 图 3-3-3 注册流程 【输出】 1）账号，正常输出数据类型：字符型，异常输出：null，格式：1-10 位 的数字或字母组合如 rzet317。 2）密码：正常输出数据类型：字符型，异常输出：null，格式：1-10 位 的数字或字母组合如 RZet317。 .构件构件 0202 点对点聊天构件，类型为多个模块的封装，包括好友聊天模块、点对点传 输模块、添加好友模块。 .4.1. 功能模块列表功能模块列表 构件构件 名称名称 模块模块 编号编号 模块模块 名称名称 对应需求对应需求 功能编号功能编号 所对应所对应 需求功能需求功能 实现实现 优先级优先级 点对点聊天 DDDLT_HYLT_01 好友聊天 01 消息传送中 点对点聊天 DDDLT_DDDCS_02 点对点传输 02 文件传输低 概要设计说明书 第 10 页 共 22 页 点对点聊天 DDDLT_TJHY_03 添加好友 03 添加好友中 表 3-4-1 模块列表 .4.2. 功能模块功能模块 0101 【模块编号】 DDDLT_HYLT_01 【功能描述】 好友聊天模块可以向指定的好友发起聊天，是系统运作的中优先级模块， 优先级由系统模块间的约束依赖决定。当用户选择要单独聊天的好友之后，模 块会接入数据库，并与好友建立消息通道，同时通过数据库彼此可以查看对方 的资料。 【前置条件】 聊天双方已经建立好友关系，数据库中有资料记录。 【操作者】 已经登录用户。 【输入】 1）聊天信息，数据类型：字符型/jpeg 图片，作用：聊天沟通，格式：数 字或字母或是图片组合。 【处理流程及说明】 流程图： 概要设计说明书 第 11 页 共 22 页 开始 发起或接受好友聊天 发送或接收好友消息是否成功 结束 否 是 结束好友聊天 发送或接收好 友消息 发送、接收好 友消息失败 待发送或待接 收好友消息 图 3-4-2 好友聊天 【输出】 1）好友资料，数据类型：字符型/jpeg，作用：确定好友信息，格式：字 母和数字的组合。 2）消息回复，数据类型：字符型/jpeg，作用：好友消息，格式：字母， 数字，图片的组合。 .4.3. 功能模块功能模块 0202 【模块编号】 DDDLT_DDDCS_02 【功能描述】 点对点传输模块可以向指定的好友发送文件，是系统运作的低优先级模块， 优先级由系统模块间的约束依赖决定。当用户选择要发送文件的好友之后，模 块会与好友建立通信通道，对方接受后即可接收好友的文件。 【前置条件】 传送双方已经建立好友关系，数据库中有资料记录。 【操作者】 已经建立好友关系的用户。 【输入】 概要设计说明书 第 12 页 共 22 页 1）文件，数据类型：二进制字节流，作用：信息载体，格式：text/doc 等 【处理流程及说明】 开始 在好友聊天窗口中 点击传输文件 选择需要传 输的文件 确认传输 好友是否接受传输请求 传输完成 正在传输传输失败 结束 否是 图 3-4-3 好友传输文件 【输出】 1）文件，数据类型：二进制字节流，作用：信息载体，格式： text/pdf/doc 等类型文件。 .4.4. 功能模块功能模块 0303 【模块编号】 DDDLT_TJHY_03 【功能描述】 添加好友模块可以允许用户添加好友，当用户搜索要添加的好友之后，可 以查看资料并与其建立好友关系，同时数据库存入好友数据。 【前置条件】 双方均已经在系统中注册。 【操作者】 已经登录用户。 【输入】 1）好友账号，数据类型：字符型，作用：查找依据，格式：1-10 为的数 概要设计说明书 第 13 页 共 22 页 字或字母组合。 【处理流程及说明】 开始 输入用户信息 查找用户 是否成功 提示查找失败显示用户数据 添加好友 是否通过请求 结束 否 是 否 是 添加好友失败添加好友失败 图 3-4-3 好友传输文件流程 【输出】 1）好友资料，数据类型：字符型，作用：确定好友信息，格式：字母和数 字的组合。 .构件构件 0303 多人聊天构件，类型为多个模块的封装，包括群组聊天模块和创建群组模 块。 .5.1. 功能模块列表功能模块列表 构件构件 名称名称 模块模块 编号编号 模块模块 名称名称 对应需求对应需求 功能编号功能编号 所对应所对应 需求功能需求功能 实现实现 优先级优先级 多人聊天 DRLT_QZLT_01 群组聊天 01 消息传送中 多人聊天 DRLT_CJQZ_02 创建群组 02 群创建中 表 3-3-1 模块列表 概要设计说明书 第 14 页 共 22 页 .5.2. 功能模块功能模块 0101 【模块编号】 DDDLT_HYLT_01 【功能描述】 群组聊天模块可以在群聊天室中发起多人聊天，是系统运作的中优先级模 块，优先级由系统模块间的约束依赖决定。当用户进入群组轴，模块会接入数 据库，个人发送的消息会发布在群聊天界面，每个成员进入群组聊天界面后都 可以接受消息，同时通过数据库彼此可以查看群组的资料。 【前置条件】 向群组发起聊天的人必须先加入群组，数据库中有资料记录。 【操作者】 已经加入群组的用户。 【输入】 1）聊天信息，数据类型：字符型/jpeg 图片，作用：聊天沟通消息，格式： 数字或字母或是图片组合。 【处理流程及说明】 流程图： 开始 发起或接受群聊天 发送或接收群消息是否成功 结束 否 是 结束群聊天 发送或接收群 消息 发送、接收群 消息失败 待发送或待接 收群消息 概要设计说明书 第 15 页 共 22 页 图 3-5-2 群聊天流程 【输出】 1）群组消息，数据类型：字符型/jepg 图片，作用：聊天沟通信息，格式： 字母或数字或图片的组合。 .5.3. 功能模块功能模块 0202 【模块编号】 DRLT_CJQZ_02 【功能描述】 创建群组模块可以允许使用者创建群组，是系统运作的中优先级模块，优 先级由系统模块间的约束依赖决定。当用户输入群的基本信息，模块会接入数 据库，群组信息会被存入数据库，创建者默认为管理员，管理员可以邀请用户 加入群组。 【前置条件】 用户必须先登录。 【操作者】 已经登录的用户。 【输入】 1）群资料，数据类型：字符型，作用：描述群的信息，格式：数字或字母 的组合。 【处理流程及说明】 概要设计说明书 第 16 页 共 22 页 开始 输入群资料 核对资料格式 是否正确 群创建成功 添加群成员 是否通过请求 结束 否 是 否 是 添加群成员失败添加群成员成功 图 3-5-3 创建群组流程 【输出】 1）群资料，数据类型：字符型，作用：描述群的信息，格式：数字或字母 的组合。 2）创建者账户，数据类型：字符型，作用：添加群管理员信息，格式：数 字或子母的组合。 4.4. 接口设计接口设计 构件名称构件名称 接口编接口编 号号 接口名称接口名称接口类型接口类型说明说明 01 注册账号数据库接口外部注册账户时需要与数据库连接 02 登录账号数据库接口外部登录账户时需要与数据库连接 03 鼠标、键盘输入接口用户用户向系统输入控制信息 系统用户入口 04 构件内部模块间接口内部模块之间的连接 05 添加好友数据库接口外部添加好友时需要与数据库连接 点对点聊天 06 查看好友资料数据库接口外部查看好友时需要与数据库连接 概要设计说明书 第 17 页 共 22 页 07 传输文件接口内部传输文件时与好友建立连接 08 鼠标、键盘输入接口用户用户向系统输入控制信息 09 构件内部模块之间的接口内部模块之间的连接 10 创建群组数据库接口外部创建群组时需要与数据库连接 11 构件内部模块之间的接口内部模块之间的连接 12 群组资料数据库接口外部查看群资料时需要与数据库连接 多人聊天 13 鼠标、键盘输入接口用户用户向系统输入控制信息 表 4-1 构件接口列表 4.1.外部接口外部接口 .1.1. 数据库接口数据库接口 接口名称接口名称数据库接口 接口说明接口说明与数据库建立连接，向数据库读取或写入数据 数据来源数据来源内部模块 调用者调用者内部模块 输入输入数据库语句 输出输出数据库中表的数据项 调用方式说明调用方式说明执行数据库语句 表 4-2 数据库接口说明 4.2.内部接口内部接口 .2.1. 构件内部模块接口构件内部模块接口 接口名称接口名称构件内部模块接口 接口说明接口说明模块之间的衔接 数据来源数据来源各个内部模块 调用者调用者各个内部模块 输入输入连接时传输的参数 输出输出连接时传输的参数 处理流程处理流程用户执行功能模块，模块之间通过接口协同工作 表 4-2-1 构件内部模块接口说明 .2.2. 传输文件接口传输文件接口 接口名称接口名称传输文件接口 接口说明接口说明用与用户之间文件的传输 数据来源数据来源用户的本地磁盘 调用者调用者用户 输入输入文件 输出输出文件 处理流程处理流程用户通过接口建立数据传输通道传输文件 概要设计说明书 第 18 页 共 22 页 表 4-2-2 传输文件接口说明 4.3.用户接口用户接口 .3.1. 键盘、鼠标输入接口键盘、鼠标输入接口 接口名称接口名称键盘、鼠标输入接口 接口说明接口说明用户向系统传递控制信息 数据来源数据来源键盘、鼠标 调用者调用者用户 输入输入键盘、鼠标的控制信号 输出输出字符和控制信息 处理流程处理流程用户通过键盘、鼠标向系统输入数据和控制信息来调用系统功能模块 表 4-3-1 键盘、鼠标输入接口说明 5.5. 数据库设计数据库设计 5.1.数据库逻辑设计数据库逻辑设计 用户1用户2 用户群 消息 群消息 好友MN 属于 M N 发送1 N 收发N1 账号用户昵称 账号 用户信息在线状态 密码 好友账号 编号发送人账号 接收人账号内容 发送时间 群账号 群用户账号 创建时间 群信息创建人账号 群账号 群名称 群账号发送人账号 发送时间内容 已接收群消息 群成员账号 表 5-1 数据库实体关系 ER 图 5.2.数据库物理设计数据库物理设计 序号属性含义类型长度 1Account 账号 Varchar10 2Password 密码 Varchar10 3Name 用户昵称 Var