Google Protobuf 使用介紹

直接在 www.google.com.hk 上搜尋google protobuf 後下載下傳官方版本。

官方版本支援C++\Java\Python三門語言。

還有很多非官方的語言版本支援，如C\NET(C#/Vb.net)\Flex(AS3)等.

要通信，必須有協定，否則雙方無法了解對方的碼流。在protobuf中，協定是由一系列的消息組成的。是以最重要的就是定義通信時使用到的消息格式。

Protobuf消息定義

消息由至少一個字段組合而成，類似于C語言中的結構。每個字段都有一定的格式。

字段格式：限定修飾符① | 資料類型② | 字段名稱③ | = | 字段編碼值④ | [字段預設值⑤]

①．限定修飾符包含 required\optional\repeated

Required: 表示是一個必須字段，必須相對于發送方，在發送消息之前必須設定該字段的值，對于接收方，必須能夠識别該字段的意思。發送之前沒有設定required字段或者無法識别required字段都會引發編解碼異常，導緻消息被丢棄。

Optional：表示是一個可選字段，可選對于發送方，在發送消息時，可以有選擇性的設定或者不設定該字段的值。對于接收方，如果能夠識别可選字段就進行相應的處理，如果無法識别，則忽略該字段，消息中的其它字段正常處理。---因為optional字段的特性，很多接口在更新版本中都把後來添加的字段都統一的設定為optional字段，這樣老的版本無需更新程式也可以正常的與新的軟體進行通信，隻不過新的字段無法識别而已，因為并不是每個節點都需要新的功能，是以可以做到按需更新和平滑過渡。

Repeated：表示該字段可以包含0~N個元素。其特性和optional一樣，但是每一次可以包含多個值。可以看作是在傳遞一個數組的值。

②．資料類型

Protobuf定義了一套基本資料類型。幾乎都可以映射到C++\Java等語言的基礎資料類型.

protobuf 資料類型	描述	打包	C++語言映射
bool	布爾類型	1位元組	bool
double	64位浮點數	N	double
float	32為浮點數	N	float
int32	32位整數、	N	int
uin32	無符号32位整數	N	unsigned int
int64	64位整數	N	__int64
uint64	64為無符号整	N	unsigned __int64
sint32	32位整數，處理負數效率更高	N	int32
sing64	64位整數 處理負數效率更高	N	__int64
fixed32	32位無符号整數	4	unsigned int32
fixed64	64位無符号整數	8	unsigned __int64
sfixed32	32位整數、能以更高的效率處理負數	4	unsigned int32
sfixed64	64為整數	8	unsigned __int64
string	隻能處理 ASCII字元	N	std::string
bytes	用于處理多位元組的語言字元、如中文	N	std::string
enum	可以包含一個使用者自定義的枚舉類型uint32	N(uint32)	enum
message	可以包含一個使用者自定義的消息類型	N	object of class

N 表示打包的位元組并不是固定。而是根據資料的大小或者長度。

例如int32，如果數值比較小，在0~127時，使用一個位元組打包。

關于枚舉的打包方式和uint32相同。

關于message，類似于C語言中的結構包含另外一個結構作為資料成員一樣。

關于 fixed32 和int32的差別。fixed32的打包效率比int32的效率高，但是使用的空間一般比int32多。是以一個屬于時間效率高，一個屬于空間效率高。根據項目的實際情況，一般選擇fixed32，如果遇到對傳輸資料量要求比較苛刻的環境，可以選擇int32.

③．字段名稱

字段名稱的命名與C、C++、Java等語言的變量命名方式幾乎是相同的。

protobuf建議字段的命名采用以下劃線分割的駝峰式。例如 first_name 而不是firstName.

④．字段編碼值

有了該值，通信雙方才能互相識别對方的字段。當然相同的編碼值，其限定修飾符和資料類型必須相同。

編碼值的取值範圍為 1~2^32（4294967296）。

其中 1~15的編碼時間和空間效率都是最高的，編碼值越大，其編碼的時間和空間效率就越低（相對于1-15），當然一般情況下相鄰的2個值編碼效率的是相同的，除非2個值恰好實在4位元組，12位元組，20位元組等的臨界區。比如15和16.

1900~2000編碼值為Google protobuf 系統内部保留值，建議不要在自己的項目中使用。

protobuf 還建議把經常要傳遞的值把其字段編碼設定為1-15之間的值。

消息中的字段的編碼值無需連續，隻要是合法的，并且不能在同一個消息中有字段包含相同的編碼值。

建議：項目投入營運以後涉及到版本更新時的新增消息字段全部使用optional或者repeated，盡量不實用required。如果使用了required，需要全網統一更新，如果使用optional或者repeated可以平滑更新。

⑤．預設值。當在傳遞資料時，對于required資料類型，如果使用者沒有設定值，則使用預設值傳遞到對端。當接受資料是，對于optional字段，如果沒有接收到optional字段，則設定為預設值。

關于import

protobuf 接口檔案可以像C語言的h檔案一個，分離為多個，在需要的時候通過 import導入需要對檔案。其行為和C語言的#include或者java的import的行為大緻相同。

關于package

避免名稱沖突，可以給每個檔案指定一個package名稱，對于java解析為java中的包。對于C++則解析為名稱空間。

關于message

支援嵌套消息，消息可以包含另一個消息作為其字段。也可以在消息内定義一個新的消息。

關于enum

枚舉的定義和C++相同，但是有一些限制。

枚舉值必須大于等于0的整數。

使用分号(;)分隔枚舉變量而不是C++語言中的逗号(,)

eg.

enum VoipProtocol 

{

    H323 = 1;

    SIP  = 2;

    MGCP = 3;

    H248 = 4;

}