protocol-buffers - Protobuf 命名约定

Question

除了 Google 提供的相当短的 style guide ，这是我对命名 Google Protocol Buffer 消息的想法。

在消息类型名称的末尾使用“消息”。

这使得在源代码中很容易看到一个类是一个 protobuf 生成的类。这也有一个好处，如果我有一个丰富的域特定类，那么它可以有真实的名字，比如 protobuf 类的 AddressBookMes​​sage 和真实类的 AddressBook。

对于 Java 用户，似乎有 java_outer_classname结束于 Protos是标准的。

我最初没有注意到这一点，所以我当前的 protobuf 类在 com.example.project.protobuf.MyProtos 中，但我认为没有理由将其保留在那里，因为我们需要一个包含类，因此可以将其移至 com.example.protobuf.MyProtos除非项目的顶层包中没有类。

从 0 开始枚举以匹配 C/C++。

对重复字段使用单数名称。

大多数生成的方法使用单数字段名称听起来更好，即使它是重复的，例如message->add_child()，而不是 message->add_children() 如果有重复的子字段。

人们是否使用其他标准或与这些标准不同？

Answer 1

免责声明:来自 Google 员工每天使用 protobufs 的回答。我绝不以任何方式代表 Google。

不要那样做。编译后的 Protocol Buffer 只是您使用的语言指定的类定义，并进行了一些改进。添加“消息”是额外的冗长。通常你只使用没有其他类定义的 Protocol Buffer ，即使你使用其他类定义，只需导入 java_outer_classname 并从中做一个点。你甚至可以在代码中放置一个事物的完整路径来删除一行导入，没问题。

虽然没有正式指定，但这听起来是一个很好的建议，因为通常你会在一个文件夹中放置多个 proto。

您通常从 0 开始。请参阅 Protocol Buffer 语言指南。

是的。阅读以下内容以获得一些使用感受:https://developers.google.com/protocol-buffers/docs/javatutorial