概要设计基于qt的邮箱收发系统的设计与实现Word文档下载推荐.docx
《概要设计基于qt的邮箱收发系统的设计与实现Word文档下载推荐.docx》由会员分享，可在线阅读，更多相关《概要设计基于qt的邮箱收发系统的设计与实现Word文档下载推荐.docx（30页珍藏版）》请在冰豆网上搜索。
2.2.2ClientSocket模块.......................................................................................................................8
2.2.3ServerSocket模块......................................................................................................................9
2.2.4DataBase模块...........................................................................................................................10
2.3模块动作时序.......................................................................................................................................11
3接口说明...........................................................................................................................................................12
3.1数据结构定义.......................................................................................................................................12
3.2函数.......................................................................................................................................................12
3.2.1模块间接口函数.......................................................................................................................12
3.2.2模块内接口函数.......................................................................................................................19
1文档概述
1.1文档目的和范围
该文档主要完成的是对整个项目模块的划分和模块间接口的设计，为项目开发人员的详细设计提供依据。
1.2术语/缩略语
序号
术语/缩略语
说明
Socket
通常也称作套接字，用于描述IP地址和端口，是一个通信链的句柄。
2
UI_Control
界面交互模块
3
ClientSocket
客户端模块
4
ServerSocket
服务器模块
5
Database
数据库模块，存储相关数据
1.3参考文档
文档名
作者
时间
版本
基于QT的邮箱收发系统需求分析报告书
吴奎
2013-12-16
Ver0.1.0
2模块概述
本项目是用比较常见的B/S架构来设计的，分为客户端和服务器两大模块。
其中客户端又分为界面交互模块和客户端通信模块，服务器模块分为服务器通信模块和数据库模块。
界面交互模块负责界面的显示以及与用户的交互；
客户端通信模块负责将用户操作产生的消息传送至服务器上以及接收服务器传来的消息；
服务器通信模块负责接收客户端传送的消息并且根据消息类型进行相应的处理，再将处理的结果传送给对应的客户端。
数据库模块负责存储和提供系统中生成的信息，并对这些信息进行管理。
2.1模块功能定义
2.1.1UI_Control模块
功能点
功能点详细内容
登录界面
用户通过登录界面通过输入用户名和密码登录邮箱
注册界面
新用户注册新的邮箱账号
邮箱主界面
显示邮箱的主要信息，包括收件箱、发件箱、垃圾箱等
编写邮件界面
用户编写新的邮件
查看邮件界面
查看完整的邮件信息
6
添加附件
在邮件中添加文档、图片、声音、视频等
7
管理邮件
用户对自己邮箱内的邮件进行增删查改等操作
8
邮件搜索
可以查找用户需要查看的邮件
9
最近联系人
显示最近来往的邮箱号，方便发送邮件
10
名片设置
用户设置自己的信息以便好友了解
11
字体设置
设置字体的颜色和大小
12
添加表情
编写邮件内容可以插入动态的表情
13
界面换肤
更改界面的主题和背景色
2.1.2ClientSocket模块
登录邮箱
输入账号和密码登录邮箱，登录的信息将发送至服务器并接受返回结果。
注册邮箱
建注册的信息发送至服务器并等待服务器返回的结果
收取邮件
接收服务器返回的已读和未读邮件标题等相关信息
发送邮件
将邮件内容和收件人地址等信息发送至服务器并接收返回结果
查看邮件
将帐号和邮件ID等信息发送至服务器并接收返回的邮件内容等信息
将名片中修改的内容项发送至服务器并接收返回的结果
将帐号和搜索关键字等信息发送至服务器并接收返回的搜索结果内容
删除邮件
将要删除或彻底删除的帐号和邮件ID等信息发送至服务器并接收返回的结果，彻底删除的不会进垃圾箱。
恢复邮件
将垃圾箱中未彻底删除的邮件恢复的信息发送至服务器并接收返回的结果
2.1.3ServerSocket模块
接收信息
接收客户端的请求，比如登录、注册、收取邮件、删除邮件等
发送信息
对客户端发送来的消息进行相应的处理并返回结果给客户端
2.1.4Database模块
登录检测
用户登录时检测用户的账号和密码是否正确
用户状态变换
用户登录或退出时，更换数据库表中用户的当前状态
增加用户
将新注册的用户信息加入数据库表
将邮件的所有相关信息存储到数据库表中
转发邮件
若数据库中邮件被取出，并已经发送，做标记
删除没有用的邮件，节约存储空间
更改用户IP和端口
当用户登陆时存储用户ip和端口，用于与服务器通信
保存附件
当有附件时，建立文件夹存储附件并记录其与邮件id的关联
2.2模块结构
2.2.1UI_Control模块
模块名称
模块类型
概要说明
MessagePack
内部模块
对发送的消息进行打包
MessageUnpack
对接收到的消息进行解包
ReceiveMsg
接收服务器信息
ThreadProcess
线程处理接收到的信息
2.2.2ClientSocket模块
ClientSend
接口
客户端通信发送函数
ClientReceive
客户端通信接收函数
ClientInit
Socket初始化
SetSender_Msg
设置发送方IP和端口
SetReceiver_Msg
设置接收方IP和端口
2.2.3ServerSocket模块
ServerSend
服务器端通信发送函数
ServerReceive
服务器端通信接收函数
ServerInit
服务器端处理函数
GetServerIp
获取服务器IP
2.2.4DataBase模块
AddMailInfo
增加邮件信息
AddUserInfo
增加用户信息
DeleteMailInfo
删除邮件信息
setUserOnline
设置用户状态
CheckUserPwd
检查用户密码
DataBaseInit
初始化数据库
ModifyUserInfo
修改用户信息
SetMailFlag
修改邮件标志
2.3模块动作时序
3接口说明
3.1数据结构定义
#defineINT8Uquint8
#defineINT16Uquint16
#defineINT64Uquint64
#defineSTRINGQString
#defineSUCC1
#defineERR0
#defineSYS_ON11
#defineSYS_OFF12
#defineSYS_LOGIN_SUCC13
#defineSYS_LOGIN_ERR14
#defineSYS_REGISTER_SUCC15
#defineSYS_REGISTER_ERR16
#defineSYS_REQUEST17
#defineUSR_LOGIN31
#defineUSR_REGISTER32
#defineUSR_GETMAIL33
#defineUSR_NOTREAD_MAIL34
#defineUSR_RECEIVE_MAIL35
#defineUSR_SENDED_MAIL36
#defineUSR_DELETED_MAIL37
3.2函数
3.2.1模块间接口函数
3.2.1.1ClientSend
函数名
文件名
../ClientSocket.cpp
功能概要
客户端发送信息
记述形式
INT8UClientSocket:
:
ClientSend（
QByteArray*datagram,
STRINGReceiverIP,
INT16UReceiverPort
）
参数
类型
变量名
I/O
QByteArray
datagram
-
传入的数据数组指针
STRING
ReceiverIP
传入的服务器IP
INT16U
ReceiverPort
传入的服务器端口
返回值
INT8U
值
SUCC
发送成功
ERR
发送失败
详细说明
客户端发送信息函数，给用户界面交互时使用
使用注意事项
无
3.2.1.2ClientReceive
ClientReceive
客户端信息接收函数
INT8UClientSoclet:
ClientReceive（QByteArray*datagram）
存储接收到的数据
接收成功
接收失败
接收函数给客户端界面交互调用，接收的数据再被处理
3.2.1.3AddMailInfo
../DataBase.cpp
boolDataBase:
AddMailInfo（Mailmail）
Mail
mail
传入Mail类对象
bool
true
正常结束
false
异常结束
当服务器收到发送邮件标志时处理函数调用该函数
传入参数的类型
3.2.1.4AddUserInfo
AddUserInfo（Useruser）
User
user
传入用户信息类对象
当服务器收到新用户注册标志时处理函数调用该函数
3.2.1.5DeleteMailInfo
DeleteMailInfo（INT16UmailId）
mailId
邮件标志
fasle
服务器处理删除邮件时调用该函数
3.2.1.6SetUserOnline
SetUserOnline
更改用户在线状态
SetUserOnline（
STRINGuserName,
INT8UuserStatus
userName
传入用户邮箱帐号
userStatus
传入状态值
当收到用户登陆成功信息时调用该函数
3.2.1.7CheckUserPwd
../DataBase.cpp
验证用户帐号和密码
CheckUserPwd（
STRINGpassword
password
传入用户邮箱密码
用户登陆时服务器进行验证
3.2.1.8DataBaseInit
数据库初始化
DataBaseInit（）
服务器启动开始调用该函数
3.2.1.9ModifyUserInfo
ModifyUserInfo（
STRINGusername,
UsernewUser
newUser
传入用户信息对象
用户更改名片操作时数据库模块调用该函数处理
3.2.1.10SetMailFlag
更改邮件标志
SetMailFlag（
INT8UmailStatus
mailStatus
传入邮件标志
邮件已转发送至用户邮箱，更改邮件标志
3.2.2模块内接口函数
3.2.2.1MessagePack
../Message.cpp
打包要发送的消息
INT8UMessage:
MessagePack（QByteArray*datagram）
QByteArray*
I
打包后存储的数据数组指针
将要传送的数据全部打包在一起发送
3.2.2.2MessageUnpack
解包要接收到的消息
MessageUnpack（QByteArray*datagram）
传入需要解包的数据数组指针
从包中解出需要的单个数据域
3.2.2.3ClientThreadProcess
run
.../ThreadProcess.cpp
客户端接收处理函数
voidThreadProcess:
run（）
void
客户端接收处理函数,注意与服务器端的区分
3.2.2.4ReceiveMsg
.../xmailmainwidget.cpp
客户端接收信息
voidxmailMainWidget:
ReceiveMsg（）
客户端接收的信息
升级会员 