Як визначити необов’язкове поле в protobuf 3

Мені потрібно вказати повідомлення з необов’язковим полем у протобуфі (синтаксис прото3). З точки зору синтаксису прото 2, повідомлення, яке я хочу висловити, є приблизно таким:

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

З мого розуміння, "необов'язкова" концепція була вилучена із синтаксису proto 3 (разом із необхідною концепцією). Хоча альтернатива незрозуміла - використання значення за замовчуванням, щоб зазначити, що поле не було вказано від відправника, залишає неоднозначність, якщо значення за замовчуванням належить до дійсних значень (розглянемо, наприклад, логічний тип).

Отже, як я повинен кодувати повідомлення вище? Дякую.

З часу випуску протобуфа 3.12 прото3 має експериментальну підтримку використання optionalключового слова (так само, як у прото2) для надання інформації про наявність скалярного поля.

syntax = "proto3";

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

A has_baz()/ hasBaz()метод генерується для optionalполя вище, так само, як це було в proto2.

Під капотом protoc ефективно обробляє optionalполе так, ніби воно було оголошено за допомогою oneofобгортки, як випливає з відповіді CyberSnoopy :

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

Якщо ви вже використовували такий підхід, ви зможете очистити свої декларації повідомлень (переключитися з oneofна optional) після того, як прото3 optionalпідтримає випускників із експериментального статусу, оскільки формат проводів однаковий.

Ви можете знайти деталізовану деталі щодо присутності полів та optionalпротокол 3 у примітці до програми: Документ про наявність полів

Передайте --experimental_allow_proto3_optionalпрапор протоку, щоб використовувати цю функцію у випуску 3.12. В анонсі функції зазначено, що вона буде "загальнодоступною, сподіваємося, через 3.13".

Оновлення від листопада 2020 р .: Функція все ще вважається експериментальною (потрібен прапор) у випуску 3.14 . Є ознаки прогресу.

У протоці3 всі поля є "необов'язковими" (оскільки це не помилка, якщо відправник не може їх встановити). Але поля перестають бути "нульовими", оскільки немає можливості визначити різницю між полем, яке явно встановлено за значенням за замовчуванням, і не встановленим взагалі.

Якщо вам потрібен "нульовий" стан (і немає жодного значення поза діапазоном, яке ви можете використовувати для цього), тоді вам потрібно буде закодувати це як окреме поле. Наприклад, ви можете зробити:

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працюють значення.

Нарешті, ще один цілком розумний варіант - дотримуватися прото2. Proto2 не є застарілим, і насправді багато проектів (у тому числі всередині Google) дуже залежать від функцій proto2, які видаляються в proto3, отже, вони, швидше за все, ніколи не перейдуть. Отже, можна продовжувати використовувати його в найближчому майбутньому.

Один із способів - optionalсподобатися описаному у прийнятій відповіді: https://stackoverflow.com/a/62566052/1803821

Інший - використання обгорткових об’єктів. Вам не потрібно писати їх самостійно, оскільки Google вже їх надає:

Угорі файлу .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)

Інший спосіб полягає в тому, що ви можете використовувати бітову маску для кожного необов’язкового поля. і встановити ці біти, якщо встановлені значення, і скинути ті біти, значення яких не встановлені

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) {
...
}