Protobuf语法介绍

我们先看看官方文档给出的定义和描述

简单来讲， ProtoBuf 是结构数据序列化方法，可简单类比于，其具有以下特点：

在protobuf中，协议是由一系列的消息组成的。因此最重要的就是定义通信时使用到的消息格式。一个Protobuf 消息（对应JAVA类），由至少一个字段（对应Java类属性）组合而成。

消息的定义很简单，就是message关键字加上消息的名字

字段定义格式：

限定修饰符 | 数据类型 | 字段名称 | = | 字段编码

required:

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

optional：

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

repeated:

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

protobuf定义了一套基本的数据类型，几乎都映射了Java语言的基础数据类型（主要以Java为例）

详见下面表格

字段的命名方式与Java的命名方式大致一致

字段编码是一个序列化和反序列化的标记值，有了该值，通信双方才能互相识别对方的字段。当然相同的编码值，其限定修饰符和数据类型必须相同。编码值的取值范围为 1~2^32（4294967296）

其中 1~15的编码时间和空间效率都是最高的，编码值越大，其编码的时间和空间效率就越低（相对于1-15），当然一般情况下相邻的2个值编码效率的是相同的，除非2个值恰好实在4字节，12字节，20字节等的临界区。比如15和16

1900~2000编码值为Google protobuf 系统内部保留值，建议不要在自己的项目中使用。protobuf 还建议把经常要传递的值把其字段编码设置为1-15之间的值

完整的消息定义示例

枚举的定义和Java 相同，使用 enum 关键字，但是有一些限制。

枚举值必须大于等于0的整数。

使用分号 分隔枚举变量而不是Java 语言中的逗号 ,

示例：

你可以将其他消息类型用作字段类型。已我们现在IM的为例，在每一个CSSendLiveRoomMsgReq消息中包含ImMsgBody消息，此时可以在相同的.proto文件中定义一个ImMsgBody消息类型，然后在CSSendLiveRoomMsgReq消息中指定一个ImMsgBody类型的字段

示例：

如果你的消息中有很多可选字段， 并且同时至多一个字段会被设置， 你可以加强这个行为，使用oneof特性节省内存，Oneof字段就像可选字段， 除了它们会共享内存， 至多一个字段会被设置。 设置其中一个字段会清除其它字段。

为了在.proto定义Oneof字段， 你需要在名字前面加上oneof关键字, 比如下面例子的ImMsgBody:

oneof的特性

ProtoBuf （Google Protocol Buffer）是由google公司用于数据交换的序列结构化数据格式，具有跨平台、跨语言、可扩展特性，同类型有常用的XML及JSON，但具有更小的传输体积、更高的编码、解码能力，特别适合于数据存储、网络数据传输等对存储体积、实时性要求高的领域，目前已经发展到protoc3 版本。

优点：空间效率高，时间效率要高，对于数据大小敏感，传输效率高的

缺点：消息结构可读性不高，序列化后的字节序列为二进制序列不能简单的分析有效性

备注：最后的时间类型golang需要引入包 github.com/golang/protobuf/ptypes/timestamp ,定义如下

然后 .protp 文件需要导入 google/protobuf/timestamp.proto

如果一个字段被 repeated 修饰，则表示它是一个列表类型的字段，相当于 golang 里的切片

如果你希望可以预留一些数字标签或者字段可以使用reserved修饰符

第一个枚举值的数值必须是0且至少有一个枚举值，一个数值可以对应多个枚举值，必须标明 option allow_alias = true不推荐使用负数值

在你的 .proto 文件中指定 service ,然后在 service 里定义 rpc方法 即可，要注意指定参数和返回值

gRPC 允许你定义4种类型的 service 方法

客户端使用存根发送请求到服务器并等待响应返回，就像平常的函数调用一样

通过在 响应返回参数 类型前插入 stream 关键字，可以指定一个服务器端的流方法。客户端发送请求到服务器，拿到一个流去读取返回的消息序列。 客户端读取返回的流，直到里面没有任何消息。

通过在 请求参数 类型前指定 stream 关键字来指定一个客户端的流方法。客户端写入一个消息序列并将其发送到服务器，同样也是使用流。一旦客户端完成写入消息，它等待服务器完成读取返回它的响应。

通过在请求和响应前加 stream 关键字去制定方法的类型。两个流独立 *** 作，因此客户端和服务器可以以任意喜欢的顺序读写：比如， 服务器可以在写入响应前等待接收所有的客户端消息，或者可以交替的读取和写入消息，或者其他读写的组合。

这个词正确的是proton，意思是质子。

质子(proton)是一种带 1.6 × 10-19库仑(C)正电荷的亚原子粒子，直径约 1.6~1.7×1015m ，质量是938百万电子伏特/c(MeV/c)，即1.672621637（83）×10-27千克，大约是电子质量的1836.5倍（电子的质量为9.10938215（45）×10-31千克），质子比中子稍轻（中子的质量为1.674927211（84）×10-27千克）。

氧元素是第二周期的元素，所以氧原子只有2个电子层内从层2个，外层6个，共8个电子；而氧原子的质子数也是8个。符合核外电子数=质子数，所以氧原子本身是电中性的，不带电荷。

事实上所有的原子都是电中性的，都符合【质子数】=【原子序数】=【核电荷数】=【核外电子数】

每种物质中的原子的核外电子数一定是等于该原子的质子数，但是这并不是说这种结构是稳定的结构，这只是元素原子的一个特性。比如钠原子就非常不稳定，很容易失去一个电子变成Na+，带一个正电荷，达到稳定结构。注意此时带电荷是因为变成了离子。对于未失去电子的Na原子来说，还是符合核外电子数=质子数。

希望我能帮助你解疑释惑。

---