メインコンテンツまでスキップ

thrift style guides

ルール

required は使用しないでください

プロジェクトが進行すると、任意のフィールドがオプションになる場合があります。ただし、required として定義されている場合、削除することはできません。

したがって、required は使用しないでください。

順序は変更しないでください

互換性を維持するために、フィールドの順序は変更しないでください。

命名規則

ファイル名

メッセージの名前はすべて小文字で、単語間にアンダースコアを使用します。 ファイルの拡張子は .thrift で終わる必要があります。

my_struct.thrift            // Good
MyStruct.thrift // Bad
my_struct.proto // Bad

構造体名

構造体の名前は大文字の T から始まり、各新しい単語には大文字が続き、アンダースコアは使用しません: TMyStruct

struct TMyStruct;           // Good
struct MyStruct; // Bad
struct TMy_Struct; // Bad
struct TmyStruct; // Bad

フィールド名

構造体のメンバーの名前はすべて小文字で、単語間にアンダースコアを使用します。

1: optional i64 my_field;       // Good
1: optional i64 myField; // Bad