言語ガイド (エディション)

このガイドでは、プロトコルバッファ言語を使用してプロトコルバッファデータを構造化する方法について説明します。これには、.protoファイル構文と、.protoファイルからデータアクセス​​クラスを生成する方法が含まれます。プロトコルバッファ言語のエディション2023からエディション2024までを対象としています。エディションがproto2およびproto3と概念的にどのように異なるかについては、Protobuf Editions Overviewを参照してください。

proto2構文の詳細については、Proto2言語ガイドを参照してください。

proto3構文の詳細については、Proto3言語ガイドを参照してください。

これはリファレンスガイドです。このドキュメントで説明されている多くの機能を使用したステップバイステップの例については、選択した言語のチュートリアルを参照してください。

メッセージ型の定義

まず、非常に簡単な例を見てみましょう。検索リクエストメッセージ形式を定義したいとします。各検索リクエストには、クエリ文字列、関心のある結果の特定のページ、およびページあたりの結果数が含まれます。メッセージ型を定義するために使用する.protoファイルは次のとおりです。

edition = "2023";

message SearchRequest {
  string query = 1;
  int32 page_number = 2;
  int32 results_per_page = 3;
}

• ファイルの最初の行は、protobuf言語仕様のエディション2023を使用していることを指定します。

  • edition (または proto2/proto3 の場合は syntax) は、ファイルの最初の非空白、非コメント行でなければなりません。
  • edition または syntax が指定されていない場合、プロトコルバッファコンパイラはproto2を使用していると仮定します。

• SearchRequestメッセージ定義は、3つのフィールド（名前/値のペア）を指定しています。これらは、このタイプのメッセージに含めたい各データに対応しています。各フィールドには名前と型があります。

フィールド型の指定

前の例では、すべてのフィールドがスカラー型です。2つの整数（page_numberとresults_per_page）と1つの文字列（query）です。フィールドには列挙型や、他のメッセージ型のような複合型も指定できます。

フィールド番号の割り当て

メッセージ定義の各フィールドには、1から536,870,911までの番号を、以下の制限付きで与える必要があります。

• 指定された番号は、そのメッセージのすべてのフィールドの中で一意でなければなりません。
• フィールド番号19,000から19,999は、Protocol Buffersの実装のために予約されています。メッセージでこれらの予約済みフィールド番号を使用すると、プロトコルバッファコンパイラは文句を言います。
• 以前に予約済みのフィールド番号や、拡張機能に割り当てられたフィールド番号は使用できません。

この番号はメッセージのワイヤーフォーマットでフィールドを識別するため、メッセージ型が使用され始めると変更できません。「フィールド番号の変更」は、そのフィールドを削除し、同じ型で新しい番号を持つ新しいフィールドを作成することと同じです。これを適切に行う方法については、Deleting Fieldsを参照してください。

フィールド番号は決して再利用すべきではありません。予約済みリストからフィールド番号を取り出して、新しいフィールド定義で再利用しないでください。フィールド番号の再利用による影響を参照してください。

最も頻繁に設定されるフィールドには、フィールド番号1から15を使用してください。ワイヤーフォーマットでは、フィールド番号の値が小さいほどスペースを少なく占めます。たとえば、フィールド番号1から15の範囲はエンコードに1バイトを要します。フィールド番号16から2047の範囲は2バイトを要します。これについては、Protocol Buffer Encodingで詳しく知ることができます。

フィールド番号の再利用による影響

フィールド番号を再利用すると、ワイヤーフォーマットメッセージのデコードが曖昧になります。

Protobufのワイヤーフォーマットは無駄がなく、ある定義でエンコードされたフィールドを別の定義でデコードしたことを検出する方法を提供していません。

ある定義を使用してフィールドをエンコードし、その後、その同じフィールドを別の定義でデコードすると、以下のような事態につながる可能性があります。

• デバッグに費やされる開発者の時間
• パース/マージエラー（最良のシナリオ）
• 個人情報/機密情報の漏洩
• データの破損

フィールド番号の再利用の一般的な原因

• フィールドの番号変更（見た目の美しい番号順にするために行われることがあります）。番号変更は、事実上、番号変更に関わるすべてのフィールドを削除して再追加することになり、互換性のないワイヤーフォーマットの変更をもたらします。

• フィールドを削除し、将来の再利用を防ぐために番号を予約しないこと。

  • これは、いくつかの理由により拡張フィールドで非常に起こりやすい間違いでした。拡張宣言は、拡張フィールドを予約するメカニズムを提供します。

フィールド番号は32ビットではなく29ビットに制限されています。これは、3ビットがフィールドのワイヤーフォーマットを指定するために使用されるためです。詳細については、エンコーディングのトピックを参照してください。

フィールドカーディナリティの指定

メッセージフィールドは、次のいずれかになります。

• 単数形:

  単一フィールドには明示的なカーディナリティラベルがありません。これには2つの可能な状態があります。

  • フィールドが設定されており、明示的に設定されたか、ワイヤーから解析された値が含まれています。ワイヤーにシリアライズされます。
  • フィールドが設定されておらず、デフォルト値を返します。ワイヤーにシリアライズされません。

  値が明示的に設定されたかどうかを確認できます。

  エディションに移行されたProto3の*implicit*フィールドは、field_presence機能セットをIMPLICIT値に設定して使用します。

  エディションに移行されたProto2のrequiredフィールドもfield_presence機能を使用しますが、LEGACY_REQUIREDに設定されます。

• repeated: このフィールド型は、整形式のメッセージ内で0回以上繰り返すことができます。繰り返された値の順序は保持されます。

• map: これはキーと値のペアのフィールド型です。このフィールド型の詳細については、マップを参照してください。

繰り返しフィールドはデフォルトでパックされます

protoエディションでは、スカラー数値型のrepeatedフィールドはデフォルトでpackedエンコーディングを使用します。

`packed`エンコーディングについての詳細は、Protocol Bufferエンコーディングで確認できます。

整形式メッセージ

「整形式」という用語は、protobufメッセージに適用される場合、シリアライズ/デシリアライズされたバイトを指します。protocパーサーは、与えられたproto定義ファイルが解析可能であることを検証します。

単一のフィールドは、ワイヤーフォーマットのバイト内で複数回出現することがあります。パーサーは入力を受け入れますが、そのフィールドの最後のインスタンスのみが生成されたバインディングを介してアクセス可能になります。このトピックの詳細については、Last One Winsを参照してください。

メッセージ型の追加

複数のメッセージ型を単一の.protoファイルで定義できます。これは、複数の関連メッセージを定義する場合に役立ちます。たとえば、SearchResponseメッセージ型に対応する応答メッセージ形式を定義したい場合、同じ.protoに追加できます。

message SearchRequest {
  string query = 1;
  int32 page_number = 2;
  int32 results_per_page = 3;
}

message SearchResponse {
 ...
}

メッセージの結合は肥大化につながる 複数のメッセージ型（メッセージ、enum、サービスなど）を単一の.protoファイルで定義できますが、異なる依存関係を持つ多数のメッセージが単一のファイルで定義されている場合、依存関係の肥大化につながる可能性もあります。.protoファイルあたりのメッセージ型を可能な限り少なくすることをお勧めします。

コメントの追加

`.proto`ファイルにコメントを追加するには：

• .protoコード要素の前の行に、C/C++/Javaの行末スタイルコメント「//」を使用することを推奨します。

• Cスタイルのインライン/複数行コメント `/* ... */` も受け入れられます。

  • 複数行コメントを使用する場合、マージン行として「*」を使用することが推奨されます。

/**
 * SearchRequest represents a search query, with pagination options to
 * indicate which results to include in the response.
 */
message SearchRequest {
  string query = 1;

  // Which page number do we want?
  int32 page_number = 2;

  // Number of results to return per page.
  int32 results_per_page = 3;
}

フィールドの削除

フィールドを削除することは、適切に行われないと深刻な問題を引き起こす可能性があります。

フィールドが不要になり、クライアントコードからすべての参照が削除された場合、メッセージからフィールド定義を削除できます。ただし、削除されたフィールド番号を予約する必要があります。フィールド番号を予約しないと、将来開発者がその番号を再利用する可能性があります。

また、メッセージのJSONおよびTextFormatエンコーディングが引き続き解析できるように、フィールド名を予約する必要もあります。

予約済みフィールド番号

フィールドを完全に削除するか、コメントアウトすることでメッセージ型を更新した場合、将来の開発者は、その型に独自の更新を行う際にそのフィールド番号を再利用できます。これは、フィールド番号を再利用した場合の結果で説明されているように、重大な問題を引き起こす可能性があります。これを防ぐために、削除されたフィールド番号をreservedリストに追加してください。

将来の開発者がこれらの予約済みフィールド番号を使用しようとすると、protocコンパイラはエラーメッセージを生成します。

message Foo {
  reserved 2, 15, 9 to 11;
}

予約済みフィールド番号の範囲は包括的です（`9 to 11`は`9, 10, 11`と同じです）。

予約済みのフィールド名

古いフィールド名を後で再利用することは一般的に安全ですが、TextProtoやJSONエンコーディングを使用している場合、フィールド名がシリアライズされるため例外です。このリスクを避けるために、削除したフィールド名を`reserved`リストに追加することができます。

予約された名前は protoc コンパイラの動作にのみ影響し、実行時の動作には影響しません。ただし、例外が1つあります。TextProto の実装では、予約された名前を持つ不明なフィールドをパース時に破棄することがあります（他の不明なフィールドのようにエラーを発生させずに）。これは現在、C++ と Go の実装のみが行っています。実行時の JSON パースは予約された名前に影響されません。

message Foo {
  reserved 2, 15, 9 to 11;
  reserved foo, bar;
}

同じ`reserved`文にフィールド名とフィールド番号を混在させることはできないことに注意してください。

.protoから何が生成されるか

.protoファイルでプロトコルバッファコンパイラを実行すると、コンパイラは、記述したメッセージ型を操作するために必要なコードを、選択した言語で生成します。これには、フィールド値の取得と設定、メッセージの出力ストリームへのシリアル化、入力ストリームからのメッセージの解析が含まれます。

• C++の場合、コンパイラは各`.proto`から`.h`と`.cc`ファイルを生成し、ファイルで記述された各メッセージ型に対応するクラスを作成します。
• Javaの場合、コンパイラは各メッセージ型に対応するクラスを含む`.java`ファイルを生成します。また、メッセージクラスのインスタンスを作成するための特別な`Builder`クラスも生成します。
• Kotlinの場合、Javaで生成されたコードに加えて、コンパイラは各メッセージ型に対して、改善されたKotlin APIを持つ.ktファイルを生成します。これには、メッセージインスタンスの作成を簡素化するDSL、null許容フィールドアクセサ、およびコピー関数が含まれます。
• Pythonは少し異なります。Pythonコンパイラは、.protoファイル内の各メッセージ型の静的な記述子を持つモジュールを生成し、それが実行時に必要なPythonデータアクセス​​クラスを作成するために*メタクラス*とともに使用されます。
• Goの場合、コンパイラは`.pb.go`ファイルを生成し、そのファイル内の各メッセージ型に対応する型を作成します。
• Rubyの場合、コンパイラはメッセージ型を含むRubyモジュールを持つ`.rb`ファイルを生成します。
• Objective-Cの場合、コンパイラは各`.proto`から`pbobjc.h`と`pbobjc.m`ファイルを生成し、ファイルで記述された各メッセージ型に対応するクラスを作成します。
• C#の場合、コンパイラは各`.proto`から`.cs`ファイルを生成し、ファイルに記述された各メッセージ型に対応するクラスを作成します。
• PHPの場合、コンパイラはファイルで記述された各メッセージ型に対して.phpメッセージファイルを生成し、コンパイルする各.protoファイルに対して.phpメタデータファイルを生成します。メタデータファイルは、有効なメッセージ型を記述子プールにロードするために使用されます。
• Dartの場合、コンパイラはファイル内の各メッセージタイプに対応するクラスを持つ`.pb.dart`ファイルを生成します。

各言語のAPIの使用方法についての詳細は、選択した言語のチュートリアルを参考にしてください。さらに詳細なAPI情報については、関連するAPIリファレンスを参照してください。

スカラー値型

スカラーメッセージフィールドは以下のいずれかの型を持つことができます。表は`.proto`ファイルで指定された型と、自動生成されるクラスでの対応する型を示しています。

^[1] Kotlinは、Java/Kotlin混合コードベースでの互換性を確保するため、符号なし型であってもJavaの対応する型を使用します。

^[2] Javaでは、符号なし32ビットおよび64ビット整数は、符号付きの対応物を使用して表現され、最上位ビットは単に符号ビットに格納されます。

^[3] すべての場合において、フィールドに値を設定する際には、それが有効であることを確認するための型チェックが実行されます。

^[4] 64ビットまたは符号なし32ビット整数は、デコード時には常にlongとして表現されますが、フィールドを設定する際にintが与えられた場合はintになることがあります。すべての場合において、設定される値は表現される型に収まる必要があります。[2]を参照してください。

^[5] Pythonの文字列はデコード時にはユニコードとして表現されますが、ASCII文字列が与えられた場合はstrになることがあります（これは変更される可能性があります）。

^[6] 64ビットマシンではIntegerが使用され、32ビットマシンではstringが使用されます。

メッセージをシリアライズする際にこれらの型がどのようにエンコードされるかについての詳細は、Protocol Bufferエンコーディングで確認できます。

フィールドのデフォルト値

メッセージがパースされる際、エンコードされたメッセージバイトに特定のフィールドが含まれていない場合、パースされたオブジェクトでそのフィールドにアクセスすると、そのフィールドのデフォルト値が返されます。デフォルト値は型によって異なります。

• 文字列の場合、デフォルト値は空文字列です。
• bytesの場合、デフォルト値は空のバイト列です。
• boolの場合、デフォルト値はfalseです。
• 数値型の場合、デフォルト値はゼロです。
• メッセージ フィールドの場合、フィールドは設定されていません。正確な値は言語に依存します。詳細は生成コード ガイドを参照してください。
• 列挙型の場合、デフォルト値は**最初に定義された列挙値**であり、これは0でなければなりません。列挙型のデフォルト値を参照してください。

repeatedフィールドのデフォルト値は空です（通常、適切な言語での空のリスト）。

マップフィールドのデフォルト値は空です（通常、適切な言語での空のマップ）。

デフォルトのスカラー値のオーバーライド

protobufエディションでは、単一の非メッセージフィールドに明示的なデフォルト値を指定できます。たとえば、SearchRequest.result_per_pageフィールドにデフォルト値として10を指定したいとします。

int32 result_per_page = 3 [default = 10];

送信者がresult_per_pageを指定しなかった場合、受信者は以下の状態を観測します。

• result_per_page フィールドは存在しません。つまり、has_result_per_page() (ハザー メソッド) メソッドは false を返します。
• result_per_page の値（「ゲッター」から返される）は 10 です。

送信者がresult_per_pageの値を送信した場合、デフォルト値の10は無視され、送信者の値が「getter」から返されます。

生成されたコードにおけるデフォルト値の動作に関する詳細は、選択した言語の生成コードガイドを参照してください。

field_presence 機能が IMPLICIT に設定されているフィールドには、明示的なデフォルト値を指定できません。

列挙型

メッセージ型を定義する際に、そのフィールドの1つを、あらかじめ定義された値のリストのいずれか1つだけを持つようにしたい場合があります。たとえば、各SearchRequestにcorpusフィールドを追加したいとします。ここで、corpusはUNIVERSAL、WEB、IMAGES、LOCAL、NEWS、PRODUCTS、またはVIDEOのいずれかになります。これは、考えられる各値の定数を持つenumをメッセージ定義に追加することで、非常に簡単に実現できます。

以下の例では、すべての可能な値を持つ`Corpus`という`enum`と、`Corpus`型のフィールドを追加しました。

enum Corpus {
  CORPUS_UNSPECIFIED = 0;
  CORPUS_UNIVERSAL = 1;
  CORPUS_WEB = 2;
  CORPUS_IMAGES = 3;
  CORPUS_LOCAL = 4;
  CORPUS_NEWS = 5;
  CORPUS_PRODUCTS = 6;
  CORPUS_VIDEO = 7;
}

message SearchRequest {
  string query = 1;
  int32 page_number = 2;
  int32 results_per_page = 3;
  Corpus corpus = 4;
}

列挙型のデフォルト値

`SearchRequest.corpus`フィールドのデフォルト値は`CORPUS_UNSPECIFIED`です。なぜなら、それがenumで定義された最初の値だからです。

エディション2023では、enum定義で最初に定義された値は**必ず**ゼロの値を持つ必要があり、ENUM_TYPE_NAME_UNSPECIFIEDまたはENUM_TYPE_NAME_UNKNOWNという名前を持つ必要があります。これは次の理由によるものです。

• ゼロ値は、proto2のセマンティクスとの互換性のために、最初の要素である必要があります。proto2では、異なる値が明示的に指定されない限り、最初のenum値がデフォルトです。
• proto3のセマンティクスとの互換性のためにゼロ値が存在する必要があります。proto3では、このenum型を使用するすべての暗黙的なプレゼンスフィールドのデフォルト値としてゼロ値が使用されます。

また、この最初のデフォルト値は、「この値は指定されなかった」以外の意味を持たないことが推奨されます。

SearchRequest.corpusフィールドのようなenumフィールドのデフォルト値は、次のように明示的にオーバーライドできます。

  Corpus corpus = 4 [default = CORPUS_UNIVERSAL];

option features.enum_type = CLOSED; を使用して proto2 から移行された列挙型の場合、列挙型の最初の値に制限はありません。これらの種類の列挙型の最初の値を変更することは推奨されません。なぜなら、明示的なフィールドのデフォルトを持たないその列挙型を使用するすべてのフィールドのデフォルト値を変更することになるからです。

列挙値のエイリアス

異なる列挙定数に同じ値を割り当てることで、エイリアスを定義できます。これを行うには、allow_aliasオプションをtrueに設定する必要があります。そうしないと、エイリアスが検出された場合にプロトコルバッファコンパイラが警告メッセージを生成します。すべてのエイリアス値はシリアル化に有効ですが、デシリアル化時には最初の値のみが使用されます。

enum EnumAllowingAlias {
  option allow_alias = true;
  EAA_UNSPECIFIED = 0;
  EAA_STARTED = 1;
  EAA_RUNNING = 1;
  EAA_FINISHED = 2;
}

enum EnumNotAllowingAlias {
  ENAA_UNSPECIFIED = 0;
  ENAA_STARTED = 1;
  // ENAA_RUNNING = 1;  // Uncommenting this line will cause a warning message.
  ENAA_FINISHED = 2;
}

列挙定数

列挙子定数は、32ビット整数の範囲内になければなりません。enum値はワイヤー上でvarintエンコーディングを使用するため、負の値は非効率的であり、推奨されません。前の例のように、メッセージ定義内でenumを定義することも、外側で定義することもできます。これらのenumは、.protoファイル内の任意のメッセージ定義で再利用できます。また、_MessageType_._EnumType_という構文を使用して、あるメッセージで宣言されたenum型を別のメッセージのフィールドの型として使用することもできます。

言語固有の列挙型実装

enumを使用する.protoに対してプロトコルバッファコンパイラを実行すると、Java、Kotlin、またはC++の場合には対応するenumが、Pythonの場合にはランタイム生成クラスで整数値を持つシンボリック定数のセットを作成するために使用される特殊なEnumDescriptorクラスが生成されます。

デシリアライズ中、認識されないenum値はメッセージ内に保持されますが、メッセージがデシリアライズされたときにこれがどのように表現されるかは言語に依存します。C++やGoのように、指定されたシンボルの範囲外の値を持つオープンenum型をサポートする言語では、不明なenum値は単にその基になる整数表現として格納されます。Javaのように、クローズドenum型を持つ言語では、認識されない値を表現するためにenum内のケースが使用され、基になる整数は特殊なアクセサーでアクセスできます。いずれの場合でも、メッセージがシリアライズされた場合、認識されない値はメッセージと一緒にシリアライズされます。

アプリケーションでメッセージの`enum`を扱う方法についての詳細は、選択した言語の生成コードガイドを参照してください。

予約値

enumエントリを完全に削除するか、コメントアウトすることでenum型を更新した場合、将来のユーザーはその型に独自の更新を行う際にその数値を再利用できます。これにより、後で同じ.protoの古いインスタンスをロードした場合に、データの破損、プライバシーバグなど、重大な問題が発生する可能性があります。これを防ぐ1つの方法は、削除されたエントリの数値（および/または名前。JSONシリアル化でも問題を引き起こす可能性があります）をreservedとして指定することです。将来のユーザーがこれらの識別子を使用しようとすると、プロトコルバッファコンパイラは不平を言います。予約された数値範囲がmaxキーワードを使用して可能な最大値まで拡張することを指定できます。

enum Foo {
  reserved 2, 15, 9 to 11, 40 to max;
  reserved FOO, BAR;
}

同じ`reserved`文にフィールド名と数値を混在させることはできません。

他のメッセージ型の使用

他のメッセージ型をフィールド型として使用できます。例えば、各SearchResponseメッセージにResultメッセージを含めたいとします。これを行うには、同じ.proto内でResultメッセージ型を定義し、SearchResponseでResult型のフィールドを指定します。

message SearchResponse {
  repeated Result results = 1;
}

message Result {
  string url = 1;
  string title = 2;
  repeated string snippets = 3;
}

定義のインポート

先の例では、`Result`メッセージ型は`SearchResponse`と同じファイルで定義されています。フィールド型として使用したいメッセージ型が既に別の`.proto`ファイルで定義されている場合はどうなるでしょうか。

他の`.proto`ファイルからの定義を*インポート*することで使用できます。別の`.proto`の定義をインポートするには、ファイルの先頭にimport文を追加します。

import "myproject/other_protos.proto";

Edition 2024より、import optionを使用して他の.protoファイルからカスタムオプション定義を使用することもできます。通常のインポートとは異なり、これはカスタムオプション定義のみの使用を許可し、生成されたコードの依存関係を避けるために他のメッセージやenum定義は許可しません。

import option "myproject/other_protos.proto";

デフォルトでは、直接インポートされた.protoファイルからの定義のみを使用できます。しかし、時には.protoファイルを新しい場所に移動する必要があるかもしれません。.protoファイルを直接移動してすべての呼び出しサイトを1回の変更で更新する代わりに、古い場所にプレースホルダーの.protoファイルを置いて、import publicの概念を使用してすべてのインポートを新しい場所に転送できます。

なお、public import機能は、Java、Kotlin、TypeScript、JavaScript、GCL、およびprotobuf静的リフレクションを使用するC++ターゲットでは利用できません。

`import public`の依存関係は、`import public`文を含むプロトをインポートする任意のコードによって推移的に依存される可能性があります。例えば：

// new.proto
// All definitions are moved here

// old.proto
// This is the proto that all clients are importing.
import public "new.proto";
import "other.proto";

// client.proto
import "old.proto";
// You use definitions from old.proto and new.proto, but not other.proto

プロトコルコンパイラは、-I/--proto_pathフラグを使用してプロトコルコンパイラコマンドラインで指定されたディレクトリセットからインポートされたファイルを探します。フラグが指定されていない場合、コンパイラが呼び出されたディレクトリを探します。一般に、--proto_pathフラグをプロジェクトのルートに設定し、すべてのインポートに完全修飾名を使用する必要があります。

シンボルの可視性

他のprotoによってインポートされたときに利用可能なシンボルと利用できないシンボルの可視性は、エディション2024で追加されたfeatures.default_symbol_visibility機能とexportおよびlocalキーワードによって制御されます。

デフォルトのシンボル可視性、またはexportキーワードを介してエクスポートされたシンボルのみが、インポートするファイルから参照できます。

proto2とproto3のメッセージ型の使用

proto2とproto3のメッセージ型をインポートしてエディションのメッセージで使用することも、その逆も可能です。

ネストされた型

次の例のように、他のメッセージタイプの内部でメッセージタイプを定義し、使用することができます。ここでは、`Result`メッセージが`SearchResponse`メッセージの内部で定義されています。

message SearchResponse {
  message Result {
    string url = 1;
    string title = 2;
    repeated string snippets = 3;
  }
  repeated Result results = 1;
}

このメッセージ型を親メッセージ型の外部で再利用したい場合は、`_Parent_._Type_`として参照します。

message SomeOtherMessage {
  SearchResponse.Result result = 1;
}

メッセージは好きなだけ深くネストできます。以下の例では、`Inner`という名前の2つのネストされた型は、異なるメッセージ内で定義されているため、完全に独立していることに注意してください。

message Outer {       // Level 0
  message MiddleAA {  // Level 1
    message Inner {   // Level 2
      int64 ival = 1;
      bool  booly = 2;
    }
  }
  message MiddleBB {  // Level 1
    message Inner {   // Level 2
      int32 ival = 1;
      bool  booly = 2;
    }
  }
}

メッセージ型の更新

既存のメッセージ型がすべてのニーズを満たさなくなった場合（たとえば、メッセージ形式に余分なフィールドを追加したい場合）でも、古い形式で作成されたコードを使用したい場合でも、心配はいりません！バイナリワイヤー形式を使用すれば、既存のコードを壊すことなくメッセージ型を更新するのは非常に簡単です。

Protoのベストプラクティスと以下のルールを確認してください。

バイナリワイヤー形式で安全でない変更

ワイヤー非安全な変更とは、新しいスキーマを使用するパーサーで古いスキーマを使用してシリアル化されたデータを解析した場合（またはその逆の場合）に壊れるスキーマ変更のことです。ワイヤー非安全な変更は、データのすべてのシリアライザーとデシリアライザーが新しいスキーマを使用していることがわかっている場合にのみ行ってください。

• 既存のフィールドのフィールド番号を変更することは安全ではありません。
  • フィールド番号を変更することは、そのフィールドを削除し、同じ型で新しいフィールドを追加することと同等です。フィールドの番号を付け替えたい場合は、フィールドの削除の手順を参照してください。
• フィールドを既存の`oneof`に移動することは安全ではありません。

バイナリワイヤー形式で安全な変更

ワイヤーセーフな変更とは、データの損失や新たなパース失敗のリスクなしに、スキーマをこの方法で進化させることが完全に安全な変更です。

ワイヤーセーフな変更であっても、特定の言語のアプリケーションコードにとって破壊的な変更となる可能性があることに注意してください。例えば、既存の列挙型に値を追加すると、その列挙型に対する網羅的なswitch文を持つコードはコンパイルエラーになります。そのため、Googleは一部の公開メッセージに対してこれらの種類の変更を行うことを避ける場合があります。AIPsには、これらの変更のうちどれが安全であるかについてのガイダンスが含まれています。

• 新しいフィールドの追加は安全です。
  • 新しいフィールドを追加しても、古いメッセージ形式を使用するコードによってシリアル化されたメッセージは、新しい生成コードで引き続き解析できます。新しいコードが古いコードによって生成されたメッセージと適切にやり取りできるように、これらの要素のデフォルト値を考慮する必要があります。同様に、新しいコードによって作成されたメッセージは古いコードによって解析できます。古いバイナリは解析時に新しいフィールドを単純に無視します。詳細は不明なフィールドのセクションを参照してください。
• フィールドの削除は安全です。
  • 更新されたメッセージ型では、同じフィールド番号を再利用してはなりません。代わりにフィールド名を変更することを検討し、例えば「OBSOLETE_」という接頭辞を追加したり、フィールド番号を予約済みにして、将来の.protoユーザーが誤ってその番号を再利用しないようにしてください。
• enumに値を追加することは安全です。
• 単一の明示的な存在フィールドまたは拡張を**新しい** `oneof`のメンバーに変更することは安全です。
• 1つのフィールドのみを含む`oneof`を明示的な存在フィールドに変更することは安全です。
• フィールドを同じ番号と型の拡張に変更することは安全です。

バイナリワイヤー形式で互換性のある変更（条件付きで安全）

ワイヤー互換性の変更は、ワイヤーセーフな変更とは異なり、変更の前後で同じデータをパースできることを意味します。ただし、この形式の変更では、データのパース時に情報が失われる可能性があります。例えば、int32をint64に変更するのは互換性のある変更ですが、INT32_MAXより大きい値が書き込まれた場合、int32として読み取るクライアントはその数値の上位ビットを破棄します。

スキーマに対する互換性のある変更は、システムへの展開を慎重に管理する場合にのみ行うことができます。たとえば、int32をint64に変更しても、新しいスキーマがすべてのエンドポイントに展開されるまで法的なint32値のみを書き込み続け、その後、より大きな値を書き込み始めることを確実にすることができます。

スキーマが組織外に公開されている場合、新しいスキーマの展開を管理して、異なる値の範囲がいつ安全に使用できるかを知ることができないため、一般的にワイヤー互換の変更を行うべきではありません。

• `int32`、`uint32`、`int64`、`uint64`、および`bool`はすべて互換性があります。
  • ワイヤーから解析された数値が対応する型に収まらない場合、C++でその数値をその型にキャストした場合と同じ効果が得られます（たとえば、64ビットの数値がint32として読み取られると、32ビットに切り捨てられます）。
• `sint32`と`sint64`は互いに互換性がありますが、他の整数型とは互換性が*ありません*。
  • 書き込まれた値がINT_MINからINT_MAX（両端を含む）の範囲内であれば、どちらの型でも同じ値として解析されます。sint64値がその範囲外で書き込まれ、sint32として解析された場合、varintは32ビットに切り捨てられ、その後ジグザグデコードが行われます（これにより異なる値が観測されます）。
• `string`と`bytes`は、バイト列が有効なUTF-8である限り互換性があります。
• 埋め込みメッセージは、バイト列がメッセージのエンコードされたインスタンスを含んでいる場合、`bytes`と互換性があります。
• `fixed32`は`sfixed32`と互換性があり、`fixed64`は`sfixed64`と互換性があります。
• `string`、`bytes`、およびメッセージフィールドの場合、単数形は`repeated`と互換性があります。
  • 繰り返しのフィールドのシリアル化されたデータが入力として与えられた場合、このフィールドが単一であると想定するクライアントは、それがプリミティブ型フィールドの場合は最後の入力値を取り、メッセージ型フィールドの場合はすべての入力要素をマージします。これは、bool型とenum型を含む数値型に対しては一般的に安全ではありません。数値型の繰り返しのフィールドは、デフォルトでpacked形式でシリアル化されるため、単一のフィールドが想定される場合には正しく解析されません。
• `enum`は`int32`、`uint32`、`int64`、`uint64`と互換性があります。
  • メッセージがデシリアライズされたとき、クライアントコードがそれらを異なる方法で扱う可能性があることに注意してください。例えば、認識されないproto3のenum値はメッセージ内に保持されますが、メッセージがデシリアライズされたときにこれがどのように表現されるかは言語に依存します。
• フィールドを `map<K, V>` と対応する `repeated` メッセージフィールドとの間で変更することは、バイナリ互換です（メッセージレイアウトやその他の制約については、下記の マップ を参照してください）。
  • ただし、変更の安全性はアプリケーションに依存します。メッセージのデシリアライズと再シリアライズを行う際、repeatedフィールド定義を使用するクライアントは意味的に同一の結果を生成します。しかし、mapフィールド定義を使用するクライアントは、エントリの順序を変更したり、重複するキーを持つエントリを破棄したりする可能性があります。

未知のフィールド

不明なフィールドとは、パーサーが認識しないフィールドを表す、適切な形式のプロトコルバッファシリアライズデータです。たとえば、古いバイナリが新しいフィールドを含む新しいバイナリから送信されたデータを解析すると、それらの新しいフィールドは古いバイナリでは不明なフィールドになります。

エディションメッセージは不明なフィールドを保持し、解析中およびシリアル化された出力にそれらを含めます。これはproto2およびproto3の動作と一致します。

未知のフィールドの保持

一部の操作により、未知のフィールドが失われる可能性があります。たとえば、次のいずれかを行うと、未知のフィールドは失われます。

• プロトをJSONにシリアライズする。
• メッセージ内のすべてのフィールドを反復処理して、新しいメッセージを生成する。

未知のフィールドを失わないようにするには、次のことを行ってください。

• バイナリを使用し、データ交換にテキスト形式を使用しないようにする。
• フィールドごとにコピーするのではなく、`CopyFrom()` や `MergeFrom()` などのメッセージ指向の API を使用してデータをコピーする。

TextFormatは少し特殊なケースです。TextFormatにシリアライズすると、未知のフィールドはフィールド番号を使用して出力されます。しかし、TextFormatデータをバイナリプロトに戻してパースすると、フィールド番号を使用するエントリがある場合に失敗します。

エクステンション

拡張機能とは、そのコンテナメッセージの外側で定義されるフィールドです。通常、コンテナメッセージの.protoファイルとは別の.protoファイルで定義されます。

拡張機能を使用する理由

拡張機能を使用する主な理由は2つあります。

• コンテナメッセージの.protoファイルには、インポート/依存関係が少なくなります。これにより、ビルド時間の改善、循環依存関係の解消、および疎結合の促進につながります。拡張機能はこれに非常に適しています。
• システムが、最小限の依存関係と調整でコンテナメッセージにデータを添付できるようにします。限られたフィールド番号空間とフィールド番号の再利用の結果のため、拡張機能はこれに適したソリューションではありません。多数の拡張機能に対して非常に低い調整が必要なユースケースの場合、代わりにAnyメッセージ型の使用を検討してください。

拡張機能の例

拡張機能を使用するには2つのステップが必要です。まず、拡張したいメッセージ（「コンテナ」）で、拡張機能用のフィールド番号の範囲を予約する必要があります。次に、別のファイルで、拡張フィールド自体を定義します。

一般的なUserContentメッセージに子猫動画の拡張機能を追加する方法を示す例を次に示します。

ステップ1: コンテナメッセージで拡張範囲を予約します。

コンテナメッセージは、他のユーザーが使用するためにフィールド番号の範囲を予約するためにextensionsキーワードを使用する必要があります。追加する予定の特定の拡張機能のdeclarationも追加することがベストプラクティスです。この宣言は前方宣言として機能し、開発者が拡張機能を発見しやすくなり、フィールド番号の再利用を回避できます。

// media/user_content.proto
edition = "2023";

package media;

// A container for user-created content.
message UserContent {
  extensions 100 to 199 [
    declaration = {
      number: 126,
      full_name: ".kittens.kitten_videos",
      type: ".kittens.Video",
      repeated: true
    }
  ];
}

この宣言は、他の場所で定義される拡張機能のフィールド番号、完全名、型、カーディナリティを指定します。

ステップ2: 別のファイルで拡張機能を定義します。

拡張機能自体は別の.protoファイルで定義され、通常は特定の機能（子猫の動画など）に焦点を当てます。これにより、汎用コンテナから特定の機能への依存関係が追加されるのを回避できます。

// kittens/video_ext.proto
edition = "2023";

import "media/user_content.proto"; // Imports the container message
import "kittens/video.proto";      // Imports the extension's message type

package kittens;

// This defines the extension field.
extend media.UserContent {
  repeated Video kitten_videos = 126;
}

extendブロックは、コンテナで予約されたフィールド番号126を使用して、新しいkitten_videosフィールドをmedia.UserContentメッセージに結び付けます。

拡張フィールドと、同じフィールド番号、型、カーディナリティを持つ標準フィールドのワイヤーフォーマットエンコーディングには違いはありません。したがって、フィールド番号、型、カーディナリティが一定である限り、標準フィールドをコンテナから拡張機能として移動したり、拡張フィールドをコンテナメッセージに標準フィールドとして移動したりしても安全です。

ただし、拡張機能はコンテナメッセージの外側で定義されるため、特定の拡張フィールドを取得および設定するための特殊なアクセサーは生成されません。たとえば、プロトコルバッファコンパイラはAddKittenVideos()やGetKittenVideos()アクセサーを**生成しません**。代わりに、拡張機能はHasExtension()、ClearExtension()、GetExtension()、MutableExtension()、AddExtension()などのパラメーター化された関数を介してアクセスされます。

C++では、次のようになります。

UserContent user_content;
user_content.AddExtension(kittens::kitten_videos, new kittens::Video());
assert(1 == user_content.GetRepeatedExtension(kittens::kitten_videos).size());
user_content.GetRepeatedExtension(kittens::kitten_videos)[0];

拡張範囲の定義

コンテナ メッセージの所有者である場合、メッセージへの拡張機能の拡張範囲を定義する必要があります。

拡張フィールドに割り当てられたフィールド番号は、標準フィールドに再利用できません。

拡張範囲は、定義後に拡張しても安全です。良いデフォルトは、比較的小さな番号を1000個割り当て、拡張宣言を使用してその空間を密に埋めることです。

message ModernExtendableMessage {
  // All extensions in this range should use extension declarations.
  extensions 1000 to 2000 [verification = DECLARATION];
}

実際の拡張機能の前に拡張宣言の範囲を追加する場合、この新しい範囲で宣言が使用されることを強制するためにverification = DECLARATIONを追加する必要があります。このプレースホルダーは、実際の宣言が追加されたら削除できます。

既存の拡張範囲を、同じ合計範囲をカバーする別々の範囲に分割しても安全です。これは、レガシーメッセージ型を拡張宣言に移行するために必要となる場合があります。たとえば、移行前は次のように範囲が定義されていたかもしれません。

message LegacyMessage {
  extensions 1000 to max;
}

移行後（範囲を分割）には、次のようになります。

message LegacyMessage {
  // Legacy range that was using an unverified allocation scheme.
  extensions 1000 to 524999999 [verification = UNVERIFIED];
  // Current range that uses extension declarations.
  extensions 525000000 to max  [verification = DECLARATION];
}

開始フィールド番号を増やしたり、終了フィールド番号を減らしたりして拡張範囲を移動または縮小することは安全ではありません。これらの変更は、既存の拡張機能を無効にする可能性があります。

プロトのほとんどのインスタンスで入力される標準フィールドには、フィールド番号1から15を使用することをお勧めします。これらの番号を拡張機能に使用することは推奨されません。

番号付け規則に非常に大きなフィールド番号を持つ拡張機能が含まれる可能性がある場合、maxキーワードを使用して、拡張範囲が可能な最大フィールド番号までであることを指定できます。

message Foo {
  extensions 1000 to max;
}

max は 2²⁹ - 1、つまり 536,870,911 です。

拡張番号の選択

拡張機能は、コンテナメッセージの外側で指定できるフィールドにすぎません。フィールド番号の割り当てに関するすべての同じルールは、拡張フィールド番号にも適用されます。フィールド番号の再利用の結果も、拡張フィールド番号の再利用に適用されます。

コンテナメッセージが拡張宣言を使用している場合、一意の拡張フィールド番号を選択するのは簡単です。新しい拡張機能を定義する際には、コンテナメッセージで定義されている最も高い拡張範囲にある他のすべての宣言よりも低いフィールド番号を選択してください。たとえば、コンテナメッセージが次のように定義されている場合

message Container {
  // Legacy range that was using an unverified allocation scheme
  extensions 1000 to 524999999;
  // Current range that uses extension declarations. (highest extension range)
  extensions 525000000 to max  [
    declaration = {
      number: 525000001,
      full_name: ".bar.baz_ext",
      type: ".bar.Baz"
    }
    // 525,000,002 is the lowest field number above all other declarations
  ];
}

Container の次の拡張機能は、番号 525000002 を持つ新しい宣言を追加する必要があります。

未検証の拡張番号割り当て（非推奨）

コンテナ メッセージの所有者は、自身の未検証の拡張番号割り当て戦略を採用するために、拡張宣言を放棄することを選択する場合があります。

未検証の割り当てスキームは、選択された拡張範囲内で拡張フィールド番号を割り当てるために、protobufエコシステム外部のメカニズムを使用します。例として、モノレポのコミット番号を使用することが考えられます。このシステムは、拡張機能が適切に取得された拡張フィールド番号を使用しているかどうかをチェックする方法がないため、protobufコンパイラの観点からは「未検証」です。

未検証システムが拡張宣言のような検証済みシステムよりも優れている点は、コンテナメッセージの所有者との調整なしに拡張機能を定義できることです。

未検証システムの問題は、protobuf コンパイラが参加者を拡張フィールド番号の再利用から保護できないことです。

**未検証の拡張フィールド番号割り当て戦略は推奨されません**。フィールド番号を再利用した場合の結果は、メッセージを拡張するすべてのユーザー（推奨に従わなかった開発者だけでなく）に影響を与えるためです。非常に低い調整が必要なユースケースの場合、代わりにAnyメッセージの使用を検討してください。

未検証の拡張フィールド番号割り当て戦略は1から524,999,999の範囲に限定されます。フィールド番号525,000,000以上は拡張宣言でのみ使用できます。

拡張型の指定

拡張は、oneofとmapを除くすべてのフィールドタイプに適用できます。

ネストされた拡張機能（非推奨）

別のメッセージのスコープ内で拡張機能を宣言できます。

import "common/user_profile.proto";

package puppies;

message Photo {
  extend common.UserProfile {
    int32 likes_count = 111;
  }
  ...
}

この場合、この拡張にアクセスするための C++ コードは次のようになります。

UserProfile user_profile;
user_profile.SetExtension(puppies::Photo::likes_count, 42);

言い換えれば、唯一の効果はlikes_countがpuppies.Photoのスコープ内で定義されることです。

これはよくある混乱の原因です。メッセージ型の内部にネストされたextendブロックを宣言しても、外側の型と拡張された型の間に何らかの関係があることを意味**しません**。特に、前の例はPhotoがUserProfileの何らかのサブクラスであることを意味**しません**。これは、シンボルlikes_countがPhotoのスコープ内で宣言されていること、つまり単なる静的メンバーであることを意味するだけです。

一般的なパターンは、拡張機能を拡張機能のフィールド型のスコープ内で定義することです。たとえば、media.UserContentに対するpuppies.Photo型の拡張機能で、拡張機能がPhotoの一部として定義されている例を次に示します。

import "media/user_content.proto";

package puppies;

message Photo {
  extend media.UserContent {
    Photo puppy_photo = 127;
  }
  ...
}

ただし、メッセージ型を持つ拡張機能がその型内で定義されているという要件はありません。標準的な定義パターンも使用できます。

import "media/user_content.proto";

package puppies;

message Photo {
  ...
}

// This can even be in a different file.
extend media.UserContent {
  Photo puppy_photo = 127;
}

この**標準（ファイルレベル）構文は**、混乱を避けるために**推奨されます**。ネストされた構文は、拡張機能に馴染みのないユーザーによって、サブクラス化と誤解されることがよくあります。

Any

Anyメッセージ型を使用すると、その.proto定義がなくてもメッセージを埋め込み型として使用できます。Anyには、任意のシリアライズされたメッセージがbytesとして含まれ、そのメッセージの型をグローバルに一意に識別し解決するURLも含まれます。Any型を使用するには、google/protobuf/any.protoをインポートする必要があります。

import "google/protobuf/any.proto";

message ErrorStatus {
  string message = 1;
  repeated google.protobuf.Any details = 2;
}

特定のメッセージ型のデフォルトの型URLは `type.googleapis.com/_packagename_._messagename_` です。

異なる言語の実装は、Any値を型安全な方法でパックおよびアンパックするためのランタイムライブラリヘルパーをサポートします。たとえば、JavaではAny型に特別なpack()およびunpack()アクセサーがあり、C++ではPackFrom()およびUnpackTo()メソッドがあります。

// Storing an arbitrary message type in Any.
NetworkErrorDetails details = ...;
ErrorStatus status;
status.add_details()->PackFrom(details);

// Reading an arbitrary message from Any.
ErrorStatus status = ...;
for (const google::protobuf::Any& detail : status.details()) {
  if (detail.Is<NetworkErrorDetails>()) {
    NetworkErrorDetails network_error;
    detail.UnpackTo(&network_error);
    ... processing network_error ...
  }
}

格納されるメッセージを少数の型に制限し、新しい型をリストに追加する前に許可を必要とする場合は、Anyメッセージ型の代わりに、拡張宣言を伴う拡張機能の使用を検討してください。

Oneof

多くの単一フィールドを持つメッセージがあり、同時に最大1つのフィールドのみが設定される場合、oneof機能を使用することでこの動作を強制し、メモリを節約できます。

Oneofフィールドは単一フィールドに似ていますが、oneof内のすべてのフィールドがメモリを共有し、同時に最大1つのフィールドしか設定できません。oneofの任意のメンバーを設定すると、他のすべてのメンバーが自動的にクリアされます。選択した言語に応じて、特別なcase()またはWhichOneof()メソッドを使用して、oneof内でどの値が設定されているか（もしあれば）を確認できます。

複数の値が設定された場合、proto内の順序で決定される最後に設定された値が、以前のすべての値を上書きすることに注意してください。

oneofフィールドのフィールド番号は、それを囲むメッセージ内で一意でなければなりません。

Oneofの使用

`.proto`でoneofを定義するには、`oneof`キーワードの後にoneof名、この場合は`test_oneof`を続けます。

message SampleMessage {
  oneof test_oneof {
    string name = 4;
    SubMessage sub_message = 9;
  }
}

次に、oneofフィールドをoneof定義に追加します。mapフィールドとrepeatedフィールドを除く、あらゆる型のフィールドを追加できます。repeatedフィールドをoneofに追加する必要がある場合は、repeatedフィールドを含むメッセージを使用できます。

生成されたコードでは、oneofフィールドは通常のフィールドと同じゲッターとセッターを持ちます。また、oneof内でどの値が設定されているか（もしあれば）をチェックするための特別なメソッドも取得します。選択した言語のoneof APIの詳細については、関連するAPIリファレンスを参照してください。

Oneofの機能

• oneofフィールドを設定すると、oneofの他のすべてのメンバーが自動的にクリアされます。そのため、複数のoneofフィールドを設定した場合、最後に設定したフィールドのみが値を持ち続けます。

  SampleMessage message;
  message.set_name("name");
  CHECK(message.has_name());
  // Calling mutable_sub_message() will clear the name field and will set
  // sub_message to a new instance of SubMessage with none of its fields set.
  message.mutable_sub_message();
  CHECK(!message.has_name());
  

• パーサーがワイヤー上で同じoneofの複数のメンバーを検出した場合、解析されたメッセージでは最後に検出されたメンバーのみが使用されます。ワイヤー上のデータを解析するときは、バイトの最初から開始し、次の値を評価して、以下の解析ルールを適用します。

  • まず、同じoneof内の*異なる*フィールドが現在設定されているかを確認し、設定されていればそれをクリアします。

  • 次に、そのフィールドがoneof内にないかのように内容を適用します。

    • プリミティブは、既に設定されている値を上書きします。
    • メッセージは、すでに設定されている値にマージされます。

• 拡張機能はoneofではサポートされていません。

• oneofは`repeated`にできません。

• リフレクションAPIはoneofフィールドに対して機能します。

• oneofフィールドをデフォルト値に設定した場合（例えば、int32のoneofフィールドを0に設定するなど）、そのoneofフィールドの「ケース」が設定され、値はワイヤー上でシリアライズされます。

• C++を使用している場合は、コードがメモリクラッシュを引き起こさないように注意してください。以下のサンプルコードは、`set_name()`メソッドを呼び出すことによって`sub_message`がすでに削除されているため、クラッシュします。

  SampleMessage message;
  SubMessage* sub_message = message.mutable_sub_message();
  message.set_name("name");      // Will delete sub_message
  sub_message->set_...            // Crashes here
  

• 再びC++で、oneofを持つ2つのメッセージを`Swap()`すると、各メッセージは他方のoneofケースを持つことになります。以下の例では、`msg1`は`sub_message`を持ち、`msg2`は`name`を持つことになります。

  SampleMessage msg1;
  msg1.set_name("name");
  SampleMessage msg2;
  msg2.mutable_sub_message();
  msg1.swap(&msg2);
  CHECK(msg1.has_sub_message());
  CHECK(msg2.has_name());
  

後方互換性の問題

oneofフィールドの追加または削除には注意してください。oneofの値をチェックしてNone/NOT_SETが返された場合、oneofが設定されていないか、oneofの異なるバージョンでフィールドが設定されている可能性があります。ワイヤー上の不明なフィールドがoneofのメンバーであるかどうかを知る方法がないため、違いを区別する方法はありません。

タグの再利用に関する問題

• **単一フィールドをoneofに出し入れする**: メッセージがシリアライズおよび解析された後、情報の一部が失われる可能性があります（一部のフィールドがクリアされます）。ただし、単一フィールドを**新しい**oneofに安全に移動でき、1つだけが常に設定されていることがわかっている場合は、複数のフィールドを移動できる場合があります。詳細については、メッセージ型の更新を参照してください。
• oneofフィールドを削除して再度追加する: メッセージがシリアライズされ、パースされた後、現在設定されているoneofフィールドがクリアされる可能性があります。
• **oneofの分割またはマージ**: これは単一フィールドの移動と同様の問題があります。

マップ

データ定義の一部として連想マップを作成したい場合、プロトコルバッファは便利なショートカット構文を提供します。

map<key_type, value_type> map_field = N;

...ここで、key_typeは任意の整数型または文字列型（つまり、浮動小数点型とbytesを除くすべてのスカラー型）にすることができます。enum型もprotoメッセージもkey_typeには有効ではありません。value_typeは、別のmapを除く任意の型にすることができます。

したがって、たとえば、各`Project`メッセージが文字列キーに関連付けられているプロジェクトのマップを作成したい場合、次のように定義できます。

map<string, Project> projects = 3;

マップの機能

• マップでは拡張機能はサポートされていません。
• マップフィールドはrepeatedにできません。
• マップ値のワイヤーフォーマットの順序とマップの反復順序は未定義であるため、マップ項目が特定の順序であることに依存することはできません。
• `.proto`のテキストフォーマットを生成する際、マップはキーによってソートされます。数値キーは数値的にソートされます。
• ワイヤーからパースする場合やマージする場合、重複したマップキーが存在すると、最後に見つかったキーが使用されます。テキストフォーマットからマップをパースする場合、重複したキーがあるとパースに失敗することがあります。
• マップフィールドにキーは提供するが値を提供しない場合、フィールドがシリアライズされる際の動作は言語に依存します。C++、Java、Kotlin、Pythonでは型のデフォルト値がシリアライズされますが、他の言語では何もシリアライズされません。
• シンボル `FooEntry` は、マップ `foo` と同じスコープに存在できません。なぜなら、`FooEntry` はマップの実装によってすでに使用されているからです。

生成されたマップAPIは、現在サポートされているすべての言語で利用可能です。選択した言語のマップAPIの詳細については、関連するAPIリファレンスで確認できます。

後方互換性

マップ構文は、ワイヤー上では以下のものと等価であるため、マップをサポートしていないプロトコルバッファ実装でもデータを処理できます。

message MapFieldEntry {
  key_type key = 1;
  value_type value = 2;
}

repeated MapFieldEntry map_field = N;

マップをサポートするプロトコルバッファ実装は、以前の定義で受け入れ可能なデータを生成し、受け入れる必要があります。

パッケージ

プロトコルメッセージタイプ間の名前の衝突を防ぐために、`.proto`ファイルにオプションの`package`指定子を追加できます。

package foo.bar;
message Open { ... }

その後、メッセージタイプのフィールドを定義する際にパッケージ指定子を使用できます。

message Foo {
  ...
  foo.bar.Open open = 1;
  ...
}

パッケージ指定子が生成されたコードにどのように影響するかは、選択した言語によって異なります。

• C++では、生成されたクラスはC++の名前空間内にラップされます。たとえば、`Open`は`foo::bar`という名前空間に入ります。
• JavaおよびKotlinでは、`.proto`ファイルで明示的に`option java_package`を指定しない限り、パッケージはJavaのパッケージとして使用されます。
• Pythonでは、Pythonモジュールはファイルシステム内の場所によって整理されるため、`package`ディレクティブは無視されます。
• Goでは、packageディレクティブは無視され、生成される.pb.goファイルは、対応するgo_proto_library Bazelルールにちなんで名付けられたパッケージに配置されます。オープンソースプロジェクトの場合、go_packageオプションを指定するか、Bazelの-Mフラグを設定する**必要があります**。
• Rubyでは、生成されたクラスはネストされたRubyネームスペースでラップされ、必要なRubyの大文字小文字スタイル（最初の文字が大文字。最初の文字がアルファベットでない場合はPB_が前置されます）に変換されます。たとえば、OpenはFoo::Barネームスペースに属します。
• PHPでは、.protoファイルで明示的にoption php_namespaceを指定しない限り、パッケージはPascalCaseに変換された後、名前空間として使用されます。例えば、OpenはFoo\Barという名前空間になります。
• C#では、.protoファイルで明示的にoption csharp_namespaceを提供しない限り、パッケージはPascalCaseに変換された後、名前空間として使用されます。例えば、OpenはFoo.Barという名前空間になります。

Pythonのようにpackageディレクティブが生成コードに直接影響を与えない場合でも、.protoファイルにパッケージを指定することを強くお勧めします。そうしないと、記述子で名前の競合が発生したり、他の言語でプロトを移植できなくなる可能性があるためです。

パッケージと名前解決

プロトコルバッファ言語における型名の解決はC++のように機能します。まず最も内側のスコープが検索され、次にその外側のスコープが検索され、各パッケージはその親パッケージに対して「内側」とみなされます。先頭の「.」（例: .foo.bar.Baz）は、最も外側のスコープから開始することを意味します。

プロトコルバッファコンパイラは、インポートされた`.proto`ファイルを解析することですべての型名を解決します。各言語のコードジェネレータは、異なるスコーピングルールを持っていても、その言語で各型を参照する方法を知っています。

サービスの定義

RPC (Remote Procedure Call) システムでメッセージ型を使用したい場合、.protoファイルでRPCサービスインターフェースを定義でき、プロトコルバッファコンパイラは選択した言語でサービスインターフェースコードとスタブを生成します。たとえば、SearchRequestを受け取り、SearchResponseを返すメソッドを持つRPCサービスを定義したい場合、.protoファイルで次のように定義できます。

service SearchService {
  rpc Search(SearchRequest) returns (SearchResponse);
}

Protocol Buffersで最も簡単なRPCシステムは、Googleで開発された言語・プラットフォームに依存しないオープンソースのRPCシステムであるgRPCです。gRPCはProtocol Buffersと特に相性が良く、特別なプロトコルバッファコンパイラプラグインを使用して、.protoファイルから直接関連するRPCコードを生成できます。

gRPCを使用しない場合でも、独自のRPC実装でプロトコルバッファを使用することも可能です。これについては、Proto2言語ガイドで詳しく知ることができます。

Protocol Buffers用のRPC実装を開発するサードパーティプロジェクトも多数進行中です。既知のプロジェクトへのリンクのリストについては、サードパーティアドオンのwikiページを参照してください。

JSONマッピング

標準のprotobufバイナリワイヤー形式は、protobufを使用する2つのシステム間の通信に推奨されるシリアル化形式です。protobufワイヤー形式ではなくJSONを使用するシステムとの通信には、ProtobufはProtoJSONの規範的なエンコーディングをサポートしています。

オプション

.protoファイル内の個々の宣言には、多数の*オプション*を付加できます。オプションは宣言の全体的な意味を変更しませんが、特定のコンテキストでの処理方法に影響を与える可能性があります。利用可能なオプションの完全なリストは、/google/protobuf/descriptor.protoで定義されています。

いくつかのオプションはファイルレベルのオプションであり、メッセージ、enum、またはサービス定義の内部ではなく、トップレベルのスコープで記述する必要があります。いくつかのオプションはメッセージレベルのオプションであり、メッセージ定義の内部に記述する必要があります。いくつかのオプションはフィールドレベルのオプションであり、フィールド定義の内部に記述する必要があります。オプションはenum型、enum値、oneofフィールド、サービス型、およびサービスメソッドにも記述できますが、現在、これらのいずれにも有用なオプションは存在しません。

以下は、最も一般的に使用されるオプションのいくつかです。

• java_package (ファイルオプション): 生成されるJava/Kotlinクラスに使用したいパッケージ。.protoファイルで明示的なjava_packageオプションが指定されていない場合、デフォルトでprotoパッケージ（.protoファイル内の「package」キーワードで指定）が使用されます。ただし、protoパッケージは通常、逆ドメイン名で始まることが期待されていないため、良いJavaパッケージにはなりません。JavaまたはKotlinコードを生成しない場合、このオプションは効果がありません。

  option java_package = "com.example.foo";
  

• java_outer_classname (ファイルオプション): 生成したいラッパーJavaクラスのクラス名（およびファイル名）。.protoファイルに明示的なjava_outer_classnameが指定されていない場合、クラス名は.protoファイル名をキャメルケースに変換して作成されます（たとえば、foo_bar.protoはFooBar.javaになります）。java_multiple_filesオプションが無効な場合、.protoファイル用に生成される他のすべてのクラス/enumなどは、この外側のラッパーJavaクラスの*内部*にネストされたクラス/enumなどとして生成されます。Javaコードを生成しない場合、このオプションは効果がありません。

  option java_outer_classname = "Ponycopter";
  

• java_multiple_files (ファイルオプション): falseの場合、この.protoファイルに対しては単一の.javaファイルのみが生成され、トップレベルのメッセージ、サービス、列挙型のために生成されたすべてのJavaクラス/列挙型などは、外側のクラス（java_outer_classnameを参照）の内部にネストされます。trueの場合、トップレベルのメッセージ、サービス、列挙型のために生成された各Javaクラス/列挙型などに対して個別の.javaファイルが生成され、この.protoファイルのために生成されたラッパーJavaクラスには、ネストされたクラス/列挙型などは含まれません。これはブール型のオプションで、デフォルトはfalseです。Javaコードを生成しない場合、このオプションは効果がありません。これはエディション2024で削除され、features.(pb.java).nest_in_file_classに置き換えられました。

  option java_multiple_files = true;
  

• `optimize_for` (ファイルオプション): `SPEED`、`CODE_SIZE`、または`LITE_RUNTIME`に設定できます。これはC++およびJavaのコードジェネレータ（および場合によってはサードパーティのジェネレータ）に次のように影響します。

  • `SPEED` (デフォルト): プロトコルバッファコンパイラは、メッセージタイプのシリアライズ、パース、その他の一般的な操作のためのコードを生成します。このコードは高度に最適化されています。
  • CODE_SIZE: プロトコルバッファコンパイラは最小限のクラスを生成し、シリアライズ、解析、その他のさまざまな操作を実装するために共有されたリフレクションベースのコードに依存します。したがって、生成されるコードはSPEEDよりもはるかに小さくなりますが、操作は遅くなります。クラスはSPEEDモードとまったく同じ公開APIを実装します。このモードは、非常に多くの.protoファイルを抱え、それらすべてが非常に高速である必要がないアプリで最も役立ちます。
  • LITE_RUNTIME: プロトコルバッファコンパイラは、「ライト」ランタイムライブラリ（libprotobufではなくlibprotobuf-lite）のみに依存するクラスを生成します。ライトランタイムはフルライブラリよりもはるかに小さく（約1桁小さい）、記述子やリフレクションなどの特定の機能は省略されています。これは、携帯電話などの制約のあるプラットフォームで実行されるアプリにとって特に役立ちます。コンパイラは、SPEEDモードと同じように、すべてのメソッドの高速実装を生成します。生成されたクラスは、各言語でMessageLiteインターフェースのみを実装し、これはフルMessageインターフェースのメソッドのサブセットのみを提供します。

  option optimize_for = CODE_SIZE;
  

• cc_generic_services、java_generic_services、py_generic_services（ファイルオプション）：**汎用サービスは非推奨です。**プロトコルバッファコンパイラがC++、Java、Pythonでそれぞれサービス定義に基づいて抽象サービスコードを生成するかどうか。レガシーの理由から、これらはデフォルトでtrueです。しかし、バージョン2.3.0（2010年1月）以降、RPC実装は、「抽象」サービスに依存するのではなく、各システムに特化したコードを生成するためのコードジェネレータプラグインを提供することが望ましいとされています。

  // This file relies on plugins to generate service code.
  option cc_generic_services = false;
  option java_generic_services = false;
  option py_generic_services = false;
  

• `cc_enable_arenas` (ファイルオプション): C++で生成されたコードに対してアリーナアロケーションを有効にします。

• objc_class_prefix (ファイルオプション): この.protoから生成されるすべてのObjective-Cクラスとenumの前に付加されるObjective-Cクラスプレフィックスを設定します。デフォルトはありません。Appleが推奨するように、3〜5文字の大文字のプレフィックスを使用する必要があります。2文字のプレフィックスはすべてAppleによって予約されていることに注意してください。

• packed (フィールド オプション): protobuf エディションでは、このオプションは true に固定されています。アンパックされたワイヤーフォーマットを使用するには、エディション機能を使用してこのオプションをオーバーライドできます。これにより、以下の例に示すように、バージョン 2.3.0 以前のパーサーとの互換性が提供されます (ほとんど必要ありません)。

  repeated int32 samples = 4 [features.repeated_field_encoding = EXPANDED];
  

• deprecated (フィールド オプション): true に設定すると、フィールドが非推奨であり、新しいコードでは使用すべきではないことを示します。ほとんどの言語では、これは実際には効果がありません。Java では、これは @Deprecated アノテーションになります。C++ では、clang-tidy は非推奨フィールドが使用されるたびに警告を生成します。将来的には、他の言語固有のコード ジェネレーターがフィールドのアクセサーに非推奨アノテーションを生成する可能性があり、その結果、フィールドを使用しようとするコードをコンパイルする際に警告が発行されます。フィールドが誰にも使用されておらず、新しいユーザーが使用することを防ぎたい場合は、フィールド宣言を予約済みステートメントに置き換えることを検討してください。

  int32 old_field = 6 [deprecated = true];
  

列挙値のオプション

Enum値のオプションがサポートされています。`deprecated`オプションを使用して、ある値がもはや使用されるべきでないことを示すことができます。拡張機能を使用してカスタムオプションを作成することもできます。

次の例は、これらのオプションを追加するための構文を示しています。

import "google/protobuf/descriptor.proto";

extend google.protobuf.EnumValueOptions {
  string string_name = 123456789;
}

enum Data {
  DATA_UNSPECIFIED = 0;
  DATA_SEARCH = 1 [deprecated = true];
  DATA_DISPLAY = 2 [
    (string_name) = "display_value"
  ];
}

`string_name`オプションを読み取るC++コードは、次のようになるかもしれません。

const absl::string_view foo = proto2::GetEnumDescriptor<Data>()
    ->FindValueByName("DATA_DISPLAY")->options().GetExtension(string_name);

enum値やフィールドにカスタムオプションを適用する方法については、カスタムオプションを参照してください。

カスタムオプション

プロトコルバッファでは、独自のオプションを定義して使用することもできます。ただし、これはほとんどの人が必要としない**高度な機能**であることに注意してください。独自のオプションを作成する必要があると思われる場合は、詳細についてProto2言語ガイドを参照してください。カスタムオプションの作成には拡張機能が使用されることに注意してください。

エディション2024以降、import optionを使用してカスタムオプション定義をインポートします。インポートを参照してください。

オプションの保持

オプションには*リテンション*という概念があり、これはオプションが生成されたコードに残るかどうかを制御します。オプションはデフォルトで*ランタイムリテンション*であり、生成されたコードに残るため、生成された記述子プールでランタイム時に表示されます。ただし、retention = RETENTION_SOURCEを設定して、オプション（またはオプション内のフィールド）がランタイム時に保持されないように指定できます。これは*ソースリテンション*と呼ばれます。

オプションの保持は、ほとんどのユーザーが心配する必要のない高度な機能ですが、バイナリで保持するためのコードサイズのコストを払うことなく特定のオプションを使用したい場合に役立ちます。ソース保持のオプションは、protocおよびprotocプラグインに対して引き続き可視であるため、コードジェネレータはそれらを使用して動作をカスタマイズできます。

保持は、次のようにオプションに直接設定できます。

extend google.protobuf.FileOptions {
  int32 source_retention_option = 1234
      [retention = RETENTION_SOURCE];
}

通常のフィールドにも設定できますが、その場合、そのフィールドがオプション内に現れる場合にのみ効果があります。

message OptionsMessage {
  int32 source_retention_field = 1 [retention = RETENTION_SOURCE];
}

retention = RETENTION_RUNTIME と設定することもできますが、これはデフォルトの動作であるため効果はありません。メッセージ フィールドが RETENTION_SOURCE とマークされている場合、その内容全体が破棄されます。その内部のフィールドは、RETENTION_RUNTIME を設定しようとしてもそれをオーバーライドすることはできません。

オプションのターゲット

フィールドにはtargetsオプションがあり、オプションとして使用される場合にフィールドが適用されるエンティティのタイプを制御します。たとえば、フィールドにtargets = TARGET_TYPE_MESSAGEが設定されている場合、そのフィールドはenum（または他の非メッセージエンティティ）上のカスタムオプションに設定できません。Protocはこれを強制し、ターゲット制約に違反がある場合はエラーを発生させます。

一見すると、この機能は不要に見えるかもしれません。なぜなら、すべてのカスタムオプションは特定のエンティティのオプションメッセージの拡張であり、すでにその1つのエンティティにオプションを制約しているからです。しかし、オプションターゲットは、複数のエンティティタイプに適用される共有オプションメッセージがあり、そのメッセージ内の個々のフィールドの使用を制御したい場合に役立ちます。例えば、

message MyOptions {
  string file_only_option = 1 [targets = TARGET_TYPE_FILE];
  int32 message_and_enum_option = 2 [targets = TARGET_TYPE_MESSAGE,
                                     targets = TARGET_TYPE_ENUM];
}

extend google.protobuf.FileOptions {
  MyOptions file_options = 50000;
}

extend google.protobuf.MessageOptions {
  MyOptions message_options = 50000;
}

extend google.protobuf.EnumOptions {
  MyOptions enum_options = 50000;
}

// OK: this field is allowed on file options
option (file_options).file_only_option = "abc";

message MyMessage {
  // OK: this field is allowed on both message and enum options
  option (message_options).message_and_enum_option = 42;
}

enum MyEnum {
  MY_ENUM_UNSPECIFIED = 0;
  // Error: file_only_option cannot be set on an enum.
  option (enum_options).file_only_option = "xyz";
}

クラスの生成

.protoファイルで定義されたメッセージ型を操作するために必要なJava、Kotlin、Python、C++、Go、Ruby、Objective-C、またはC#コードを生成するには、.protoファイルに対してプロトコルバッファコンパイラprotocを実行する必要があります。コンパイラをインストールしていない場合は、パッケージをダウンロードし、READMEの指示に従ってください。Goの場合、コンパイラ用の特別なコードジェネレータプラグインもインストールする必要があります。これはGitHubのgolang/protobufリポジトリで入手でき、インストール手順も記載されています。

プロトコルコンパイラは次のように起動します。

protoc --proto_path=IMPORT_PATH --cpp_out=DST_DIR --java_out=DST_DIR --python_out=DST_DIR --go_out=DST_DIR --ruby_out=DST_DIR --objc_out=DST_DIR --csharp_out=DST_DIR path/to/file.proto

• IMPORT_PATHは、importディレクティブを解決する際に.protoファイルを探すディレクトリを指定します。省略された場合、現在のディレクトリが使用されます。複数のインポートディレクトリは、--proto_pathオプションを複数回渡すことで指定できます。それらは順に検索されます。-I=_IMPORT_PATH_は--proto_pathの省略形として使用できます。

注: proto_pathに対するファイルパスは、特定のバイナリ内でグローバルに一意である必要があります。たとえば、proto/lib1/data.protoとproto/lib2/data.protoがある場合、これらの2つのファイルを-I=proto/lib1 -I=proto/lib2と一緒に使用することはできません。なぜなら、import "data.proto"がどのファイルを意味するのか曖昧になるからです。代わりに-Iproto/を使用し、グローバル名はlib1/data.protoとlib2/data.protoになります。

ライブラリを公開しており、他のユーザーがメッセージを直接使用する可能性がある場合は、ファイル名の衝突を避けるために、パスに一意のライブラリ名を含めて使用することが期待されます。1つのプロジェクト内に複数のディレクトリがある場合は、プロジェクトのトップレベルディレクトリに1つの-Iを設定することを推奨します。

• 1つ以上の出力ディレクティブを指定できます。

  • --cpp_outはDST_DIRにC++コードを生成します。詳細については、C++生成コードリファレンスを参照してください。
  • --java_outはDST_DIRにJavaコードを生成します。詳細については、Java生成コードリファレンスを参照してください。
  • --kotlin_outはDST_DIRにKotlinコードを追加で生成します。詳細については、Kotlin生成コードリファレンスを参照してください。
  • --python_outはDST_DIRにPythonコードを生成します。詳細については、Python生成コードリファレンスを参照してください。
  • --go_outはDST_DIRにGoコードを生成します。詳細については、Go生成コードリファレンスを参照してください。
  • --ruby_outはDST_DIRにRubyコードを生成します。詳細については、Ruby生成コードリファレンスを参照してください。
  • --objc_outはDST_DIRにObjective-Cコードを生成します。詳細については、Objective-C生成コードリファレンスを参照してください。
  • --csharp_outはDST_DIRにC#コードを生成します。詳細については、C#生成コードリファレンスを参照してください。
  • --php_outはDST_DIRにPHPコードを生成します。詳細については、PHP生成コードリファレンスを参照してください。

  便利な追加機能として、DST_DIRが.zipまたは.jarで終わる場合、コンパイラは出力を指定された名前の単一のZIP形式アーカイブファイルに書き込みます。.jar出力には、Java JAR仕様で要求されるマニフェストファイルも与えられます。出力アーカイブが既に存在する場合、上書きされることに注意してください。

• 1つ以上の.protoファイルを入力として指定する必要があります。複数の.protoファイルを一度に指定できます。ファイルは現在のディレクトリからの相対パスで指定されますが、各ファイルはコンパイラがその正規名を決定できるように、いずれかのIMPORT_PATHに存在する必要があります。

ファイルの場所

.protoファイルを他の言語ソースと同じディレクトリに置かないことを推奨します。プロジェクトのルートパッケージの下に、.protoファイル用のサブパッケージprotoを作成することを検討してください。

場所は言語に依存しないようにすべき

Javaコードを扱う場合、関連する.protoファイルをJavaソースと同じディレクトリに配置すると便利です。しかし、Java以外のコードが同じプロトをいつか使用する場合、パスのプレフィックスは意味をなさなくなります。したがって、一般的には、プロトを//myteam/mypackageのような関連する言語に依存しないディレクトリに配置することをお勧めします。

このルールの例外は、プロトがJavaコンテキストでのみ使用されることが明確な場合、たとえばテスト用の場合です。

サポートされているプラットフォーム

に関する情報

• サポートされているオペレーティングシステム、コンパイラ、ビルドシステム、C++バージョンについては、Foundational C++ Support Policyを参照してください。
• サポートされているPHPバージョンについては、サポートされているPHPバージョンを参照してください。