Protobuf 語法 - 史上最簡教程
Protobuf 語法簡明教程
瘋狂創客圈 死磕Netty 億級流量架構系列之12 【部落格園 總入口 】
在protobuf中，協議是由一系列的訊息組成的。因此最重要的就是定義通訊時使用到的訊息格式。
一個Protobuf 訊息（對應JAVA類），由至少一個欄位（對應Java類屬性）組合而成。
每個Protobuf 訊息的 欄位 都有一定的格式。
欄位格式：
限定修飾符① | 資料型別② | 欄位名稱③ | = | 欄位編碼值④ | [欄位預設值⑤]
①．限定修飾符包含 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
列舉的定義和Java 相同，但是有一些限制。
列舉值必須大於等於0的整數。
使用分號(;)分隔列舉變數而不是Java 語言中的逗號(,)
eg.
enum VoipProtocol
{
H323 = 1;
SIP = 2;
MGCP = 3;
H248 = 4;
}
瘋狂創客圈 實戰計劃
- Netty 億級流量 高併發 IM後臺 開源專案實戰
- Netty 原始碼、原理、JAVA NIO 原理
- Java 面試題 一網打盡
- 瘋狂創客圈 【 部落格園 總入口 】