翻译自:Style Guide

本文提供了.proto文件的样式指南,遵循这些约定,可以使Protocol Buffersmessage定义与其生成的类更容易阅读。

消息和字段名

消息名以驼峰式命名(首字符大写)例如: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) { ... }

枚举

枚举名以驼峰式命名(首字符大写),使用以下划线分割大写字符拼写单词的方式命名枚举值名称。示例如下 :

enum Foo {
  FIRST_VALUE = 0;
  SECOND_VALUE = 1;
}

每个枚举值以分号(;)结尾,不是逗号(,)。

服务

如果.proto定义了RPC服务,服务名和RPC方法都应以驼峰式命名(首字符大写)。

service FooService {
  rpc GetSomething(FooRequest) returns (FooResponse);
}