Protobuf 语法 | 史上最简教程

快来打我* 2023-10-21 07:29 136阅读 0赞

## Protobuf 语法简明教程 ##

##### 疯狂创客圈 死磕Netty 亿级流量架构系列之12 【[博客园 总入口][Link 1] 】 #####

--------------------

在protobuf中，协议是由一系列的消息组成的。因此最重要的就是定义通信时使用到的消息格式。

一个Protobuf 消息（对应JAVA类），由至少一个字段（对应Java类属性）组合而成。

**每个Protobuf 消息的 字段 都有一定的格式。**

##### 字段格式： #####

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

###### Required: ######

表示是一个必须字段，必须相对于发送方，在发送消息之前必须设置该字段的值，对于接收方，必须能够识别该字段的意思。发送之前没有设置required字段或者无法识别required字段都会引发编解码异常，导致消息被丢弃。

###### Optional： ######

表示是一个可选字段，可选对于发送方，在发送消息时，可以有选择性的设置或者不设置该字段的值。对于接收方，如果能够识别可选字段就进行相应的处理，如果无法识别，则忽略该字段，消息中的其它字段正常处理。—因为optional字段的特性，很多接口在升级版本中都把后来添加的字段都统一的设置为optional字段，这样老的版本无需升级程序也可以正常的与新的软件进行通信，只不过新的字段无法识别而已，因为并不是每个节点都需要新的功能，因此可以做到按需升级和平滑过渡。

###### Repeated： ######

表示该字段可以包含0~N个元素。其特性和optional一样，但是每一次可以包含多个值。可以看作是在传递一个数组的值。

##### ②．数据类型 #####

Protobuf定义了一套基本数据类型。几乎都可以映射到C++\\Java等语言的基础数据类型.

<table> 
 <thead> 
  <tr> 
   <th>protobuf 数据类型</th> 
   <th>描述</th> 
   <th>打包</th> 
   <th>C++语言映射</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>bool</td> 
   <td>布尔类型</td> 
   <td>1字节</td> 
   <td>bool</td> 
  </tr> 
  <tr> 
   <td>double</td> 
   <td>64位浮点数</td> 
   <td>N</td> 
   <td>double</td> 
  </tr> 
  <tr> 
   <td>float</td> 
   <td>32为浮点数</td> 
   <td>N</td> 
   <td>float</td> 
  </tr> 
  <tr> 
   <td>int32</td> 
   <td>32位整数、</td> 
   <td>N</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>uin32</td> 
   <td>无符号32位整数</td> 
   <td>N</td> 
   <td>unsigned int</td> 
  </tr> 
  <tr> 
   <td>int64</td> 
   <td>64位整数</td> 
   <td>N</td> 
   <td>__int64</td> 
  </tr> 
  <tr> 
   <td>uint64</td> 
   <td>64为无符号整</td> 
   <td>N</td> 
   <td>unsigned __int64</td> 
  </tr> 
  <tr> 
   <td>sint32</td> 
   <td>32位整数，处理负数效率更高</td> 
   <td>N</td> 
   <td>int32</td> 
  </tr> 
  <tr> 
   <td>sing64</td> 
   <td>64位整数 处理负数效率更高</td> 
   <td>N</td> 
   <td>__int64</td> 
  </tr> 
  <tr> 
   <td>fixed32</td> 
   <td>32位无符号整数</td> 
   <td>4</td> 
   <td>unsigned int32</td> 
  </tr> 
  <tr> 
   <td>fixed64</td> 
   <td>64位无符号整数</td> 
   <td>8</td> 
   <td>unsigned __int64</td> 
  </tr> 
  <tr> 
   <td>sfixed32</td> 
   <td>32位整数、能以更高的效率处理负数</td> 
   <td>4</td> 
   <td>unsigned int32</td> 
  </tr> 
  <tr> 
   <td>sfixed64</td> 
   <td>64为整数</td> 
   <td>8</td> 
   <td>unsigned __int64</td> 
  </tr> 
  <tr> 
   <td>string</td> 
   <td>只能处理 ASCII字符</td> 
   <td>N</td> 
   <td>std::string</td> 
  </tr> 
  <tr> 
   <td>bytes</td> 
   <td>用于处理多字节的语言字符、如中文</td> 
   <td>N</td> 
   <td>std::string</td> 
  </tr> 
  <tr> 
   <td>enum</td> 
   <td>可以包含一个用户自定义的枚举类型uint32</td> 
   <td>N(uint32)</td> 
   <td>enum</td> 
  </tr> 
  <tr> 
   <td>message</td> 
   <td>可以包含一个用户自定义的消息类型</td> 
   <td>N</td> 
   <td>object of class</td> 
  </tr> 
 </tbody> 
</table>

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.