目录
首先让我们看一个非常简单的例子。假设你要定义一个分页搜索请求消息格式,其中每个搜索请求都有一个查询字符串、你感兴趣的特定结果页面以及每页的多个结果。这是.proto
你用来定义消息类型的文件。
syntax = "proto3";
message SearchRequest {
string query = 1;
int32 page_number = 2;
int32 result_per_page = 3;
}
- 文件的第一行指定你使用的是
proto3
语法:如果你不这样做,Protocol Buffers编译器将假定你使用的是proto2。这必须是文件的第一个非空、非注释行。 SearchRequest
消息定义指定了三个字段(名称/值对),每个字段用于你希望包含在此类消息中的每条数据。每个字段都有一个名称和一个类型。
指定字段类型
在上面的示例中,所有字段都是标量类型:两个整数(page_number
和result_per_page
)和一个字符串(query
)。但是,你也可以为字段指定复合类型,包括枚举和其他消息类型。
分配字段编号
消息定义中的每个字段都有一个唯一的编号。这些字段编号用于在消息二进制格式中标识你的字段,并且在使用你的消息类型后不应更改。
请注意,1 到 15 范围内的字段编号需要一个字节进行编码,包括字段编号和字段类型(你可以在Protocol Buffer Encoding中找到有关此的更多信息)。16 到 2047 范围内的字段编号占用两个字节。因此,你应该为非常频繁出现的消息元素保留数字 1 到 15。请记住为将来可能添加的频繁出现的元素留出一些空间。
你可以指定的最小字段编号是 1,最大的是 2 29 - 1,即 536,870,911。你也不能使用数字 19000 到 19999(
FieldDescriptor::kFirstReservedNumber
到FieldDescriptor::kLastReservedNumber
),因为它们是为 Protocol Buffers 实现保留的 - 如果你在.proto
. 同样,你不能使用任何以前保留的字段编号。
指定字段规则
消息字段可以是以下之一:
- 单数:符合语法规则的消息可以有零个或一个此字段(但不能超过一个)。这是 proto3 语法的默认字段规则。
repeated
:该字段可以在符合语法规则的消息中重复任意次数(包括零次)。重复值的顺序将被保留。
在 proto3 中,repeated
标量数值类型的字段packed
默认使用编码。
你可以在Protocol Buffer Encoding中找到有关packed
编码的更多信息。
添加更多消息类型
可以在单个.proto
文件中定义多种消息类型。如果你要定义多个相关消息,这很有用——例如,如果你想定义与你的SearchResponse
消息类型相对应的回复消息格式,你可以将其添加到相同的.proto
:
message SearchRequest {
string query = 1;
int32 page_number = 2;
int32 result_per_page = 3;
}
message SearchResponse {
...
}
添加注释
要向.proto
文件添加注释,请使用 C/C++ 样式//
和/* ... */
语法。
/* SearchRequest represents a search query, with pagination options to
* indicate which results to include in the response. */
message SearchRequest {
string query = 1;
int32 page_number = 2; // Which page number do we want?
int32 result_per_page = 3; // Number of results to return per page.
}
保留字段
如果你通过完全删除某个字段或将其注释掉来更新消息类型,未来的用户可以在对类型进行自己的更新时重用该字段编号。如果他们稍后加载相同的旧版本,这可能会导致严重问题.proto
,包括数据损坏、隐私错误等。确保不会发生这种情况的一种方法是指定已删除字段的字段编号(和/或名称,这也可能导致 JSON 序列化问题)为reserved
. 如果将来有任何用户尝试使用这些字段标识符,protocol buffer 编译器会报错。
message Foo {
reserved 2, 15, 9 to 11;
reserved "foo", "bar";
}
请注意,你不能在同一reserved
语句中混合字段名称和字段编号。
编译器将生成什么?
当你编译一个.proto
文件时,编译器会以你选择的语言生成代码,你需要使用文件中描述的消息类型,包括获取和设置字段值,将消息序列化到输出流,并从输入流中解析你的消息。
- 对于C++,编译器从每个
.proto
生成一个.h
and.cc
文件,并为文件中描述的每种消息类型提供一个类。 - 对于Java,编译器会
.java
为每种消息类型生成一个包含类的文件,以及Builder
用于创建消息类实例的特殊类。 - 对于Kotlin,除了 Java 生成的代码之外,编译器还会
.kt
为每种消息类型生成一个文件,其中包含可用于简化创建消息实例的 DSL。 - Python有点不同——Python 编译器会生成一个模块*,*
.proto
其中包含你的 . - 对于Go,编译器会为
.pb.go
文件中的每个消息类型生成一个文件类型。 - 对于Ruby,编译器会生成一个
.rb
带有 Ruby 模块的文件,其中包含你的消息类型。 - 对于Objective-C,编译器从每个
.proto
生成一个pbobjc.h
andpbobjc.m
文件.proto
,并为文件中描述的每种消息类型提供一个类。 - 对于C#,编译器会
.cs
从 每个.proto
生成一个文件.proto
,其中包含文件中描述的每种消息类型的类。 - 对于Dart,编译器会为文件中的每种消息类型生成一个
.pb.dart
带有类的文件。
你可以按照所选语言的教程(即将推出 proto3 版本)了解有关使用每种语言的 API 的更多信息。有关更多 API 详细信息,请参阅相关API 参考(proto3 版本也即将推出)。