一、架构设计
二、详细设计
1.1 接入方式
1.1.1 服务端：建立springboot+netty长连接服务
开放端口，内置netty服务，提供通信协议（websocket协议）协议帧
连接地址：
开发环境：
测试环境：
1.1.2 客户端：
H5，使用原生js，接入websocket协议，纯文本消息解析协议帧
1.2 消息帧定义
通用格式
|
<pre>{
"id":5, //帧数值,4个字节
"command":"/", //帧命令
"timestamp":1234567489, //帧发送的时间戳13位
"code":0, //code码说明 = 0 ：成功, 500：错误 401：token无效
"msg":"", //错误描述，可能为空
"data":{} //业务返回内容
}</pre>
|
1.2.1 登陆帧
|
<pre>{
"id":4, //帧数值
"command":"/login", //帧命令
"timestamp":1234567489, //帧发送的时间戳13位
"data":{
"appId":"123456", //接入端ID
"type": "teacher", //学生端：student,教师端传：teacher
"token":"dadsadsa" //对应学生端的token和 crm的token
}
}</pre>
|
如果登录token失效，或则不合法token
首次登录和后续登录失效都要返回
|
<pre>{
"id":3, //使用确认的帧id填写
"command":"/login/re", //帧命令
"timestamp":1234567489, //帧发送的时间戳13位
"code":0
"data":{
"conversationId":0 //返回当前账号的客服会话id，只有客户端账号会返回
"userId": 1,
"appId": 1,
"type": "student",
"appUserId": "11745131",
"tokenTime": 1636368201483
}
}</pre>
|
1.2.2 ping
客户端一定时间发起一次ping帧，
30秒ping一次，如果30秒后，没有收到确认ack帧就发起重连
|
<pre>{
"id":2, //帧数值
"command":"/ping", //帧命令
"timestamp":1234567489 //帧发送的时间戳13位
}</pre>
|
1.2.3 ack帧
双方当收到某消息后（非ack，否则死循环），需要返回给对方一条该消息对应的ack，确保消息送达。
如果发送某条消息，5秒后对方没有返回对应的ack，认定该条消息发送失败。
考虑到如果消息确实已送达，但是因为某些原因未能返回ack，接收方如果再收到同一id的消息，应该去重。
服务端去重，把已经处理的消息储存30秒，等一段时间后再去除，避免处理了重复的消息，
收到帧id为0的，不需要回应确认
|
<pre>{
"id":1, //使用确认的帧id填写
"command":"/", //原帧命令名加后缀/re
"timestamp":1234567489, //帧发送的时间戳13位
"code": 0, //返回码
"data":{}
}</pre>
|
code码说明
0 ：成功
500：错误
1.2.4 离线在线帧
服务端推给客户端某些用户的在线或则离线情况
在线帧
|
<pre>{
"id":1, //帧数值
"command":"/online", //帧命令
"timestamp":1234567489, //帧发送的时间戳13位
"data":{
"userId":123456 //上线的用户id
}
}</pre>
|
离线帧
|
<pre>{
"id":1, //帧数值
"command":"/offline", //帧命令
"timestamp":1234567489, //帧发送的时间戳13位
"data":{
"userId":123456 //下线的的用户id
}
}</pre>
|
1.2.5 消息帧
帧发送的时间戳13位，重发
|
<pre>1、创建子会话帧（学生端绑定一个问题）
{
"id":3, //协议id字段是递增整数,4个字节
"command":"/conversation/sub/add", //帧命令
"timestamp":1234567489, //帧发送的时间戳13位
"data":{
"conversationId":159753, //会话id
"extendParam":{
"workId":"124154584575755",
"clientVersion":""
"device": "iOS10", // 设备版本
"currentCourse":"L1-U01-1"， // 所在课程
"moduleName":"互动课堂"， // 模块名称
"linkId":111， // 环节id
"linkName":"左右转大挑战"， // 环节名称
"linkEnterTime": 1636617954789//进入当前环节的时间，时间戳
}
}
}
//这个得绑定我们的问题，那个环节，那个作业，如何绑定环节，在环节多久，客户端的版本，类型啥的
并且返回一帧带子会话id
{
"id":3, //协议id字段是递增整数,4个字节
"command":"/conversation/sub/add/re", //帧命令
"timestamp":1234567489, //帧发送的时间戳13位
"data":{
"subConversationId":159753, //子会话id
}
}
2、收到新子问题会话（教师端收到会话）
{
"id":4, //协议id字段是递增整数
"command":"/conversation/sub/receive", //帧命令
"timestamp":1234567489, //帧发送的时间戳13位
"data":{
"conversationId":159753, //会话id
"subConversationId":"1546466", //子会话id
"solveStatus": 1, // 解决状态：0: 老师发送关闭意图（待确认） 1: 学生确认（关闭） 2: 学生拒绝 3: 未确定（双方没有确认）
"userId": 122, // 用户id
"userName": "XXX", // 用户昵称
"userStatus": 1, // 用户状态（0：上线、1：下线）
"avatarUrl": "http://sdfdsfds" // 用户头像
"extendParam": {
"userGrade": "5年级"，
"currentCourse":"L1-U01-1"， // 所在课程
"moduleName":"互动课堂"， // 模块名称
"linkId":111， // 环节id
"linkName":"左右转大挑战"， // 环节名称
"linkEnterTime": 125555525 //进入当前环节的时间，时间戳
}
}
}
3，关闭子会话帧
{
"id":13, //协议id字段是递增整数
"command":"/conversation/sub/close", //帧命令
"timestamp":1234567489, //帧发送的时间戳13位
"data":{
"conversationId":159753, // 会话id
"subConversationId":"1546466", // 子会话id
"solveStatus": 1 // 0: 老师发送关闭意图（解决中） 1: 学生确认（关闭） 2: 学生拒绝 3: 未确定（双方没有确认）
}
}
版本1.1做，客户端收到关闭子会话帧
{
"id":13, //协议id字段是递增整数
"command":"/conversation/sub/close", //帧命令
"timestamp":1234567489, //帧发送的时间戳13位
"data":{
"conversationId":159753, //会话id
"subConversationId":"1546466", //子会话id
"solveStatus": 1 // 0: 老师发送关闭意图（解决中） 1: 学生确认（关闭） 2: 学生拒绝 3: 未确定（双方没有确认）
}
}
//客户端也可能收到solveStatus=1,2,3状态，
//1、退出编辑器环节，发送状态1，关闭子会话
//2、收到状态0后，弹出弹窗，用户点击确认发送状态1，用户点击拒绝发送状态2
//3、后端触发逻辑强制解决用户问题，客户端会收到1状态
4、发消息
{
"id":55, //协议id字段是递增整数
"command":"/msg/send", //帧命令
"timestamp":1234567489, //帧发送的时间戳13位
"data":{
"msgRandom":1546466, //消息随机数7位数字，使用发送时间+时间字段去重
"msgTime":12312421421, //点击发送消息时间戳13位
"conversationId":159753, //会话id
"msgBody":{ //消息体
"msgType":"text",
"msgContent":{
"text":"你好！"
}
}
}
}
异常重发时，保留data的数据不变，id，command,timestamp需要重新生成
后端内部需要自己回填改fromuser发送者,
(客户端发送消息后，收到的确认帧)
{
"id":55, //协议id字段是递增整数
"command":"/msg/send/re", //帧命令
"timestamp":1234567489, //帧发送的时间戳13位
"data":{
"msgId":13246, //发送的消息的id
"createTime":12312421421, //消息创建的服务器时间13位时间戳
}
}
收消息
{
"id":66, //协议id字段是递增整数
"command":"/msg/receive", //帧命令
"timestamp":1234567489, //帧发送的时间戳13位
"data":{
"msgId":13246 //发送的消息的id
"msgRandom":1546466, //消息随机数7位数字，使用该随机数+时间字段去重
"msgTime":12312421421, //点击发送消息的时间戳13位
"createTime":12312421421, //消息创建的服务器时间13位时间戳
"conversationId":159753, //会话id
"fromUser":"", //发送者
"fromType": 1, //消息来源类型 1:用户发送 2:系统自动回复
"msgBody":{ //消息体
"msgType":"text",
"msgContent":{
"text":"你好！"
}
}
}
}
msgType以下面为主
消息格式描述：msgBody
1、文本
{
"msgType":"text",
"msgContent":{
"text":"你好！"
}
}
2、语音
{
"msgType":"audio",
"msgContent":{
"url":"http://www.baidu.com",
"duration":126 //语音时长:单位秒
}
}
3、图片
{
"msgType":"image",
"msgContent":{
"url":"http://www.baidu.com"
}
}
4、视频
{
"msgType":"video",
"msgContent":{
"url":"http://www.baidu.com",
"duration":126, //视频时长:单位秒
"poster":"https://www.vipthink.com" //视频海报封面
}
}
5、其它文件
{
"msgType":"file",
"msgContent":{
"url":"http://www.baidu.com",
"size":1233, //大小单位byte
"fileName":"1233"//文件名称
}
}
6、tip提示语
{
"msgType":"tip",
"msgContent":{
"text":"这个问题，学生已经明白了",
"type":1//1：警告，2：确认
}
}
7、撤回消息
{ //消息体
"msgType":"revoke",
"msgContent":{
"msgId":"123465 //发送的消息id
}
}
8、编辑器作品
{
"msgType":"code",
"msgContent":{
"url":"http://www.baidu.com/123.sb3", //sb3文件
"name": "嗯作品" //作品名称
}
}</pre>
|
1.2.6 强制下线帧
下发一个强制下线帧，客户端自行断开连接
|
<pre>{
"id":1, //帧数值
"command":"/login/down", //帧命令
"timestamp":1234567489, //帧发送的时间戳13位
}</pre>
|
1.2.7 加入/离开聊天会话
加入聊天会话
|
<pre>{
"id":13, //协议id字段是递增整数
"command":"/conversation/join", //帧命令
"timestamp":1234567489, //帧发送的时间戳13位
"data":{
"conversationId":159753, //会话id
}
}</pre>
|
离开聊天会话
|
<pre>{
"id":13, //协议id字段是递增整数
"command":"/conversation/leave", //帧命令
"timestamp":1234567489, //帧发送的时间戳13位
"data":{
"conversationId":159753, //会话id
}
}</pre>
|
1.2.8 移除会话帧
当会话不再属于当前用户，则会收到移除会话帧
|
<pre>{
"id":13, //协议id字段是递增整数
"command":"/conversation/remove", //帧命令
"timestamp":1234567489, //帧发送的时间戳13位
"data":{
"conversationId":159753, //会话id
}
}</pre>
|
1.2.9批量强制关闭子会话
下线，强制关闭所有子会话，
|
<pre>{
"id":13, //协议id字段是递增整数
"command":"/conversation/sub/batch/close", //帧命令
"timestamp":1234567489, //帧发送的时间戳13位
"data":{
"subConversationIds":[123,456,789], // 子会话id列表
}
}</pre>
|
1.3 断线重连机制
客户端发送ping，服务端回复pong。服务端，当一定时间没有收到ping消息后，就主动断开连接，客户端如果一定时间没有收到pong消息，则发起重连服务器
1.4 消息确保方案（消息确认机制）
服务端：当服务端给客户端发送消息，在本地维护一个等待ack队列，确认后才把消息丢失掉，否则进行重发，直到重发三次。（默认认为已经掉线）
1.5 集群无状态方案
每个客户端连接上来分配一个唯一的客户端id，记录连接到哪一个长连接服务器，记录到redis上面。（用户id，客户端id，服务器id（nacos的服务id名称））
连接情况，用户A在服务器1上，用户B在服务器2上
A发送消息给用户B，到服务器id1上，找redis上用户B的连接在那个服务器id上，然后负载均衡调用具体的哪个服务器Id，调用发送消息的rpc方法
1.6 业务接入方式
1、授权登陆方案
业务放自己存储user与im的userId对应的关系，用于使用im用户id查询用户的信息
2、消息回调方案
1.7 登录超时机制
为了避免有一些恶意连接，或则一些无用的连接，禁止1分钟内没有登录的强制关闭连接
1.8 socket服务平滑发版
因为使用将用户连接和socket服务的连接关系是维护在redis注册表的，所以在重启时，应先从把注册信息移除，然后关闭客户端的连接，让客户端重新发起连接。当一定时间后再关闭掉服务，当这是有im服务调用socket服务发送消息，则在本服务找不到用户信息返回给im需要重新路由调用，im服务重新获取注册表重试发起调用。
使用k8s容器关闭前，调用钩子，当关闭服务前，触发注销掉在nacos上的服务注册，在这个钩子中也加入移除redis上维护的用户注册表信息。
架构图源文件：
[图片上传中...(image-2216c0-1638604597027-0)]
