即时聊天系统技术文档

本文档主要说明飞享即时聊天系统的技术相关文档,用于支持其他多端开发.说明系统的整体架构与后续技术发展规划,技术愿景,未来商业化支持

danger

本文未经授权禁止转载

飞享是一个即时聊天系统整体解决方案,更像一个开箱即用的即时通讯产品化解决方案.在设计之初,尽量遵照平台原生开发的要求进行,因为我们始终觉得原生的体验是达到一个优秀即时通讯的基本要求.在对客户端,服务端设计的过程中,尽量采用业界通用的方案进行.不用过于依赖某项技术,因为我们任何只有合适的技术用在合适的系统上才能发挥它固有的价值.

初衷开始这个项目只是对即时通讯的喜爱,慢慢不断的发展成为一个即时通讯类产品,在功能的不断迭代中,需要我们停下脚本思考一些问题.更希望这个一个技术解决方案,而不是基于某种语言或者框架的解决方案.也是服务端通信框架是基于t-io(基于AIO的网络编程框架,提供便捷的API,方便管理,快速使用),或者是基于Netty(基于NIO的异步网络编程框架).也是服务端编程语言是基于Java或者是基于Go.技术本身是为了解决实际问题,不应该是限制具体某个领域的发展.在编写客户端应用时,可以支持Android,也可以支持iOS,可以支持Web.支持我们遵循我们设计的交互协议规范,这些都可以迎刃而解,不管你是采用Android或者iOS原生开发,还是跨平台开发,使用Js框架Vue,React.

0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2
+---------------+---------------+---------------+---------------+
|      magic(8) |   version(8)  |   signal(8)   |               |
+---------------+---------------+---------------+---------------+
|                          length(32)                           | 
+---------------+---------------+---------------+---------------+
|   subsignal(8)|       messageId(16)           |  paload data  :
+---------------+---------------+---------------+---------------+
:             payload data(length)                              :
+---------------+---------------+---------------+---------------+

主信令	子信令	信令说明
PING	无	心跳主信令
PUSH	无	推送消息主信令
CONNECT	CONNECTION_ACCEPTED	接受链接
	CONNECTION_REFUSED_UNACCEPTABLE_PROTOCOL_VERSION	不可接受的协议
	CONNECTION_REFUSED_IDENTIFIER_REJECTED	用户拒绝
	CONNECTION_REFUSED_SERVER_UNAVAILABLE	服务不可用
	CONNECTION_REFUSED_BAD_USER_NAME_OR_PASSWORD	用户名或密码错误
	CONNECTION_REFUSED_NOT_AUTHORIZED	没有授权
	CONNECTION_REFUSED_UNEXPECT_NODE	节点拒绝链接
	CONNECTION_REFUSED_SESSION_NOT_EXIST	会话不存在
DISCONNECT	无	心跳主信令
CONNECT_ACK	无	心跳主信令
PUBLISH	US	用户搜索
	FAR	朋友添加请求
	UPUI	用户信息
	FRN	朋友添加通知
	FRP	拉取朋友请求
	FHR	处理朋友申请
	FP	获取朋友列表
	MN	消息通知
	MS	发送消息
	MP	获取消息
	FN	朋友添加通知
	GC	创建群组
	GPGI	获取群组信息
	GPGM	获取群组成员
	GAM	添加群组成员
	GKM	移除群组成员
	GQ	退出群组
	GMI	修改群组信息
	MMI	修改个人信息
	GQNUT	获取上传文件token
	MR	消息撤回
	RMN	远程消息通知
	LRM	拉取历史消息
PUB_ACK	确认主信令	子信令同上面Publish的子信令，这里不再一一列出

信令交互流程主要是指如何使用以上的信令进行业务处理，信令的设计都采用的发送确认机制，例如客户端发送connect信令后，正常情况下都会受到服务器返回的ack确认指令，这里就是connect_ack. 下面主要针对PUBLISH信令说明，因为这个主信令下面有比较多的子信令，每个信令的具体含义已经在上面做了相应的说明。下面主要来说明具体业务是如何交互的。下面以发送消息说明

{
    "signal": "PUBLISH",
    "subSignal": "MS",
    "messageId": 81,
    "content": {
        "from": "4A4A4Aaa",
        "content": {
            "type": 1,
            "searchableContent": "1234",
            "pushContent": "",
            "content": "",
            "binaryContent": "",
            "localContent": "",
            "mediaType": 0,
            "remoteMediaUrl": "",
            "localMediaPath": "",
            "mentionedType": 0,
            "mentionedTargets": []
        },
        "messageId": 1589944408832,
        "direction": 0,
        "status": 0,
        "messageUid": 0,
        "timestamp": 1589944408832,
        "to": "",
        "conversationType": 0,
        "target": "d9dRdRoo",
        "line": 0
    }
}

字段名称	子字段	字段描述
from	无	来源
messageId	无	消息id,发送时随机生成
direction	无	消息方向,接收还是发送
status	无	推送转台
messageUid	无	消息唯一Id,由服务端返回
timestamp	无	消息时间戳
to	无	目标
conversationType	无	会话类型,单聊/群组
target	无	目标接收者Id
line	无	线路
content	type	消息内容类型
	searchableContent	可供搜索的文本内容
	pushContent	推送内容
	content	内容
	binaryContent	二进制消息内容,经过编码
	localContent	消息本地内容
	mediaType	媒体类型
	remoteMediaUrl	媒体远程url,例如图片,视频,文件url
	localMediaPath	本地媒体文件路径
	mentionedType	提及类型
	mentionedTargets	提及的对象ID

{
    "signal": "PUBLISH",
    "subSignal": "MS",
    "messageId": 82,
    "content": {
        "from": "4A4A4Aaa",
        "content": {
            "mentionedType": 0,
            "mentionedTargets": [],
            "type": 1,
            "searchableContent": "纯文本消息"
        },
        "messageId": 1589955328518,
        "direction": 0,
        "status": 0,
        "messageUid": 0,
        "timestamp": 1589955328518,
        "to": "",
        "conversationType": 0,
        "target": "d9dRdRoo",
        "line": 0
    }
}

{
    "signal": "PUBLISH",
    "subSignal": "MS",
    "messageId": 84,
    "content": {
        "from": "4A4A4Aaa",
        "content": {
            "mentionedType": 0,
            "mentionedTargets": [],
            "type": 3,
            "searchableContent": "[图片]",
            "binaryContent": null,
            "mediaType": 1,
            "remoteMediaUrl": "http://image.comsince.cn/1-4A4A4Aaa-1589955429816-push-universe.png",
            "localMediaPath": ""
        },
        "messageId": 1589955430361,
        "direction": 0,
        "status": 0,
        "messageUid": 0,
        "timestamp": 1589955430361,
        "to": "",
        "conversationType": 0,
        "target": "d9dRdRoo",
        "line": 0
    }
}

{
    "content": {
        "binaryContent": "eyJnIjoiYm9iQ2JDUFAiLCJvIjoiVllWTFZMMjIiLCJtcyI6WyJkemRKZEpfXyJdfQ==",
        "content": "",
        "mediaType": 0,
        "mentionedType": 0,
        "pushContent": "",
        "remoteMediaUrl": "",
        "searchableContent": "",
        "type": 106
    },
    "conversationType": 1,
    "direction": 0,
    "from": "VYVLVL22",
    "line": 0,
    "messageId": 157747907456403130,
    "messageUid": 0,
    "status": 0,
    "target": "bobCbCPP",
    "timestamp": 1589956063904
}

系统流程图
- 登录设计
系统接口文档
- 私有二进制协议
- 基于websocket的消息体信令设计
- 基于消息信令的交互方式
- 发送消息体结构
系统规划
- 系统架构设计
- 多端开发系统体验
- 可扩展性
- 接入方便