protobuf3でオプションのフィールドを定義する方法

protobuf（proto3構文）のオプションフィールドでメッセージを指定する必要があります。プロト2構文に関して、私が表現したいメッセージは次のようなものです。

message Foo {
    required int32 bar = 1;
    optional int32 baz = 2;
}

私の理解では、「オプションの」概念は構文プロト3から削除されました（必須の概念とともに）。代替案は明確ではありませんが、デフォルト値を使用して、送信者からフィールドが指定されていないことを示しますが、デフォルト値が有効な値のドメインに属している場合はあいまいさを残します（たとえばブール型を検討してください）。

では、上記のメッセージをどのようにエンコードするのですか？ありがとうございました。

protobufリリース3.12以降、proto3は、optionalキーワードを使用して（proto2と同様に）スカラー場のプレゼンス情報を提供するための実験的なサポートを提供しています。

syntax = "proto3";

message Foo {
    int32 bar = 1;
    optional int32 baz = 2;
}

A has_baz()/hasBaz()方法がために生成されoptional、それはproto2にあったと同じように、上のフィールド。

内部的には、Cyber​​Snoopyの回答が示唆optionalしているように、protocはフィールドをoneofラッパーを使用して宣言されているかのように効果的に処理します。

message Foo {
    int32 bar = 1;
    oneof optional_baz {
        int32 baz = 2;
    }
}

すでにそのアプローチを使用している場合は、ワイヤー形式が同じであるため、proto3サポートが実験ステータスを卒業したら、メッセージ宣言をクリーンアップ（からoneofに切り替えるoptional）できますoptional。

フィールドプレゼンスとoptionalproto3の詳細については、アプリケーションノート：フィールドプレゼンスのドキュメントをご覧ください。

--experimental_allow_proto3_optionalリリース3.12でこの機能を使用するには、フラグをprotocに渡します。機能の発表は、それが「うまくいけば3.13で一般的に利用可能」になりますと言います。

2020年11月の更新：この機能は、リリース3.14でもまだ実験的（フラグが必要）と見なされています。ある兆候行われて進歩のは。

proto3では、すべてのフィールドは「オプション」です（送信者が設定に失敗してもエラーにはなりません）。ただし、フィールドがデフォルト値に明示的に設定されているか、まったく設定されていないかを区別する方法がないため、フィールドは「null許容」ではなくなりました。

「null」状態が必要な場合（そしてこれに使用できる範囲外の値がない場合）、代わりにこれを別のフィールドとしてエンコードする必要があります。たとえば、次のことができます。

message Foo {
  bool has_baz = 1;  // always set this to "true" when using baz
  int32 baz = 2;
}

または、次を使用することもできますoneof。

message Foo {
  oneof baz {
    bool baz_null = 1;  // always set this to "true" when null
    int32 baz_value = 2;
  }
}

このoneofバージョンは、ネットワーク上でより明確で効率的ですが、oneof値がどのように機能するかを理解する必要があります。

最後に、もう1つの完全に合理的なオプションは、proto2を使用することです。Proto2は非推奨ではなく、実際、多くのプロジェクト（Google内を含む）はproto3で削除されたproto2機能に大きく依存しているため、切り替えられることはないでしょう。したがって、当面の間、それを使用し続けることは安全です。

1つの方法はoptional、受け入れられた回答に記載されているようにすることです：https：//stackoverflow.com/a/62566052/1803821

もう1つは、ラッパーオブジェクトを使用することです。グーグルがすでにそれらを提供しているので、あなたはそれらを自分で書く必要はありません：

.protoファイルの先頭に次のインポートを追加します。

import "google/protobuf/wrappers.proto";

これで、すべての単純なタイプに特別なラッパーを使用できます。

DoubleValue
FloatValue
Int64Value
UInt64Value
Int32Value
UInt32Value
BoolValue
StringValue
BytesValue

したがって、元の質問に答えるには、このようなラッパーの使用法は次のようになります。

message Foo {
    int32 bar = 1;
    google.protobuf.Int32Value baz = 2;
}

たとえばJavaでは、次のようなことができます。

if(foo.hasBaz()) { ... }

ケントンの回答に基づくと、よりシンプルでありながら機能するソリューションは次のようになります。

message Foo {
    oneof optional_baz { // "optional_" prefix here just serves as an indicator, not keyword in proto2
        int32 baz = 1;
    }
}

@cybersnoopyの提案をここで拡張するには

次のようなメッセージを含む.protoファイルがある場合：

message Request {
    oneof option {
        int64 option_value = 1;
    }
}

提供されているケースオプションを利用できます（Javaで生成されたコード）：

したがって、次のようにコードを記述できます。

Request.OptionCase optionCase = request.getOptionCase();
OptionCase optionNotSet = OPTION_NOT_SET;

if (optionNotSet.equals(optionCase)){
    // value not set
} else {
    // value set
}

これについての良い投稿があります：https：//itnext.io/protobuf-and-null-support-1908a15311b6

解決策は、実際のユースケースによって異なります。

• 部分更新の処理

• nullをサポート

意図するメッセージをエンコードする別の方法は、「セット」フィールドを追跡するために別のフィールドを追加することです。

syntax="proto3";

package qtprotobuf.examples;

message SparseMessage {
    repeated uint32 fieldsUsed = 1;
    bool   attendedParty = 2;
    uint32 numberOfKids  = 3;
    string nickName      = 4;
}

message ExplicitMessage {
    enum PARTY_STATUS {ATTENDED=0; DIDNT_ATTEND=1; DIDNT_ASK=2;};
    PARTY_STATUS attendedParty = 1;
    bool   indicatedKids = 2;
    uint32 numberOfKids  = 3;
    enum NO_NICK_STATUS {HAS_NO_NICKNAME=0; WOULD_NOT_ADMIT_TO_HAVING_HAD_NICKNAME=1;};
    NO_NICK_STATUS noNickStatus = 4;
    string nickName      = 5;
}

これは、フィールドの数が多く、割り当てられているフィールドの数が少ない場合に特に適しています。

Pythonでは、使用法は次のようになります。

import field_enum_example_pb2
m = field_enum_example_pb2.SparseMessage()
m.attendedParty = True
m.fieldsUsed.append(field_enum_example_pb2.SparseMessages.ATTENDEDPARTY_FIELD_NUMBER)

もう1つの方法は、オプションのフィールドごとにビットマスクを使用できることです。値が設定されている場合はそれらのビットを設定し、値が設定されていないビットをリセットします

enum bitsV {
    baz_present = 1; // 0x01
    baz1_present = 2; // 0x02

}
message Foo {
    uint32 bitMask;
    required int32 bar = 1;
    optional int32 baz = 2;
    optional int32 baz1 = 3;
}

解析時にbitMaskの値を確認します。

if (bitMask & baz_present)
    baz is present

if (bitMask & baz1_present)
    baz1 is present

参照をデフォルトのインスタンスと比較することで、初期化されているかどうかを確認できます。

GRPCContainer container = myGrpcResponseBean.getContainer();
if (container.getDefaultInstanceForType() != container) {
...
}