Protocol buffers編寫風格指南
阿新 • • 發佈:2019-01-14
原文連結:https://developers.google.com/protocol-buffers/docs/style
Style Guide
本文說明了.proto檔案的編寫風格指南。遵循這些約定,將使protocol buffer message的定義及其相應的類保持一致且易於閱讀。
Message And Field Names
對於message的命名,採用駝峰命名法(第一個字母大寫),例如SongServerRequest。對於message中的欄位,採用下劃線分隔的方式命名,如song_name。
message SongServerRequest { required string song_name = 1; }
使用這樣的命名規則可以為message中的欄位提供get,set方法:
C++: const string& song_name() { ... } void set_song_name(const string& x) { ... }
Java: public String getSongName() { ... } public Builder setSongName(String v) { ... }
Enums
對於列舉型別的命名採用駝峰命名法(CamelCase),列舉型別中值的命名採用全大寫和下劃線(CAPITALS_WITH_UNDERSCORES)結合的命名。
enum Foo { FIRST_VALUE = 0; SECOND_VALUE = 1; }
每個列舉值應以分號結束,而不是逗號。
Services
如果.proto定義了RPC服務,對服務名和RPC方法使用駝峰命名法(CamelCase):
service FooService { rpc GetSomething(FooRequest) returns (FooResponse); }