Protobuf 风格指南
Protobuf 风格指南
本文档为 .proto文件提供了样式指南。通过遵循这些约定,您将使您的协议缓冲区消息定义及其对应的类一致且易于阅读。
消息和字段名称
使用CamelCase (首字母大写)作为消息名,例如SongServerRequest。字段名称使用下划线分隔名称,例如song_name。
message SongServerRequest { required string song_name = 1; }
对字段名使用这种命名约定可以为您提供如下访问器:
C++:
const string& song_name() { ... } void set_song_name(const string& x) { ... }
Java:
public String getSongName() { ... } public Builder setSongName(String v) { ... }
枚举
枚举类型名使用CamelCase (带首字母大写),值名使用CAPITALS_WITH_UNDERSCORES:
enum Foo { FIRST_VALUE = 0; SECOND_VALUE = 1; }
每个枚举值应以分号结束,而不是逗号。
服务
如果您的.proto定义了一个RPC服务,那么您应该对服务名称和任何RPC方法名称都使用CamelCase (带有初始大写) :
service FooService { rpc GetSomething(FooRequest) returns (FooResponse); }
除非另有说明,本页面的内容是根据知识共享属性3.0许可证许可的,代码示例是根据Apache 2.0许可证许可的。有关详细信息,请参见谷歌的网站策略。Java是甲骨文和/或其附属公司的注册商标。