确定协议缓冲区消息类型的最佳实践

Question

我需要对字节流中的一系列协议缓冲区消息进行序列化和反序列化.有一些预定的消息类型.编码类型信息的推荐方法是什么,以便我的应用程序可以知道它应该读取哪种类型？

Answer 1

最常见的方法是使用union消息.

例如:

message AnyMessage {
    optional Message1 msg1 = 1;
    optional Message2 msg2 = 2;
    ...
}

然后,所有消息都在AnyMessage容器内编码/解码.从protobuf 2.6开始,您还可以使用说明oneof符,该说明符将确保仅设置其中一个子消息.

Answer 2

我的建议（排名不分先后）是：

1. 包含一个保存原型名称/id 的字段（并在所有原型中为其指定相同的字段编号，如 1）

2. 使用自我描述消息（位于页面底部）。在这种情况下，您可以

   • 包含FileDescriptorSet作为字段（在您的消息中）
   • 在 java（和其他一些实现）中，您可以将 FileDescriptor 集编写为分隔文件中的第一条消息。

3. 保持原始名称较小并在文件名中使用原始名称，例如

   salesProto_Store001.bin

   这有几个好处：

   • 文件格式是什么一目了然
   • 您可以扫描 shell 脚本来查找使用 proto 的位置。
   • 该技术可以单独使用，也可以与上述 2 种技术结合使用。
   • 此技术可用于任何基于模式的文件（例如 Cobol）。

最后是ProtobufEditor

• 支持自描述消息，其中

  • 文件描述符是分隔文件中的第一条消息
  • 消息中的第一个字段

• 具有搜索功能，它将尝试将Protobuf 消息中的字段与已知的Proto 定义文件进行匹配，并为您提供可能的匹配项

背景： 如果您不知道，protocol buffers proto 文件可以转换为FileDescriptorSet protocol buffer 消息并存储

自我描述消息：

message SelfDescribingMessage {
  // Set of .proto files which define the type.
  required FileDescriptorSet proto_files = 1;

  // Name of the message type.  Must be defined by one of the files in
  // proto_files.
  required string type_name = 2;

  // The message data.
  required bytes message_data = 3;
}