Protobuf 3'te isteğe bağlı bir alan nasıl tanımlanır

Protobuf'ta (proto3 sözdizimi) isteğe bağlı bir alana sahip bir mesaj belirtmem gerekiyor. Proto 2 sözdizimi açısından, ifade etmek istediğim mesaj şöyle bir şeydir:

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

Anladığım kadarıyla "isteğe bağlı" kavramı sözdizimi proto 3'ten çıkarıldı (gerekli kavramla birlikte). Alternatif açık olmasa da - göndericiden bir alanın belirtilmediğini belirtmek için varsayılan değeri kullanmak, varsayılan değer geçerli değerler etki alanına aitse bir belirsizlik bırakır (örneğin, bir boole türünü düşünün).

Öyleyse, yukarıdaki mesajı nasıl kodlayacağım? Teşekkür ederim.

Protobuf sürüm 3.12'den bu yana , proto3, optionalskaler alan varlığı bilgisi vermek için anahtar sözcüğü (proto2'de olduğu gibi) kullanmayı desteklemektedir .

syntax = "proto3";

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

Yukarıdaki alan için proto2'de olduğu gibi bir has_baz()/ hasBaz()yöntem oluşturulur optional.

Protoc , CyberSnoopy'nin cevabının önerdiği gibi, bir optionalalanı bir oneofsarmalayıcı kullanılarak bildirilmiş gibi etkili bir şekilde ele alır :

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

Zaten bu yaklaşımı kullandıysanız, mesajınızın bildirimleri (dan geçiş temizleyebilir oneofiçin optionaltel formatı aynı olduğu,).

Alan varlığı ve optionalproto3 ile ilgili nitty -cesur ayrıntıları Uygulama notu: Saha varlığı belgesinde bulabilirsiniz .

3.12 sürümünde, bu işlevsellik, --experimental_allow_proto3_optionalbayrağın protoc'a aktarılmasını gerektirir . Özellik duyuru o “3.13 yılında inşallah genel olarak mevcut” olacağını söylüyor.

Ekim 2020 Güncellemesi: Bu özellik, 3.13 sürümünde hala deneysel olarak kabul edilmektedir (işaret gereklidir) .

Proto3'te tüm alanlar "isteğe bağlıdır" (yani gönderenin bunları ayarlamaması bir hata değildir). Ancak alanlar artık "boş değer atanabilir" değildir, çünkü bir alanın açıkça varsayılan değerine ayarlanması ile hiç ayarlanmaması arasındaki farkı anlamanın bir yolu yoktur.

Bir "boş" durumuna ihtiyacınız varsa (ve bunun için kullanabileceğiniz aralık dışı değer yoksa), bunun yerine bunu ayrı bir alan olarak kodlamanız gerekecektir. Örneğin şunları yapabilirsiniz:

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

Alternatif olarak şunları kullanabilirsiniz oneof:

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

oneofVersiyon teline daha açık ve daha verimlidir ama nasıl anlamak gerekir oneofdeğerler çalışır.

Son olarak, bir diğer makul seçenek de proto2'ye bağlı kalmaktır. Proto2 kullanımdan kaldırılmamıştır ve aslında birçok proje (Google içinde dahil), proto3'te kaldırılan proto2 özelliklerine çok bağlıdır, bu nedenle muhtemelen hiçbir zaman geçiş yapmazlar. Bu nedenle, öngörülebilir gelecekte kullanmaya devam etmek güvenlidir.

Bunun bir yolu, oneofkabul edilen cevapta önerildiği gibi kullanmaktır .

Bir diğeri ise sarmalayıcı nesneler kullanmaktır. Google zaten sağladığı için bunları kendiniz yazmanıza gerek yok:

.Proto dosyanızın en üstüne bu içe aktarmayı ekleyin:

import "google/protobuf/wrappers.proto";

Artık her basit tür için özel sarmalayıcılar kullanabilirsiniz:

DoubleValue
FloatValue
Int64Value
UInt64Value
Int32Value
UInt32Value
BoolValue
StringValue
BytesValue

Dolayısıyla, orijinal soruyu yanıtlamak için böyle bir paketleyicinin kullanımı şöyle olabilir:

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

Şimdi örneğin Java'da şöyle şeyler yapabilirim:

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

Kenton'ın cevabına göre, daha basit ancak çalışan bir çözüm şuna benzer:

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

@Cybersnoopy'nin önerisini burada genişletmek için

böyle bir mesaj içeren bir .proto dosyanız varsa:

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

Sağlanan vaka seçeneklerinden (java tarafından oluşturulan kod) yararlanabilirsiniz :

Şimdi aşağıdaki gibi bir kod yazabiliriz:

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

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

Bununla ilgili güzel bir gönderi var: https://itnext.io/protobuf-and-null-support-1908a15311b6

Çözüm, gerçek kullanım durumunuza bağlıdır:

• Kısmi güncellemeyi işleme

• Boş destek

Diğer bir yol da, her isteğe bağlı alan için bit maskesi kullanabilmenizdir. ve değerler ayarlanmışsa bu bitleri ayarlayın ve değerlerin ayarlanmadığı bitleri sıfırlayın

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;
}

Ayrıştırmada bitMask'ın değerini kontrol edin.

if (bitMask & baz_present)
    baz is present

if (bitMask & baz1_present)
    baz1 is present

referansları varsayılan örnekle karşılaştırarak birinin başlatılıp başlatılmadığını bulabilirsiniz:

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