规范指引

Go 小白理念 /

本文档提供了 .proto 文件的书写风格指南。通过遵守这些约定，你的protocol buffer 消息定义和它们的对应类将会风格一致且易于阅读。

Message 和字段命名

使用驼峰命名法（首字母大写）命名 message，例子：SongServerRequest
使用下划线命名字段，栗子：song_name

message SongServerRequest {
  required string song_name = 1;
}

使用上述这种字段的命名约定，生成的访问器将类似于如下代码：

Java:
  public String getSongName() { ... }
  public Builder setSongName(String v) { ... }

使用驼峰命名法（首字母大写）命名枚举类型，使用 大写_下划线_大写(CAPITALS_WITH_UNDERSCORES) 的方式命名枚举值：

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

每一个枚举值以分号结尾，而非逗号。

如果你在 .proto 文件中定义 RPC 服务，你应该使用驼峰命名法（首字母大写）命名 RPC 服务以及其中的 RPC 方法：

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

本文章首发在 LearnKu.com 网站上。