九.Protobuf3特殊类型

Protobuf3 Any类型

  Any消息类型允许您将消息作为嵌入类型，而不需要它们 .proto定义。Any包含任意序列化的消息(字节)，以及一个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>()) {
    NetworkErrorDetails network_error;
    detail.UnpackTo(&network_error);
    ... processing network_error ...
  }
}

  目前正在开发用于处理ANY类型的运行时库。

  如果您已经熟悉proto2语法，ANY类型会替换扩展名。

Protobuf3 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++中，如果你Swap()两条oneof消息，每条消息将以另一条的oneof结尾:在下面的示例中，msg1将有一条子消息，msg2将有一个名字。

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

向后兼容性问题

  添加或删除oneof字段时要小心。如果检查oneof的值会返回None / NOT _ SET，这可能意味着其中一个没有被设置，或者它已经被设置为oneof的不同版本中的字段。没有办法区分这两者，因为没有办法知道线上的未知区域是否是oneof的成员。

标签重用问题

  将字段移入或移出:在序列化和解析消息后，您可能会丢失一些信息(一些字段将被清除)。但是，您可以安全地将单个字段移动到新的字段中，如果已知只有一个字段被设置，您也可以移动多个字段。

  删除一个字段并将其添加回去:这可能会在消息序列化和解析后清除当前设置的一个字段。

  拆分或合并其中一个:这与移动常规字段有类似的问题。

Protobuf3 Maps

  如果要创建关联映射作为数据定义的一部分，协议缓冲区提供了一种方便快捷的语法:

map<key_type, value_type> map_field = N;

  其中key_type可以是任何整数或字符串类型(除浮点类型和字节以外的任何标量类型)。请注意，枚举不是有效的key_type,value_type可以是除另一个映射之外的任何类型。

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

map<string, Project> projects = 3;

  映射字段不能重复。

  map值线格式排序和map迭代排序未定义，因此您不能依赖于项目的map特定顺序。

  为生成文本格式时。proto，地图按键排序。数字键按数字排序。

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

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

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

  生成的map API目前可用于所有受支持的proto3语言。你可以在相关的API参考中找到更多关于你选择的语言的map API。

向后兼容性

  map语法相当于线上的以下内容，因此不支持map的协议缓冲区实现仍然可以处理数据:

message MapFieldEntry {
  key_type key = 1;
  value_type value = 2;
}

repeated MapFieldEntry map_field = N;

  任何支持映射的协议缓冲区实现都必须生成和接受可以被上述定义的数据。