时序图
登录，密钥交换流程：
Paste_Image.png
如果重连返回的结果失败，可能是因为服务器重启或会话已过期造成的，则需要重头开始用帐号密码请求登录。
用户界面聊天流程：
Paste_Image.png
消息列表的实时更新流程类似2，要先订阅allNewMessage
协议和接口：
统一采用json文本形式，utf-8编码后传输。
json对象必须包含head属性作为固定接口的秒数，data属性指明传输的参数数据，data属性的数据类型可能为单一类型（字符串、数字，布尔型用1和0替代），也可能是一个对象或数组。
关于加密
- 双方用登录时交换的des对称性密钥进行加解密
- 加密的接口要附加
secret属性，设置值为1，接收方根据该属性判断是否需要解密 - 只对data的json字符串加密，在用base64编码成可传输的字符串，最终的json对象效果如下：
{
head:{
action: "actionName",
secret: 1
} ,
data: "base64 string"
} - 目前只需要对带有聊天内容的data加密
登录请求
- 方向：客户端 >> 服务端
- 内容：
JSON（注意下面只是解析后的对象，并非实际传输的JSON字符串）：
{
head: {
action: "login"
},
data: {
userId:"ksoeufjgkwqoeitkdjgkdlgpekfjdlgd",
password:"KDSJEHWKR"
}
} - 说明：必须在建立socket连接后3秒内发送，否则服务端将自动关闭
socket连接，掉线后需要重新建立连接。
登录确认结果
- 方向：服务端 >> 客户端
- 内容：
{
action: "loginRes",
data:
{
result:1, // 1成功 2 密码验证失败 3 密钥验证失败（可能服务器重启导致所有会话丢失）
key:"rsa公钥"
}
} - 说明：rsa公钥用于加密客户端发给服务端的des密钥，des密钥用于敏感的数据加密解密，如聊天消息。如果是重连，则不包含key
客户端密钥
- 方向：客户端 >> 服务端
- 内容：
{
action: "secretKey",
data:"加密过的des密钥" // 加密过的des密钥
} - 说明：保留该加密过的des密钥，还可以用来重新快速登录
心跳通知
- 方向：客户端 >> 服务端
- 内容:
{
action:"keepAlive"
} - 如果掉线，服务端保留最多一小时的订阅状态和密钥，在一小时内realive即可快速恢复，否则需要重头登录和订阅。
重新快速登录
- 方向：客户端 >> 服务端
- 内容：
{
action: "realive",
data:"刚才加密过的des密钥" // 刚才加密过的des密钥
} - 返回接口
loginResult，如果验证失败，则要重头开始登录和订阅（服务器会话丢失）
发送聊天消息
-
方向：客户端 >> 服务端
-
内容：
{
action:"sendMessage",
data:{
id: 3939393939, // 消息ID，整型（客户端生成：时间毫秒值*10000+随机数(0~9999)组合）
receiver: "ksoeufjgkwqoeitkdjgkdlgpekfjdlgd", // 目标用户ID
type: 0, // 0 默认为文本，1为图片
content:""// 如果是图片，则内容为图片缩略图的URL
fileSuffix: ".txt", // 如果是图片，则必须有该属性，文件后缀名包含.点号
fileSource: "", // 如果是图片，则必须有该属性，高清图的地址
}
} -
说明：图片要预先上传到七牛，七牛的key格式为：
/im/{userId}/{message id}
发送聊天消息结果
- 方向：服务端 >> 客户端
- 内容：
{
action: "sendMessageResult",
data: {
id: 3939393939, // 消息ID，这个是客户端生成的ID
type: 1 // 表示已被服务器接收，但还未转发给目标用户，2表示已被目标用户接收
}
}
订阅实时消息
- 方向：客户端 >> 服务端
- 内容：
{
action: "subscribe"
data: {
type: "userMessage", // userNewMessage | allNewMessage
target: "用户ID" // 如果是userMessage，则显示是该用户ID
}
}
订阅实时消息成功
- 方向：服务端 >> 客户端
- 内容：
{
action: "subscribeSuccess",
data: {
type: "userMessage", // userNewMessage | allNewMessage
target: "用户ID" // 如果是userMessage，则显示是该用户ID
}
}
取消订阅消息
- 方向：客户端 >> 服务端
- 内容：
{
action: "unsubscribe"
data: {
type: "userMessage", // userNewMessage | allNewMessage
target: "用户ID" // 如果是userMessage，该参数是必须的
}
}
取消订阅实时消息成功
- 方向：服务端 >> 客户端
- 内容：
{
action: "unsubscribeSuccess",
data: {
type: "userMessage", // userNewMessage | allNewMessage
target: "用户ID" // 如果是userMessage，则显示是该用户ID
}
}
请求聊天记录
- 方向：客户端 >> 服务端
- 内容：
{
action: "requestChatHistory",
data:{
userId: "目标用户ID",
endTime: "截至时间（不包含）", // 默认当前时间
beginTime: "初始时间（包含）", // 可为空
maxRecord: 50, // 默认50条最新记录
}
}
接收历史消息
- 方向：服务端 >> 客户端
- 内容：
{
action: "receiveChatHistory",
data:[{
sender: "发送人的用户ID",
id: 3939393939, // 消息ID，整型（客户端生成：时间毫秒值*10000+随机数(0~9999)组合）
type: 0, // 0 默认为文本，1为图片
content:""// 如果是图片，则内容为图片缩略图的URL
fileSuffix: ".txt", // 如果是图片，则必须有该属性，文件后缀名包含.点号
fileSource: "", // 如果是图片，则必须有该属性，高清图的地址
read:1, // 是否已读，已读
}]
}
实时接收未读消息（聊天界面）（需要订阅）
- 方向：服务端 >> 客户端
- 内容：
{
action:"receiveUserNewMessage",
data:{
sender: "ksoeufjgkwqoeitkdjgkdlgpekfjdlgd", // 发送者用户ID
list: [{
id: 3939393939, // 消息ID，整型（客户端生成：时间毫秒值*10000+随机数(0~9999)组合）
type: 0, // 0 默认为文本，1为图片
content:""// 如果是图片，则内容为图片缩略图的URL
fileSuffix: ".txt", // 如果是图片，则必须有该属性，文件后缀名包含.点号
fileSource: "", // 如果是图片，则必须有该属性，高清图的地址
}, ....]
}
}
实时接收新消息的简要（消息列表）（需要订阅）
- 方向：服务端 >> 客户端
- 内容：
{
action: "receiveAllNewMessage",
data:[
{
sender: {
userName: "用户名"，
headImg: "头像",
userId: "用户ID"
},
newest: {
id: 3939393939, // 消息ID，整型（客户端生成：时间毫秒值*10000+随机数(0~9999)组合）
type: 0, // 0 默认为文本，1为图片
content:""// 如果是图片，只显示【图片】，如果文本过长，会自动截断最多50个字符
}, // 最新一条消息
unread: 10, // 累计未读消息总数
},....]
}
实时接收用户在线状态
- 方向：服务端 >> 客户端
- 内容：
{
action: "receiveUserState",
data:{
userId: "",
userName: "",
headImg, "",
online: 1, // 在线，0不在线
}
}
发送未读消息接收成功
- 方向：服务端 >> 客户端
- 内容：
{
action: "sendReadMessageSuccess",
data: [3939393939,...] // 消息ID数组
}
网友评论