QQ概要设计说明书.docx
《QQ概要设计说明书.docx》由会员分享，可在线阅读，更多相关《QQ概要设计说明书.docx（17页珍藏版）》请在冰豆网上搜索。
QQ概要设计说明书
QQ聊天系统项目
概要设计说明书
第01版
二○○九年六月
版本控制信息
版本
日期
拟稿和修改
说明
01.00
2009-05-28
CZXHY
初稿
01.01
2009-06-15
CZXHY
修订稿
01.02
2009-06-27
CZXHY
最终稿
1范围
1.1标识
QQ聊天系统概要设计说明书（QQS）
1.2系统概述
Ø系统名称：
QQ网络聊天系统（QQS）
ØQQ聊天系统为用户网络聊天交流信息提供一个方便的电子平台。
该系统分用户员注册信息部分和后台系统管理部分。
Ø用户通过向服务器提交信息，在数据库中写入相应的数据。
用户可以根据好友的QQ号码或者是昵称来添加好友，而后选中该好友之后进行聊天功能。
如果对方没有在线，则将内容保存在服务器上，等用户上线之后传送信息。
Ø用户可以对自己的信息进行维护和修改，服务器通过对用户的权限进行验证，修改对应的信息。
该系统的主要用户群是：
（1）聊天者；
（2）服务端管理员。
1.3文档概述
本文档是QQ聊天系统概要设计说明书。
针对系统使用者（用户，服务器后台管理员）的需求，我们将在该文档中对该系统的总体设计、接口设计、运行设计、数据结构设计以及系统出错处理设计进行概述。
本文档是系统详细设计的框架文档。
其他要求及说明见其他文档。
2引用文档
Ø《概要设计模板（国标）》
Ø《QQ聊天系统需求分析说明书》
3总体设计
3.1需求规定
详见系统需求分析说明书。
3.2运行环境
●服务器要求
Ø硬件部分：
处理器主频要求1GHz以上；内存512M（或更高）；VGA视频显示器；标准的鼠标、键盘；兼容印机。
Ø软件部分：
操作系统为Windows各版本操作系统；数据库系统为SQLServer2005企业版.
●客户端要求
Ø硬件部分：
处理器P2,600MHZ（以上）；内存128M（或更高）；显示器。
Ø软件部分：
操作系统为Window98,Window2000，WindowsXP或者WindowsVista系列，浏览器为IE5.0（或更高），或者其它网页浏览器。
3.3基本设计概念和处理流程
3.3.1前台处理流程
前台处理流程图
Y
N
N
Y
N
Y
N
N
Y
Y
3.3.2添加好友
添加好友具体流程图
N
Y
N
Y
N
Y
3.3.3信息修改
用户信息修改流程图
N
Y
N
Y
N
Y
3.3.1聊天模块
3.4软件体系结构
3.4.1用户层次功能模块图
用户的层次功能模块图
3.4.2服务器端层次功能模块图
服务器端功能层次图
3.4.3后台数据库信息维护
3.5系统子模块清单：
对于以上的系统层次功能模块结构图给与综合得以下清单
系统子模块清单
模块编号
模块名称
模块简要说明
QQ01
登录模块
非注册用户注册成为QQ用户；登录系统后，才能够查看个人信息，才能够与好友进行聊天，才能修改个人信息等。
QQ02
注册模块
非用户必须先进行用户的注册，注册时需要填写用户的昵称和性别以及年龄等信息。
填写注册信息后，将相应的数据发送至服务器端的数据库。
QQ03
主界面模块
用户登录后，可以显示出主界面。
主界面会显示当前用户的信息以前在线好友列表。
用户可以通过选择各项操作进行聊天。
主界面下方有其他操作，如：
修改用户信息、添加好友、以及查看系统消息等按钮。
QQ04
添加好友
用户登录后，可以通过主界面中的添加好友按钮添加自己希望的好友。
好友模块中有
QQ05
信息修改模块
用户登录主界面之后，可以根据自己的要求修改自己的用户信息。
通过对用户信息的修改，通知服务器端的数据库，并将信息写入数据库。
QQ06
用户聊天模块
这是该系统的主要功能，主要通过用户点击自己的好友，发送相应的信息进行聊天。
系统首先将信息发送至服务器端，服务器通过判断接收方是否在线，选择向用户发送信息或者保存该信息直至用户上线后发送。
接受方接受信息后可以选择向发送方回复相应的信息。
这个过程与之前发送信息是一样的，这里不再赘述。
QQ07
服务器端信息管理
服务器端有自己的模块，通过管理员可以修改用户的响应信息。
并且通过注册用户之后添加新的用户信息和修改信息。
QQ08
服务器端信息显示
服务器端通过读取数据库中的内容，判断用户的个状态之后，显示当前的各用户状态，尤其是在线用户的显示，。
同时显示当前各信息的个人资料等信息。
3.6功能需求与程序的关系
详见QQ需求分析说明书事件表部分，事件表已明确分划出系统各模块的功能。
3.7尚未解决的问题
Ø通过和现实中拥有的聊天系统进行比较，该系统主要的缺陷是界面的美观问题。
其次便是功能上的缺陷：
只能进行字符消息的传输，其他如图片等文件传输没有实现；还有如信息的维护程度不高，只能有基本的信息记录，具体的信息不能完成；最后就是模块的功能划分不够具体，各模块之间的联系不是很紧密等。
4接口设计
4.1用户接口
说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。
（出错处理部分见该文档的出错处理部分）
Ø注册模块。
用户首先应该进入登录界面，其中就是QQ号码和密码，若未注册过，则应该先进行注册申请号码：
用户注册信息接口设计
信息内容
输入方法
字段类型
会员登陆名
用户输入
Textfield
用户年龄
用户输入
Textfield
性别
用户选择
Radiobutton
密码
用户输入
Password
确认密码
用户输入
Password
登录按钮
用户点击
Button
取消按钮
用户点击
Button
注册成功则跳转到用户登录界面，输入用户名和密码之后进行登录。
失败后则跳出错误信息，然后显示重新注册界面。
Ø登录界面，主要负责会员的登录，输入的信息有：
登录界面输入接口设计
信息内容
输入方法
字段类型
用户名
用户输入
Textfield
用户密码
会员输入
Password
登录按钮
会员点击
Button
取消按钮
会员点击
Button
注册连接
会员点击
link
当登录成功后，登录界面的信息变成欢迎信息。
登录的主界面的接口设计
Ø添加好友模块。
用户可以选择自己需要添加的好友ID号码或者用户名，显示搜索结构，并且选择是否添加好友：
添加好友的接口设计
信息内容
输入方法
字段类型
好友ID
用户输入
Textfield
好友昵称
用户输入
Textfield
搜索按钮
用户点击
Button
退出等
会员点击
Button
搜索结构若没有改好友，显示错误信息，并返回搜索页面。
若查找到指定信息，则显示该好友，用户判断是否加为好友。
Ø用户个人信息修改接口。
修改个人信息的接口设计
信息内容
输入方法
字段类型
用户昵称
用户输入
Textfield
用户密码
用户输入
Textfield
用户性别
用户选择
Textfield
用户年龄
用户输入
Select
Ø搜索结果显示页面，用户点击添加好友之后，会出现选择好友的信息。
用户填完了相应的内容之后，点击搜索按键。
通过搜索服务器端数据库中的内容，查找该好友是否存在。
存在，出现搜索结果界面。
用户可以选择是否添加该用户为好友，选择之后，判断该用户是否在线，服务器选择向用户发送消息。
搜索好友的接口设计
Ø聊天时该系统的主要功能。
用户可以通过右键点击自己的好友，选择查看向改好友发送信息。
并且接受用户发来的信息等，同时可以回复好友信息。
聊天框接口设计
Ø后台管理显示当前系统状态。
当前用户信息状态的接口设计
信息内容
输入方法
字段类型
用户姓名
显示（不能修改）
列表项
用户ID
显示（不能修改）
列表项
用户年龄
显示（不能修改）
列表项
用户性别
显示（不能修改）
列表项
用户在线状态
显示（不能修改）
列表项
4.2外部接口
●与数据库的接口：
系统单独安装在服务器上，数据库与系统放在同一个服务器上，数据库资料要经常由DBA做备份。
4.3内部接口
系统功能模块层次图
系统架构图
5运行设计
5.1运行模块组合
本系统被划为两个模块，分别为前台和后台。
前台是指客户能够操作的部分，例如登录、注册账号以及管理操作和聊天等。
后台是指管理员操作的部分，例如显示当前的在线用户、修改用户信息和添加删除用户信息等。
前台又分为登录模块、注册模块和主界面模块。
登录模块是用户根据自己的用户名和密码登陆系统，注册则是没有注册的用户向服务器发送注册信息，最后的聊天信息是与自己的好友进行聊天。
后台分为信息管理、信息显示以及添加和删除、修改用户信息等。
本系统主要的事务流程都集中在后台。
5.2运行控制
前后台模块间通过数据库和服务器交换信息，数据库是中间层，前台的事件操作或者后台的事件操作直接写或读数据库信息。
前后台用户都可以查询相应的信息。
5.3运行时间
对于系统架构图中的各模块而言，由于需要通过服务器接受和发送信息，所以耗费的时间较长。
具体的时间应根据网络状态以及需要传送的包大小来决定。
6系统数据结构设计
6.1逻辑结构设计要点
●数据库ER模型：
详见需求分析文档（ERD）
Ø数据库表详解：
用户信息（UserData）表
字段名
类型
大小
说明
备注
HostId
char
6
用户ID号
主键
NickName
char
10
用户昵称
Password
char
10
用户设置密码
Age
char
2
年龄
Gender
int
用户性别
Online
bool
用户在线状态
好友列表（Friendship）表
字段名
类型
大小
说明
备注
Id
char
1
用户的ID
主键
HostId
char
6
主机的ID
FriendId
char
6
好友的ID
6.2物理结构设计要点
6.3数据结构与程序的关系
QQ系统的数据库使用分布式数据库，它不但存储了本系统需要使用的数据信息，而且属于本系统的信息也可以被QQ后台系统的其他子系统共享。
同时，QQ在需要的时候还会共享使用其它子系统的数据，所以其数据物理设计方面有以下特点：
Ø数据存储模式与整个分布式数据库系统保持一致，考虑使用相同的SQL
Ø数据库安全策略与分布式数据库保持一致，在考虑自身安全性保护的同时，防止从本站点引起整个系统的数据库安全漏洞。
Ø数据库存储索引结构出了方便本系统使用外，还要考虑其他子系统的使用。
Ø数据库中的内同可供服务端和客户端同时使用，需要考虑其安全性。
7系统出错处理设计
7.1出错信息及补救措施
7.1.1前台会员子系统出错信息和补救措施
Ø用户注册时候，应检查用户输入信息的有效性，例如只许填写数字的地方不能填写其他类型的字符；同时注册时必须要填写所有需要填写的项目。
同时，用户名不能与数据库中的内容重复。
而用户密码必须符合要求，而且两次输入的密码必须一致。
这样才能得到服务器的回复信息，注册成功。
Ø用户修改个人信息时候，应检查会员输入修改后信息的有效性，例如只许填写数字的地方不能填写其他类型的字符；所有的项目是否全部完成，用户的密码是否符合要求以及是否能修改相应的信息等。
若不能完成信息修改的内容，服务器发送错误信息，提示用户重新输入信息或者修改信息以及退出的选择。
Ø用户注册的时候，可以在线检测用户名是否被占用；如果用户无在线检测用户是否被占用，直接提交，如果输入的用户名已经存在，则提交后显示失败信息，如果用户名没有被占用，提交后显示成功信息，并将相应的信息发送给服务器。
服务将用户信息写入数据库中。
Ø用户登陆的时候，如果输入的登陆名在系统不存在，则提示会员名不存在信息；如果输入的密码和会员名不对应，提示密码错误信息。
Ø用户在添加好友时，如果添加的好友对象不存在，则返回错误信息。
用户可以选择重新输入选项或退出添加窗口。
Ø用户在与好友进行聊天时，若该用户下线，会向该用户提供错误信息。
用户同样可以发送信息，但是会保存在服务器端，等到对方上线后将信息发送。
Ø用户登录时，需要先链接到数据库。
所以没有启动服务器或者没有连接网络的话会出现未能连接服务器的提醒。
7.1.2服务器端出错信息和补救措施
Ø启动服务器时，若未能连接到数据库，会显示未能连接数据库的信息。
这时管理员需要配置数据库信息，以确保服务器的运行。
Ø当登录系统之后，若未能填写正确的用户名以及密码，服务器端需要通过检测，通知用户。
用户端接收消息之后，向用户发送错误信息。
Ø用户进行客户注册时，若该注册的用户名已经存在则报错，用户可以重新选择注册名等信息。
Ø用户注册时需要填写的信息不能为空，同样对应的数字不能填写为其他的字符。
密码的确认以及其他信息的选择也是很重要的。
Ø用户需要修改个人信息时，应该准确填写所有的必要内容，若出现没有填写完成信息或者有错误信息时，会出现报错消息。
通知用户错误，并选择重新填写信息以及完善措施。
Ø服务端管理员在删除用户或者修改信息时，出现错误会报错，同样通知信息，选择重新操作。
7.1.2其它出错信息及补救措施
Ø网络故障：
服务器端网络故障则网络管理人员切实负起责任的同时，如果问题比较严重，需要较长时间修复，必须通知各管理人员，做好修复期间的补救工作，尽量保证城市管理系统的正常运行。
客户端网络故障则会员应及时报修，等网络恢复后再登陆系统。
Ø死机：
服务器端死机则应做好数据人工备份工作，防止意外死机引起的数据丢失，数据库必须及时做好备份，以确保正常运行。
客户端则需要重启程序。
Ø停电：
服务器端停电则应做好数据人工备份工作，防止意外停电引起的数据丢失，数据库管理员必须负责人。
客户端停电则等待电源恢复即可。
7.2系统维护设计
本系统的使用可以通过对市场的调研和管理员的调试等信息随时进行系统的维护。
同样，使用者也可以参与系统的维护中。
另外就是对于数据库的维护，随时对数据库中的信息加以调试和保存备份。
同样需要个工作人员进行系统的分析和用户的反馈，对系统进行升级以及功能的完善。
同时保证系统安全有序的运行。
由于功能的部分以及模块的划分没有完全展开，所以需要对系统进行定期的维护。
对于用户的要求以及系统不稳定要有一定的改进。
这是满足用户接口的和用户交流的必要措施。
最后就是需要对系统进行版本的更新，不断增强功能和维护系统。
升级会员 