編碼規(guī)范就是我們通常所說(shuō)的編解碼,序列化。不光是用在通信工作上,在存儲(chǔ)工作上我們也經(jīng)常用到。如我們經(jīng)常想把內(nèi)存中對(duì)象存放到磁盤上,就需要對(duì)對(duì)象進(jìn)行數(shù)據(jù)序列化工作。
本文采用先循序漸進(jìn),先舉一個(gè)例子,然后不斷提出問題-解決完善,這樣一個(gè)迭代進(jìn)化的方式,介紹一個(gè)協(xié)議逐步進(jìn)化和完善,最后總結(jié)??赐曛?,大家以后在工作就很容易制定和選擇自己的編碼協(xié)議。
一、緊湊模式
本文例子是A和B通信,獲取或設(shè)置基本資料,一般開發(fā)人員第一步就是定義一個(gè)協(xié)議結(jié)構(gòu):
struct userbase
{
unsigned short cmd;//1-get, 2-set, 定義一個(gè)short,為了擴(kuò)展更多命令(理想那么豐滿)
unsigned char gender; //1 – man , 2-woman, 3 - ??
char name[8]; //當(dāng)然這里可以定義為 string name;或len + value 組合,為了敘述方便,就使用簡(jiǎn)單定長(zhǎng)數(shù)據(jù)
}
在這種方式下,A基本不用編碼,直接從內(nèi)存copy出來(lái),再把cmd做一下網(wǎng)絡(luò)字節(jié)序變換,發(fā)送給B。B也能解析,一切都很和諧愉快。
這時(shí)候編碼結(jié)果可以用圖表示為(1格一個(gè)字節(jié))
這種編碼方式,我稱之為緊湊模式,意思是除了數(shù)據(jù)本身外,沒有一點(diǎn)額外冗余信息,可以看成是Raw Data。在dos年代,這種使用方式非常普遍,那時(shí)候可是內(nèi)存和網(wǎng)絡(luò)都是按K計(jì)算,cpu還沒有到1G。如果添加額外信息,不光耗費(fèi)捉襟見肘的cpu,連內(nèi)存和帶寬都傷不起。
二、可擴(kuò)展性
有一天,A在基本資料里面加一個(gè)生日字段,然后告訴B
struct userbase
{
unsigned short cmd;
unsigned char gender;
unsigned int birthday;
char name[8];
}
這是B就犯愁了,收到A的數(shù)據(jù)包,不知道第3個(gè)字段到底是舊協(xié)議中的name字段,還是新協(xié)議中birthday。這是后A,和B終于從教訓(xùn)中認(rèn)識(shí)到一個(gè)協(xié)議重要特性——兼容性和可擴(kuò)展性。
于是乎,A和B決定廢掉舊的協(xié)議,從新開始,制定一個(gè)以后每個(gè)版本兼容的協(xié)議。方法很簡(jiǎn)單,就是加一個(gè)version字段。
struct userbase
{
unsigned short version;
unsigned short cmd;
unsigned char gender;
unsigned int birthday;
char name[8];
}
這樣,A和B就松一口氣,以后就可以很方便的擴(kuò)展。增加字段也很方便。這種方法即使在現(xiàn)在,應(yīng)該還有不少人使用。
二、更好的可擴(kuò)展性
過了一段較長(zhǎng)時(shí)間,A和B發(fā)現(xiàn)又有新的問題,就是沒增加一個(gè)字段就改變一下版本號(hào),這還不是重點(diǎn),重點(diǎn)是這樣代碼維護(hù)起來(lái)相當(dāng)麻煩,每個(gè)版本一個(gè)case分支,到了最好,代碼里面case 幾十個(gè)分支,看起來(lái)丑陋而且維護(hù)起來(lái)成本高。
A 和 B仔細(xì)思考了一下,覺得光靠一個(gè)version維護(hù)整個(gè)協(xié)議,不夠細(xì),于是覺得為每個(gè)字段增加一個(gè)額外信息——tag,雖然增加內(nèi)存和帶寬,但是現(xiàn)在已經(jīng)不像當(dāng)年那樣,可以容許這些冗余,換取易用性。
struct userbase
{
1 unsigned short version;
2 unsigned short cmd;
3 unsigned char gender;
4 unsigned int birthday;
5 char name[8];
}
制定完這些協(xié)議后,A和B很得意,覺得這個(gè)協(xié)議不錯(cuò),可以自由的增加和減少字段。隨便擴(kuò)展。
現(xiàn)實(shí)總是很殘酷的,不久就有新的需求,name使用8個(gè)字節(jié)不夠,最大長(zhǎng)度可能會(huì)達(dá)到100個(gè)字節(jié),A和B就愁懷了,總不能即使叫“steven”的人,每次都按照100個(gè)字節(jié)打包,雖然不差錢,也不能這樣浪費(fèi)。
于是A和B尋找各方資料,找到了ANS.1編碼規(guī)范,好東西啊.. ASN.1是一種ISO/ITU-T 標(biāo)準(zhǔn)。其中一種編碼BER(Basic Encoding Rules)簡(jiǎn)單好用,它使用三元組編碼,簡(jiǎn)稱TLV編碼。
每個(gè)字段編碼后內(nèi)存組織如下
字段可以是結(jié)構(gòu),即可以嵌套
A和B使用TLV打包協(xié)議后,數(shù)據(jù)內(nèi)存組織大概如下:
TLV具備了很好可擴(kuò)展性,很簡(jiǎn)單易學(xué)。同時(shí)也具備了缺點(diǎn),因?yàn)槠湓黾恿?個(gè)額外的冗余信息,tag 和len,特別是如果協(xié)議大部分是基本數(shù)據(jù)類型int ,short, byte. 會(huì)浪費(fèi)幾倍存儲(chǔ)空間。另外Value具體是什么含義,需要通信雙方事先得到描述文檔,即TLV不具備結(jié)構(gòu)化和自解釋特性。
三、自解釋性
當(dāng)A和B采用TLV協(xié)議后,似乎問題都解決了。但是還是覺得不是很完美,決定增加自解釋特性,這樣抓包就能知道各個(gè)字段類型,不用看協(xié)議描述文檔。 這種改進(jìn)的類型就是 TT[L]V(tag,type,length,value),其中L在type是定長(zhǎng)的基本數(shù)據(jù)類型如int,short, long, byte時(shí)候,因?yàn)槠溟L(zhǎng)度是已知的,所以L不需要。
于是定義了一些type值如下
類型 | Type值 | 類型描述 |
bool | 1 | 布爾值 |
int8 | 2 | 帶符號(hào)的一個(gè)字符 |
uint8 | 3 | 帶符號(hào)的一個(gè)字符 |
int16 | 4 | 16位有符號(hào)整型 |
uint16 | 5 | 16位無(wú)符號(hào)整型 |
int32 | 6 | 32位有符號(hào)整型 |
uint32 | 7 | 32位無(wú)符號(hào)整型 |
… | ||
string | 12 | 字符串或二進(jìn)制序列 |
struct | 13 | 自定義的結(jié)構(gòu),嵌套使用 |
list | 14 | 有序列表 |
map | 15 | 無(wú)序列表 |
按照ttlv序列化后,內(nèi)存組織如下
改完后,A和B發(fā)現(xiàn),的確帶來(lái)很多好處,不光可以隨心所以的增刪字段,還可以修改數(shù)據(jù)類型,例如把cmd改成int cmd;可以無(wú)縫兼容。真是太給力了。
三、跨語(yǔ)言特性
有一天來(lái)了一個(gè)新的同事C,他寫一個(gè)新的服務(wù),需要和A通信,但是C是用java或PHP的語(yǔ)言,沒有無(wú)符號(hào)類型,導(dǎo)致負(fù)數(shù)解析失敗。為了解決這個(gè)問題,A重新規(guī)劃一下協(xié)議類型,做了有些剝離語(yǔ)言特性,定義一些共性。對(duì)使用類型做了強(qiáng)制性約束。雖然帶來(lái)了約束,但是帶來(lái)通用型和簡(jiǎn)潔性,和跨語(yǔ)言性,大家表示都很贊同,于是有了一個(gè)類型(type)規(guī)范。
類型 | Type值 | 類型描述 |
bool | 1 | 布爾值 |
int8 | 2 | 帶符號(hào)的一個(gè)字符 |
int16 | 3 | 16位有符號(hào)整型 |
int32 | 4 | 32位有符號(hào)整型 |
… | ||
string | 12 | 字符串或二進(jìn)制序列 |
struct | 13 | 自定義的結(jié)構(gòu),嵌套使用 |
list | 14 | 有序列表 |
map | 15 | 無(wú)序列表 |
四、代碼自動(dòng)化——IDL語(yǔ)言的產(chǎn)生
但是A和B發(fā)現(xiàn)了新的煩惱,就是每搞一套新的協(xié)議,都要從頭編解碼,調(diào)試,雖然TLV很簡(jiǎn)單,但是寫編解碼是一個(gè)毫無(wú)技術(shù)含量的枯燥體力活,一個(gè)非 常明顯的問題是,由于大量copy/past,不管是對(duì)新手還是老手,非常容易犯錯(cuò),一犯錯(cuò),定位排錯(cuò)非常耗時(shí)。于是A想到使用工具自動(dòng)生成代碼。
IDL(Interface Description Language),它是一種描述語(yǔ)言,也是一個(gè)中間語(yǔ)言,IDL一個(gè)使命就是規(guī)范和約束,就像前面提到,規(guī)范使用類型,提供跨語(yǔ)言特性。通過工具分析idl文件,生成各種語(yǔ)言代碼
Gencpp.exe sample.idl 輸出 sample.cpp sample.h
Genphp.exe sample.idl 輸出 sample.php
Genjava.exe sample.idl 輸出 sample.java
是不是簡(jiǎn)單高效J
四、總結(jié)
大家看到這里,是不是覺得很面熟。是的,協(xié)議講到最后,其實(shí)就是和facebook的thrift和google protocol buffer協(xié)議大同小異了。包括公司無(wú)線使用的jce協(xié)議。咋一看這些協(xié)議的idl文件,發(fā)現(xiàn)幾乎是一樣的。只是有些細(xì)小差異化。
這些協(xié)議在一些細(xì)節(jié)上增加了一些特性:
1、壓縮,這里壓縮不是指gzip之類通用壓縮,是指針對(duì)整數(shù)壓縮,如int類型,很多情況下值是小于127(值為0的情況特別多),就不需要占用4個(gè)字節(jié),所以這些協(xié)議做了一些細(xì)化處理,把int類型按照情況,只使用1/2/3/4字節(jié),實(shí)際上還是一種ttlv協(xié)議。
2、reuire/option 特性: 這個(gè)特性有兩個(gè)作用,1、還是壓縮,有時(shí)候一個(gè)協(xié)議很多字段,有些字段可以帶上也可以不帶上,不賦值的時(shí)候不是也要帶一個(gè)缺省值打包,這樣很浪費(fèi),如果字 段是option特性,沒有賦值的話,就不用打包。2、有點(diǎn)邏輯上約束功能,規(guī)定哪些字段必須有,加強(qiáng)校驗(yàn)。
序列化是通信協(xié)議的基礎(chǔ),不管是信令通道還是數(shù)據(jù)通道,還是rpc,都需要使用到。在設(shè)計(jì)協(xié)議早期就考慮到擴(kuò)展性和跨語(yǔ)言特性。會(huì)為以后省去不少麻煩。
Ps
本篇主要介紹二進(jìn)制通信協(xié)議序列化,沒有講文本協(xié)議。從某種意義來(lái)講,文本協(xié)議天生具有兼容和可擴(kuò)展性。不像二進(jìn)制需要考慮那么多問題。文本協(xié)議易于調(diào)試(如抓包就是可見字符,telnet即可調(diào)試,數(shù)據(jù)包可以手工生成不借助特殊工具),簡(jiǎn)單易學(xué)是其最強(qiáng)大的優(yōu)勢(shì)。
二進(jìn)制協(xié)議優(yōu)勢(shì)就是性能和安全性。但是調(diào)試麻煩。
兩者各有千秋,按需選擇。(stevenrao)