通讯模块协议接口【初稿】

时序图

登录,密钥交换流程:

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数组
    }
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,142评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,298评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,068评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,081评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,099评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,071评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,990评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,832评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,274评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,488评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,649评论 1 347
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,378评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,979评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,625评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,643评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,545评论 2 352

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,651评论 18 139
  • 国家电网公司企业标准(Q/GDW)- 面向对象的用电信息数据交换协议 - 报批稿:20170802 前言: 排版 ...
    庭说阅读 10,951评论 6 13
  • 一、概念(载录于:http://www.cnblogs.com/EricaMIN1987_IT/p/3837436...
    yuantao123434阅读 8,348评论 6 152
  • 随手写的情书,回看时怦然心动
    甜蜜姑娘阅读 228评论 0 1
  • 今天的太阳很大,阳光刺眼,我走出地铁站的时候忍不住抬手挡在眼睛上方。 小梅抱怨着,化作一缕轻烟钻进我的口袋里。 我...
    _桃止阅读 186评论 2 6