Protobuf 指南
永远不要使用 required
随着项目的发展,任何字段都可能变为可选。但如果它被定义为 required,则无法删除。
因此不应该使用 required
。
永远不要更改序号
为了向后兼容,字段的序号不应该被更改。
命名
文件名
消息的名称都为小写,单词之间用下划线分隔。文件应该以 .proto
结尾。
my_message.proto // Good
mymessage.proto // Bad
my_message.pb // Bad
消息名称
消息名称以大写字母开头,每个新单词的首字母都大写,没有下划线,并以 PB
作为后缀:MyMessagePB
message MyMessagePB // Good
message MyMessage // Bad
message My_Message_PB // Bad
message myMessagePB // Bad
字段名
消息的名称都为小写,单词之间用下划线分隔。
optional int64 my_field = 3; // Good
optional int64 myField = 3; // Bad