风格指南

注: 内容翻译来自官网资料 Style Guide.

这个文档为.proto文件提供风格指南. 通过遵循下列约定, 可以让protocol buffer消息定义和他们对应的类保持一致并容易阅读.

消息和字段名

消息名使用驼峰法 - 例如, SongServerRequest. 字段名使用下划线分隔 - 例如, song_name.

  1. message SongServerRequest {
  2.   required string song_name = 1;
  3. }

为字段名使用这种命名约定可以得到如下的访问器:

C++:

  1.   const string& song_name() { ... }
  2.   void set_song_name(const string& x) { ... }

Java:

  1.   public String getSongName() { ... }
  2.   public Builder setSongName(String v) { ... }

枚举

枚举类型名使用驼峰法(首字母大写), 值的名字使用大写加下划线分隔:

  1. enum Foo {
  2.   FIRST_VALUE = 1;
  3.   SECOND_VALUE = 2;
  4. }

每个枚举值以分号(;)结束, 不要用逗号(,).

服务

如果.proto文件定义RPC服务, 服务名和任何rpc方法应该用驼峰法(首字母大写):

  1. service FooService {
  2.   rpc GetSomething(FooRequest) returns (FooResponse);
  3. }