上次文章基本描述了整个项目的设计和一些业务逻辑的细节,但是感觉有一点点怎么说都没有说清楚的感觉,其实就是细节太琐碎整体没有逻辑感。感觉对开发也有也有一定的影响。于是我找了一个产品说明文档规范,来使得自己对于项目开发的功能描述更加清晰和规范。
上一篇文章↓
java学习笔记(二十六)——开发一个小项目(VMeeting1.0)_Biangbangbing的博客-CSDN博客
本次比上次新增功能:登录;新用户注册;服务器转变功能【由与客户端进行交互改变成转发消息】;将单纯的消息协议统一为更广泛的消息/操作协议,并设置消息包【消息头固定】。
产品需求文档目录:
模板和一个示例的链接我都挂链接:
XXX 产品需求文档_V1.0_Build_01_20141116.docx_免费高速下载|百度网盘-分享无限制
读书人频道产品需求0627.doc_免费高速下载|百度网盘-分享无限制
显然不是所有内容都用的上的,我准备完成其中几个部分。
一、用户角色描述
用户角色 | 用户描述 |
---|---|
普通用户 | 所有使用软件的客户端 |
管理员 | 软件后台监控人员【服务器端也需要可视化界面】 |
二、 产品概述
1.总体流程
【ps:所有标蓝的部分都是页面。】
2.功能摘要
功能模块 | 主要功能点 | 优先级 |
登录 | 用户登录、递交个人信息给服务器;新用户注册(递交新用户token给服务器) | 高 |
聊天界面 | 显示聊天记录(日期、用户名、对话)、侧边显示消息列表(/好友列表) | 高 |
消息列表 | 显示消息列表 | 中 |
好友列表 | 显示好友列表,好友/群申请,加群、加好友,创建群选择 | 中 |
个人信息设置 | 个人信息修改 | 低 |
3.项目文档说明
server:接收客户端A的消息,然后转发给目的客户端B
- server:做server相关任务调度。连接查询请求的客户端——启动界面——循环监听消息。
- serverUI:服务器端的界面设计。
- serverListener:服务器端界面的监听器。
- serverReceiveMsg:服务器端接收客户端发送的消息。
client:多个客户端,相互发送消息但是要经过服务器端的转发
- client:完成一个客户端执行任务的调度。连接服务器端——启动界面——循环监听服务器端发送的消息。
- clientUI:客户端的界面设计。
- clientListener:客户端界面对应的监听器。
- clientReceiveMsg:客户端接收服务器端的消息。
- clientLoginUI:客户端登录界面+注册界面。
- clientLoginListener:登录监听器。
- clientRegisterListener:注册监听器。
- clientStart:客户端启动器。
配置类
- User:用户类。
- MessagePackage:消息包。
- MessageBuffer:服务器待发消息缓存。
- IOMsg_INT:字节流收发int类型。
- IOMsg_Str:字节流收发string类型。
- VMeetingConfig:界面大小数据配置文件。
4.用户信息设计
数据库字段 | 数据 | 数据说明 |
UID | 账号 | 用户的唯一标识符,前期自行设计不允许重复;后期可以分配【int】 |
name | 用户名 | 用户自行设计,可重复【string】 |
password | 密码 | 用户自行设计,可重复【string】 |
online | 在线标记 | 是否在线【bool】 |
friendList | 好友列表 | user数组,细节待设计 |
groupList | 群列表 | 待设计 |
ChatHistory | 聊天记录 | 待设计 |
5.消息协议
localID:自己的id【int】
targetID:对方的id【int】
dataStr:时间戳【String】
messageType:消息类型【int】
消息内容主体。
消息类型 | 消息发送方 | 接收对象 | 消息内容说明 | 消息码 | 回复 |
消息 | 用户 | 用户 | 文字消息 | 1 | |
消息 | 用户 | 用户 | 涂鸦消息 | 2 | |
操作 | 用户 | 服务器 | 用户离线 | 253 | |
操作 | 用户 | 服务器 | 新用户注册 | 254 | 0 账号冲突 1 注册成功 |
操作 | 用户 | 服务器 | 用户登录 | 255 | 0 账号或密码错误 1 登录成功 2 用户已在线 |
【后续还会添加不同的操作和消息,以及有不同消息内容主体的设计】
三、产品特性
1.登录页面
- 页面路径
打开软件第一个页面。
- 功能描述
实现用户登录/注册。【将用户登录请求消息包发送给服务器,修改服务器内用户在线信息】【用户注册是一个新页面,要搜集用户名,用户账号,密码,确认密码】
- 技术实现细节
- 用户登录使用账号和密码,发送给服务器消息绑定用户于客户端socket。服务器识别数据库账户信息正确后返回给客户端。
- 用户注册页面必须是一个新页面,要求输入用户名,账号,密码,确认密码。客户端发起向服务器端的连接。
- 注册用户之后还要进入登录页面进行登录。
2.消息列表页(默认显示页)、好友列表、个人设置
- 页面路径
成功登录之后第一个页面。
通过上面的操作栏可以选择切换显示3个页面。
- 功能描述
将用户近期聊天记录列表按条目显示,点击条目打开聊天页面,如果没有显示为空。【条目显示:头像,用户名,消息最后时间】
将用户的新朋友申请/好友/群按条目显示,点击之后打开聊天页面。
个人设置可以修改个人信息。【用户名、密码】。
- 技术实现细节
【待开发。】
3.聊天界面
- 页面路径
选择好友或者消息列表之后显示的页面。
【为了先实现必要逻辑,目前登录之后会直接显示这个页面,选择聊天好友会通过左侧搜索框确定好友账号】
- 功能描述
显示与某个好友的聊天页面。聊天页面title为:好友用户名<id>。左侧显示本用户信息【uid,用户名】和好友信息【uid,用户名】。
右侧为聊天记录:上半截为消息记录,中间部分为工具栏【选择消息类型:文字,涂鸦,照片、文件,清空输入框,清空聊天记录】,下半截为消息输入框,消息发送键。
- 技术实现细节
- 每次发送消息都按照消息协议发送信息。
- 当对方在线时,发送消息之后直接在双方的聊天记录同步显示消息,消息记录为:对方name/id:消息发送时间;消息内容; 如果对方不在线,服务器将消息存放在缓存中,服务器将在其上线之后把消息发给它。
- 优化:将对话显示放到不同侧,对方在左,本方在右。【待实现。】
- 优化:对于不同消息类型的支持。【文字、涂鸦板、照片、文件】。【待实现】
目前遇到的问题&如何解决
- 将收消息单独打包设置为一个线程类用于实时监控收到的信息,根据功能需求来看需要一个客户端socket需要一个监听对象帮助其收消息,二者如何协同绑定?
- 服务器端只能与客户端通过socket进行通讯,如何明确客户端socket对应用户的信息实现用户之间的交流?
- 是否应该从登录开始保持唯一一个客户端与服务器端进行通讯?如果不是,那么意味着需要重新创建client向服务器端发起连接,如何保证这么多client,都能指向一个用户;这么多client是可以同时存活的吗?而服务器端如何决策当想要给某个用户发消息时,给哪一个socket发消息,随时监控到某个用户对应的客户端socket是哪一个?
- 如何处理client和界面之间的传递关系?
- 固定并化简参数传递关系。