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 面試題 一網打盡
• 瘋狂創客圈 【 博客園 總入口 】