数据编码基本结构
每一个数据由两个部分组成,如下图:
| 头信息 | 实际数据 |
而其中头信息包括以下几个部分:
| Type(4 bits) | Tag 1(4 bits) | Tag 2(1 byte) |
Tag 2是可选的,当Tag的值不超过14时,只需要用Tag 1就可以表示;当Tag的值超过14而小于256时,Tag 1固定为15,而用Tag 2表示Tag的值。Tag不允许大于255。
Tag由Tag 1和Tag 2一起表示。取值范围是0~255,即该数据在结构中的字段ID,用来区分不同的字段。
Type表示类型,用4个二进制位表示,取值范围是0~15,用来标识该数据的类型。不同类型的数据,其后紧跟着的实际数据的长度和格式都是不一样的,详见一下的类型表。
基本类型(包括int1、int2、int4、int8、float、double)
头信息后紧跟数值数据。char、bool也被看作整型。所有的整型数据之间不做区分,也就是说一个short的值可以赋值给一个int。
数字0
头信息后不跟数据,表示数值0。所有基本类型的0值都可以这样来表示。
这是考虑到数字0出现的概率比较大,所以单独提一个类型,以节省空间。
字符串(包括String1、String4)
String1跟一个字节的长度(该长度数据不包括头信息),接着紧跟内容。
String4与之类似。
Map
紧跟一个整形数据(包括头信息)表示Map的大小,然后紧跟[Key数据(Tag为0),Value数据(Tag为1)]对列表。
List
紧跟一个整形数据(包括头信息)表示List的大小,然后紧跟元素列表(Tag为0)
自定义结构开始
自定义结构开始标志,后面紧跟字段数据,字段按照tag升序顺序排列
自定义结构结束
自定义结构结束标志,Tag为0
对象持久化
对于自定义结构的持久化,由开始标志与结束标志来标识。
比如如下结构定义:
struct TestInfo
{
1 require int ii = 34;
2 optional string s = "abc";
};
struct TestInfo2
{
1 require TestInfo t;
2 require int a = 12345;
}
其中,默认的TestInfo2结构编码后结果为:
消息格式
TUP底层协议完全采用Tars定义,与Tars的底层数据包定义一致,其中require的字段为TUP必须的字段,optional为访问Tars服务时额外需要用到的字段。
请求包:
//请求包体
struct RequestPacket
{
1 require short iVersion; //版本号
2 optional byte cPacketType; //包类型
3 optional int iMessageType; //消息类型
4 require int iRequestId; //请求ID
5 require string sServantName; //servant名字
6 require string sFuncName; //函数名称
7 require vector<byte> sBuffer; //二进制buffer
8 optional int iTimeout; //超时时间(毫秒)
9 optional map<string, string> context; //业务上下文
10 optional map<string, string> status; //框架协议上下文
};
响应包:
//响应包体
struct ResponsePacket
{
1 require short iVersion; //版本号
2 optional byte cPacketType; //包类型
3 require int iRequestId; //请求ID
4 optional int iMessageType; //消息类型
5 optional int iRet; //返回值
6 require vector<byte> sBuffer; //二进制流
7 optional map<string, string> status; //协议上下文
8 optional string sResultDesc; //结果描述
};
//返回值
const int TAFSERVERSUCCESS = 0; //服务器端处理成功
const int TAFSERVERDECODEERR = -1; //服务器端解码异常
const int TAFSERVERENCODEERR = -2; //服务器端编码异常
const int TAFSERVERNOFUNCERR = -3; //服务器端没有该函数
const int TAFSERVERNOSERVANTERR = -4; //服务器端没有该Servant对象
const int TAFSERVERRESETGRID = -5; //服务器端灰度状态不一致
const int TAFSERVERQUEUETIMEOUT = -6; //服务器队列超过限制
const int TAFASYNCCALLTIMEOUT = -7; //异步调用超时
const int TAFINVOKETIMEOUT = -7; //调用超时
const int TAFPROXYCONNECTERR = -8; //proxy链接异常
const int TAFSERVEROVERLOAD = -9; //服务器端超负载,超过队列长度
const int TAFADAPTERNULL = -10; //客户端选路为空,服务不存在或者所有服务down掉了
const int TAFINVOKEBYINVALIDESET = -11; //客户端按set规则调用非法
const int TAFCLIENTDECODEERR = -12; //客户端解码异常
const int TAFSERVERUNKNOWNERR = -99; //服务器端位置异常
官方:
https://tarscloud.gitbook.io/tarsdocs/rumen/tars-protocol