Cách xác định một trường tùy chọn trong protobuf 3

Tôi cần chỉ định một tin nhắn có trường tùy chọn trong protobuf (cú pháp proto3). Về cú pháp proto 2, thông điệp tôi muốn diễn đạt là:

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

Theo hiểu biết của tôi, khái niệm "tùy chọn" đã bị loại bỏ khỏi cú pháp proto 3 (cùng với khái niệm bắt buộc). Mặc dù không rõ ràng về lựa chọn thay thế - sử dụng giá trị mặc định để nói rằng một trường chưa được chỉ định từ người gửi, để lại sự không rõ ràng nếu giá trị mặc định thuộc về miền giá trị hợp lệ (ví dụ như kiểu boolean).

Vì vậy, tôi phải mã hóa thông báo trên như thế nào? Cảm ơn bạn.

Kể từ bản phát hành protobuf 3.12 , proto3 đã hỗ trợ sử dụng optionaltừ khóa (giống như trong proto2) để cung cấp thông tin hiện diện trường vô hướng.

syntax = "proto3";

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

Phương thức A has_baz()/ hasBaz()được tạo cho optionaltrường trên, giống như trong proto2.

Dưới mui xe, protoc xử lý hiệu quả một optionaltrường như thể nó được khai báo bằng cách sử dụng oneoftrình bao bọc, như câu trả lời của CyberSnoopy gợi ý:

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

Nếu bạn đã sử dụng phương pháp đó, bạn có thể xóa phần khai báo thư của mình (chuyển từ oneofsang optional), vì định dạng dây là giống nhau.

Bạn có thể tìm thấy thông tin chi tiết về sự hiện diện của trường và optionaltrong proto3 trong Ghi chú ứng dụng: Tài liệu về sự hiện diện của trường .

Trong bản phát hành 3.12, chức năng này yêu cầu chuyển --experimental_allow_proto3_optionalcờ tới protoc. Các thông báo tính năng cho biết họ sẽ “thường có sẵn hy vọng trong 3.13”.

Cập nhật tháng 10 năm 2020: Tính năng này vẫn được coi là thử nghiệm (bắt buộc phải gắn cờ) trong bản phát hành 3.13 .

Trong proto3, tất cả các trường là "tùy chọn" (trong đó nó không phải là lỗi nếu người gửi không đặt chúng). Tuy nhiên, các trường không còn là "nullable" nữa, do đó không có cách nào để phân biệt sự khác biệt giữa trường được đặt thành giá trị mặc định rõ ràng so với trường chưa được đặt.

Nếu bạn cần trạng thái "null" (và không có giá trị nằm ngoài phạm vi nào mà bạn có thể sử dụng cho việc này) thì thay vào đó, bạn sẽ cần mã hóa trường này thành một trường riêng biệt. Ví dụ, bạn có thể làm:

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

Ngoài ra, bạn có thể sử dụng oneof:

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

Các oneofphiên bản là rõ ràng hơn và hiệu quả hơn trên dây nhưng đòi hỏi sự hiểu biết như thế nào oneofgiá trị làm việc.

Cuối cùng, một lựa chọn hoàn toàn hợp lý khác là gắn bó với proto2. Proto2 không bị phản đối và trên thực tế, nhiều dự án (bao gồm cả bên trong Google) phụ thuộc rất nhiều vào các tính năng của proto2 đã bị loại bỏ trong proto3, do đó chúng có thể sẽ không bao giờ chuyển đổi. Vì vậy, thật an toàn để tiếp tục sử dụng nó trong tương lai gần.

Một cách là sử dụng oneofnhư gợi ý trong câu trả lời được chấp nhận.

Một cách khác là sử dụng các đối tượng trình bao bọc. Bạn không cần phải tự viết chúng vì google đã cung cấp cho chúng:

Ở đầu tệp .proto của bạn, hãy thêm nhập này:

import "google/protobuf/wrappers.proto";

Giờ đây, bạn có thể sử dụng các trình bao bọc đặc biệt cho mọi kiểu đơn giản:

DoubleValue
FloatValue
Int64Value
UInt64Value
Int32Value
UInt32Value
BoolValue
StringValue
BytesValue

Vì vậy, để trả lời câu hỏi ban đầu, cách sử dụng một trình bao bọc như vậy có thể như sau:

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

Bây giờ, ví dụ trong Java, tôi có thể làm những thứ như:

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

Dựa trên câu trả lời của Kenton, một giải pháp đơn giản nhưng hiệu quả trông giống như sau:

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

Để mở rộng đề xuất của @cybersnoopy tại đây

nếu bạn có tệp .proto với thông báo như vậy:

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

Bạn có thể sử dụng các tùy chọn trường hợp được cung cấp (mã do java tạo) :

Vì vậy, bây giờ chúng ta có thể viết một số mã như sau:

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

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

Có một bài đăng hay về điều này: https://itnext.io/protobuf-and-null-support-1908a15311b6

Giải pháp phụ thuộc vào trường hợp sử dụng thực tế của bạn:

• Xử lý cập nhật một phần

• Hỗ trợ null

Một cách khác là bạn có thể sử dụng mặt nạ bit cho mỗi trường tùy chọn. và đặt các bit đó nếu các giá trị được đặt và đặt lại các bit có giá trị không được đặt

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

Khi phân tích cú pháp, hãy kiểm tra giá trị của bitMask.

if (bitMask & baz_present)
    baz is present

if (bitMask & baz1_present)
    baz1 is present

bạn có thể tìm nếu một cái đã được khởi tạo bằng cách so sánh các tham chiếu với phiên bản mặc định:

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