protocol buffers指南------Any、Oneof、map

Any

• 作为嵌套类型，不用include定义
• 包含任意序列化的消息(字节)，以及一个URL，该URL充当该消息的全局唯一标识符并解析为该消息的类型。

使用Any类型, 需要导入google/protobuf/any.proto.

官方示例

import "google/protobuf/any.proto";

message ErrorStatus {
  string message = 1;
  repeated google.protobuf.Any details = 2;
}

指定消息类型的默认类型URL是type.googleapis.com/packagename.messagename
不同的语言实现将支持运行时库助手以typesafe方式打包和解压缩ANY类型的值——例如，在Java中，任何类型都有特殊的pack()和unpack()访问器，而在c++中有PackFrom()和UnpackTo()方法:

// Storing an arbitrary message type in Any.
NetworkErrorDetails details = ...;
ErrorStatus status;
status.add_details()->PackFrom(details);

// Reading an arbitrary message from Any.
ErrorStatus status = ...;
for (const Any& detail : status.details()) {
  if (detail.Is()) {
    NetworkErrorDetails network_error;
    detail.UnpackTo(&network_error);
    ... processing network_error ...
  }
}

更多功能还在开发中，可以关注版本的迭代情况

Oneof

如果您有一条包含许多字段的消息，并且最多同时设置一个字段，您可以使用其中oneof功能来强制执行此行为并节省内存。

Oneof 字段类似于常规字段，除了Oneof共享内存的所有字段之外，最多可以同时设置一个字段。设置Oneof 的任何成员都会自动清除所有其他成员。您可以使用case()或WhichOneof()方法检查Oneof 中的哪个值被设置(如果有的话)，具体取决于您选择的语言。

使用Oneof
在您的 .proto中定义一个oneof 关键字后跟着oneof 名称，在本例中为test_oneof:

message SampleMessage {
oneof test_oneof {
string name = 4;
SubMessage sub_message = 9;
}
}
然后将您的oneof字段添加到oneof定义中。您可以添加任何类型的字段，但不能使用重复字段。

在生成的代码中，oneof字段具有与常规字段相同的setter和getter方法。您还可以获得一种特殊的方法来检查中的哪个值(如果有的话)被设置。你可以在相关的API参考中找到更多关于你选择的语言的API。

Oneof功能
设置oneof字段将自动清除oneof字段的所有其他成员。因此，如果您设置了几个oneof字段，则只有最后一个字段仍然有值。

SampleMessage message;
message.set_name("name");
CHECK(message.has_name());
message.mutable_sub_message();   // Will clear name field.
CHECK(!message.has_name());

• 如果解析器遇到同一oneof的多个成员，则在解析的消息中只使用最后一个成员。
• oneof不能重复。
• 反射APIs适用于oneof字段。
• 如果您正在使用c++，请确保代码不会导致内存崩溃。下面的示例代码将导致内存崩溃，因为它通过set_name()方法调用了已经删除掉的sub_message。

SampleMessage message;
SubMessage* sub_message = message.mutable_sub_message();
message.set_name("name");      // Will delete sub_message
sub_message->set_...            // Crashes here

• 同样在C++中，如果使用同一个带有oneof类型数据的消息，两个消息可以通过swap互相改变彼此的oneof

SampleMessage msg1;
msg1.set_name("name");
SampleMessage msg2;
msg2.mutable_sub_message();
msg1.swap(&msg2);
CHECK(msg1.has_sub_message());
CHECK(msg2.has_name());

Maps

创建关联映射

map map_field = N;

其中key_type可以是任何整数或字符串类型(除浮点类型和字节以外的任何标量类型)。枚举不是有效的key_type,value_type可以是除map之外的任何类型。

例如，如果您想为一个项目创建map，其中每个消息都与一个字符串键相关联，您可以这样定义它:

map projects = 3;

• map不能设置为repeated

• map的遍历是无序的

• 为proto生成文本格式时，map按key排序。数字key按数字排序。

• 从线上解析或合并时，如果有重复的map键，则使用最后的键。从文本格式解析map时，如果存在重复的键，解析可能会失败。

• 如果为映射字段提供了键但没有值，则序列化该字段时的行为取决于语言。在c++、Java和Python中，序列化该类型的默认值，而在其他语言中，不进行序列化。

更多map的api参考 API reference