proto3相较于proto2支持更多语言但在语法上更为简洁。去除了一些复杂的语法和特性,更强调约定而弱化语法。
不可否认由于proto3在语法上进行了大量简化,使得proto格式无论是在友好性上、还是灵活性上都有了大幅提升。但是由于删除了presence、required及默认值这些内容,导致proto结构中的所有字段都成了optional(可选字段)类型。这在实际使用过程出现了如下问题:
Introducing a new keyword or reusing an existing keyword to support field presence in proto3 will complicate protobuf semantics. We believe it will lead to confusion and misuse, which defeats the purpose of removing field presence in proto3.
at the moment we recommend users to design their proto3 protos without relying on field presence.
方案介绍
经过研究发现google已经意识到这个问题,采取了一些补救方法—提供wrappers包。该包位于github.com/golang/protobuf/ptypes/wrappers/wrappers.proto,proto文件中包含以下消息类型:
以Int32Value为例,其包装方法如下:
// Wrapper message for `int32`.
//
// The JSON representation for `Int32Value` is JSON number.
message Int32Value {
// The int32 value.
int32 value = 1;
}
示例
import "google/protobuf/wrappers.proto";
message Test {
google.protobuf.Int32Value a = 1;
}
优缺点:
优点:描述简洁清晰
缺点: 使用该方案会使结构变大,每在一个字段使用都会增加2个字节。
方案介绍
另外还可以使用oneof来达到目的,oneof与数据结构联合体(UNION)有点类似,一次最多只有一个字段有效,一般是为了节省存储空间。针对本文所遇到的问题则是将需要处理的字段通过oneof进行包装。
示例
message Test {
oneof a_oneof {
int32 a = 1;
}
}
可以使用test.getAOneofCase()来检查a是否被设置。
优缺点
优点:向后兼容proto2
缺点: 不能使用在repeated类型字段
方案介绍
该方案主要通过实现一个自定义的nullable关键字来解决字段是否能够为空的问题。 修改详细可参考: https://github.com/criteo-forks/protobuf/commit/8298aff178ccffd0c7c99806e714d0f14f40faf8
示例
message Test {
nullable int32 a = 1;
}
优缺点
优点:描述简洁清晰
缺点:
方案介绍
还有人通过map<int32,bool>来解决问题,每当一个字段被设置时,bool值则被设置为true(默认值也是)。另外如果设置的不是默认值时,还需要在每个字段的setter方法中增加hasXXX方法。详情参见:https://github.com/google/protobuf/issues/2684
示例
message Test {
map<int32, bool> a = 1;
}
优缺点
优点:
缺点:
优先推荐使用wrapper方案,我们项目中也使用的这种方案,如果对消息结构大小敏感则优先采用oneof方案。