protobuf3 语法详解 pdf
5星 · 超过95%的资源 需积分: 21 93 浏览量
2022-07-17
21:17:49
上传
评论
收藏 733KB PDF 举报 
该文档为protobuf3.0语言，和2.0语法有兼容性问题。
《Protobuf语法指南（proto2）》见https://blog.csdn.net/qq_22660775/article/details/89044538
定义一个消息类型
先来看一个非常简单的例子。假设你想定义一个“搜索请求”的消息格式，每一个请求含有一个查询字符串、你感兴趣的查询结果
所在的页数，以及每一页多少条查询结果。可以采用如下的方式来定义消息类型的.proto文件了
文件的第一行指定了你正在使用proto3语法：如果你没有指定这个，编译器会使用proto2。这个指定语法行必须是文件的非
空非注释的第一个行。
SearchRequest消息格式有3个字段，在消息中承载的数据分别对应于每一个字段。其中每个字段都有一个名字和一种类
型。
指定字段类型
在上面的例子中，所有字段都是标量类型：两个整型（page_number和result_per_page），一个string类型（query）。当然，你
也可以为字段指定其他的合成类型，包括枚举（enumerations）或其他消息类型。
分配标识号
正如你所见，在消息定义中，每个字段都有唯一的一个数字标识符。这些标识符是用来在消息的二进制格式中识别各个字段的，
一旦开始使用就不能够再改变。注：[1,15]之内的标识号在编码的时候会占用一个字节。[16,2047]之内的标识号则占用2个字节。
所以应该为那些频繁出现的消息元素保留[1,15]之内的标识号。切记：要为将来有可能添加的、频繁出现的标识号预留一些标识
号。
最小的标识号可以从1开始，最大到2^291,or536,870,911。不可以使用其中的[19000－19999]（(从
FieldDescriptor::kFirstReservedNumber到FieldDescriptor::kLastReservedNumber)）的标识号，Protobuf协议实现中对这些进
行了预留。如果非要在.proto文件中使用这些预留标识号，编译时就会报警。同样你也不能使用早期保留的标识号。
指定字段规则
所指定的消息字段修饰符必须是如下之一：
singular：一个格式良好的消息应该有0个或者1个这种字段（但是不能超过1个）（默认为singular，而且显示写上singular关
键字会报错，这个是Google的一个坑）。
repeated：在一个格式良好的消息中，这种字段可以重复任意多次（包括0次）。重复的值的顺序会被保留。
在proto3中，repeated的标量域默认情况下使用packed。
你可以了解更多的pakced属性在ProtocolBuffer编码
syntax="proto3";
messageSearchRequest{
stringquery=1;
int32page_number=2;
int32result_per_page=3;
}
1
2
3
4
5
6
7
剩余11页未读，继续阅读
- 1
- 2
前往页