详细设计说明书模板.docx
《详细设计说明书模板.docx》由会员分享，可在线阅读，更多相关《详细设计说明书模板.docx（20页珍藏版）》请在冰豆网上搜索。
详细设计说明书模板
即时通软件
详细设计说明书
设计主题：
即时通软件
设计者：
BecomeElite小组
设计地点：
中软国际厦门ETC开发三
设计时间：
2012-8-13——2012-8-22
目录
1引言4
1.1编写目的4
1.2背景4
1.3范围4
1.4术语定义4
1.5参考资料4
1.6任务概述4
1.6.1目标………………………………………………………………………………………4
1.6.2用户的特点………………………………………………………………………………5
1.6.3假定和约束………………………………………………………………………………5
1.7运行环境………………………………………………………………………………….5
1.7.1软件环境…………………………………………………………………………………..5
1.7.2硬件环境…………………………………………………………………………………/5
1.7.3接口……………………………………………………………………………………….5
2模块命名规则6
3系统功能及描述6
3.1系统功能层次模块图6
3.2服务器模块功能的描述6
3.2.1在线客户列表……………………………………………………………………………...6
3.2.2显示群聊信息……………………………………………………………………………..7
3.2.3踢人………………………………………………………………………………………..7
3.2.4发布公告面板信息………………………………………………………………………..7
3.2.5发布群信息………………………………………………………………………………..7
3.3客户端模块功能描述……………………………………………………………………….7
3.3.1在线客户列表……………………………………………………………………………...7
3.3.2发布群信息………………………………………………………………………………...7
3.3.3显示群信息………………………………………………………………………………..7
3.3.4私聊………………………………………………………………………………………...7
3.3.5发送截屏图片……………………………………………………………………………..7
3.3.6发送文件…………………………………………………………………………………..8
3.3.7退出聊天室………………………………………………………………………………..8
3.4对非功能性的需求…………………………………………………………………………..8
3.4.1对性能的规定……………………………………………………………………………...8
3.4.2输入输出要求……………………………………………………………………………..8
3.4.3其他专门要求……………………………………………………………………………...8
4系统逻辑结构设计9
4.1系统逻辑结构设计…………………………………………………………………………….9
4.2系统物理结构设计……………………………………………………………………………..9
4.3表设计…………………………………………………………………………………………..9
4..3.1表名的解释…………………………………………………………………………………..9
4.3.2用户表解析………………………………………………………………………………...10
4,.3.3消息表解析…………………………………………………………………………………10
4.4表之间的关联设计……………………………………………………………………………10
4.4.1概念模型…………………………………………………………………………………….11
4.4.2物理模型…………………………………………………………………………………….11
5系统模块设计………………………………………………………………………………..12
5.1客户端…………………………………………………………………………………..12
5.2服务端…………………………………………………………………………………..14
6格式设计………………………………………………………………………………………17
6.1群聊格式……………………………………………………………………………………18
6.2私聊格式……………………………………………………………………………………19
6.3注册格式……………………………………………………………………………………20
6.4登录格式……………………………………………………………………………………20
6.5用户管理格式………………………………………………………………………………21
1引言
1.1编写目的
编写目的本需求规格说明书编写的目的是为了清晰地说明本小组开发《聊天软件》要实现的所有功能。
同时也为软件使用者和软件开发者之间建立共同的需求目标，进行一定程度的交流沟通。
同时对软件所需实现的功能模块做了全面的描述。
它是后续开发工作和验收工作的依据文件。
软件使用者和软件开发者以此为共同的基础。
本说明书的预期读者为：
软件开发小组的相关人员，软件开发小组的产品实现成员应该阅读和参考本说明进行代码编写、测试
1.2背景
随着网络的普及，人类生活越来越依赖网络，人与人之间的交也更多的是在网络上进行实时性的交流，即时通讯系统也被越来越多的人所使用。
即时通讯系统除了普通的生活上的交流，也在商业交流中越来越受到重视，它可以是个很好的与客户之间即时交流的平台，在时间上它要比电子邮件更加具有实时性，而费用相对电话交流也要经济的多。
在这种环境下，即时通软件作为一种即时通讯工具，得到了很好的发展。
定
1.3范围
该系统主要使用范围在公司内部使用，也可以由运营商进行运维。
1.4术语定义
即时通：
即时通就是即时通讯，要求可以实时的进行交流。
1.5参考资料
（1）Java核心技术
1.6任务概述
1.6.1目标
开发一个即时通讯软件，能够即时发送接受信息，操作简单，能良好的运行。
1.6.2用户的特点
此软件的用户包括两种，一种是即时通管理员，对系统的监控和维护，另一种是一般用户，可以登录、注册和发送信息
1.6.3假定和约束
本产品开发量不大，因此可以个人来完成，要求在两周之内来完成，此软件在内部使用，因此不需考虑代理和越过防火墙等问题
1.7运行环境
简要说明本产品的运行环境（包括硬件环境和支持环境）的规定。
1.7.1软件环境
名称
版本
语种
操作系统
Windows
XP，2003
操作系统的附加功能
数据库平台
Mysql
5.0
语言
JDK
5.0以上
邮件系统
客户端软件
1.7.2硬件环境
硬件配置
最低配置
推荐配置
服务器
1CPU：
P42.0G
1CPU：
P42.8G
Mem：
1G
Mem：
2G
HD：
40G
HD：
120G
客户端
1CPU：
P41.0G
1CPU：
P42.0G
Mem：
512M
Mem：
1G
HD：
40G
HD：
120G
1.7.3接口
说明该软件通过Socket端口对外服务，服务端口通过系统来配置
2命名规则
（1）项目命名：
IMQQ+项目功能且首字母大写
（2）包命名：
com.etc+所属项目功能小写+包功能小写
（3）类命名：
根据类的功能命名，如果类名只有一个单词则单词首字母大写，其余小写；如果累名由多个单词构成，则每个单词的首字母大写，其余小写。
3系统功能及描述
3.1系统功能层次模块图
3.2服务器模块功能的描述
3.2.1在线客户列表
服务器端可以实时显示客户端的用户列表，当用户上线或者下线时，都会自动刷新
3.2.2显示群聊信息
服务器端可以实时显示用户群聊信息
3.2.3踢人
服务器管理员对于发表非法言论或无理起闹者剔出聊天室；
3.2.4发布公告面板信息
服务器管理员通过公告栏发送一些公告信息
3.2.5发布群信息
服务器管理员也可以与客户进行群交流
3.3客户端模块功能的描述
3.3.1在线客户列表
客户端显示所有的在线客户信息
3.3.2发布群信息
客户端可以向所有在线客户发送信息
3.3.3显示群信息
客户端显示所有客户发送的群信息
3.3.4私聊
客户可以选择其他客户进行私聊，输入信息发送给对方
3.3.5发送截屏图片
客户可以通过截屏发送给对方，对方可以接收截屏信息
3.3.6发送文件
客户可以选择文件发送给对方，对方可以接收文件信息
3.3.7退出聊天室
客户不想聊时可以退出聊天室
3.4对非功能性的需求
3.4.1对性能的规定
（1）精度
该软件对精度没有严格要求
（2）时间特性要求
该软件要求客户端之间发送信息在3秒之内有反应，传送文件5秒之内有反应；
（3）灵活性
要求客户输入灵活，操作方便；
3.4.2输人输出要求
对于输入输出基本要求如下：
（1）客户名称不能为空
（2）每次输入文本信息不超过100个字符
（3）每次传送文件不超过20M
3.4.3其他专门要求
无
4系统逻辑结构设计
4.1系统逻辑结构设计
用户表：
用户信息（编号，用户名，密码，昵称，性别，年龄，电话，地址，国籍，登陆时间，退出时间，备注）
信息表
消息（编号，消息内容，发送消息的时间，发送消息用户，接收消息用户，备注）
4.2系统物理结构设计
根据硬件设备和数据库平台系统，对数据库系统的物理存储结构进行规划，估计数据库的大小，增长速度，各主要部分的访问频度。
确定数据文件的命名，日志文件的命名。
数据文件和日志文件的物理存放位置，如果有多个存储设备，需要规划数据文件的组织方式。
系统内存使用配置，一般来说，数据库系统会自动维护系统内存，但有时为了某些性能问题，可以根据需要对数据库的内存管理进行另行配置。
4.3表设计
根据数据字典的设计，进一步细化为数据库表的设计。
表的设计包括以下内容：
4.3.1TableName（表名的解释）
SUSERS用户表
MESSAGE消息表
4.3.2用户表解析
字段名
类型
允许为空
默认值
说明
USERID
INTEGER
FALSE
用户编号（主键）
UNAME
VARCHAR2（50）
FALSE
用户名
UPWD
VARCHAR2（50）
FALSE
用户密码
UGENDER
VARCHAR2
（2）
TRUE
用户性别
UNICKNAME
VARCHAR2（50）
TRUE
用户昵称
UAGE
INTEGER
TRUE
用户年龄
UTEL
NUMBER（11）
TRUE
用户电话
UADDRSS
VARCHAR2（50）
TRUE
用户地址
UHOME
VARCHAR2（20）
TRUE
用户籍贯
ULOGINTIME
DATE
FALSE
用户登陆时间
UOUTTIME
DATE
TRUE
用户离开时间
UREMARK
VARCHAR2（500）
TRUE
备注说明
4.3.3消息表解析
字段名
类型
允许为空
默认值
说明
MID
INTEGER
FALSE
消息编号（主键）
MCONTENT
VARCHAR2（500）
FALSE
消息内容
MSENDTIME
DATE
FALSE
发送消息时间
MSENDFROM
INTEGER
FALSE
发送消息用户编号
MSENDTO
INTEGER
TRUE
接收消息用户编号
MERMARK
VARCHAR2（500）
TRUE
消息备注
4.4表之间的关联设计
4.4.1概念模型
4.4.2物理模型
5系统模块设计
5.1客户端
模块名称
客户端
功能描述
实现私聊群聊用户登陆注册
实体类图
业务逻辑类
界面
ACTION
接口与
属性
5.1.1业务逻辑类说明：
sendMessage（Message）向服务器发送信息包
AllClientMessageManager（ReadServerMessage）得到服务器发送包并进行相应处理
5.1.2ACTION说明：
GroupChatFrameEvent.actionPerformed（ActionEvent）获取用户与发送信息并封装成Message对象，调用业务逻辑发送给服务端，并实现群聊窗体的关闭与截取图片功能。
LoginListener.actionPerformed（ActionEvent）获取用户登陆信息并封装成Message对象，调用逻辑对象发送给服务端，）获取用户注册信息并封装成Message对象，调用逻辑对象发送给服务端，
PrivateChatFrameEvent.actionPerformed（ActionEvent）获取用户与发送信息并封装成Message对象，调用业务逻辑发送给服务端，并实现私聊窗体的关闭，截取图片，抖动窗口发送文件，字体功能。
ReadServerMessage（Socket）获取服务器发送包
补充说明
5.2服务端
模块名称
服务端
功能描述
实体类图
业务逻辑类
界面
ACTION
接口与
属性
5.2.1业务逻辑类说明：
ClientSocketThread获取用户发送的信息包
ALLServerMessageManager（ClientSocketThread）得到客服端发送的信息包
messageManager（Message）根据接收到的信息包进行分流
login（）处理登陆信息包
regist（）处理注册信息包
privateMessage（）处理私聊信息包
publicMessage（）处理公聊信息包
ServerToClient.main（String[]args）向客服端发送信息包
5.2.2ACTION说明：
ManagerFrameListener.actionPerformed（ActionEvent）超级管理员界面监听器，实现用户注册资料管理，群聊，私聊，启动服务器，关闭服务器，备份主机，禁言用户，禁言撤销，踢出聊天室，踢出撤销功能
UsersAllFrameListener.actionPerformed（ActionEvent）所有用户的信息管理面板，实现对用户信息的增删改功能
UsersQueryFrameListener.actionPerformed（ActionEvent）超级管理员查询用户监听器，实现对用户的查询功能
补充说明
5.2.3DAO层类图:
方法说明：
delete（int）根据int删除实体
isAddOK（User）添加实体User
selectByid（int）根据int返回实体
selectBySql（String）根据SQL语句String返回实体
update（User）根据User更新实体
delete（int）根据int删除实体
sAddOK（Message）添加实体Message
selectByid（int）根据int返回实体
selectBySql（String）根据SQL语句String返回实体
update（Message）根据Message更新实体
6格式设计
6.1群聊格式
6.2私聊格式
6.3注册格式
6.4登录格式
6.5用户管理格式
升级会员 