วิธีกำหนดฟิลด์ทางเลือกใน protobuf 3

ฉันต้องการระบุข้อความด้วยฟิลด์ทางเลือกใน protobuf (ไวยากรณ์ของ proto3) ในแง่ของไวยากรณ์ของโปรโต 2 ข้อความที่ฉันต้องการแสดงออกมีดังนี้:

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

จากความเข้าใจของฉันแนวคิด "ทางเลือก" ถูกลบออกจากไวยากรณ์โปรโต 3 (พร้อมกับแนวคิดที่จำเป็น) แม้ว่าจะไม่ชัดเจนทางเลือกอื่น - การใช้ค่าเริ่มต้นเพื่อระบุว่าเขตข้อมูลไม่ได้ถูกระบุจากผู้ส่ง แต่จะทำให้เกิดความไม่ชัดเจนหากค่าเริ่มต้นเป็นของโดเมนค่าที่ถูกต้อง (พิจารณาตัวอย่างเช่นประเภทบูลีน)

ฉันจะเข้ารหัสข้อความด้านบนได้อย่างไร? ขอขอบคุณ.

ตั้งแต่ protobuf รีลีส 3.12เป็นต้นมา proto3 มีการสนับสนุนการทดลองสำหรับการใช้optionalคีย์เวิร์ด (เช่นเดียวกับในโปรโต 2) เพื่อให้ข้อมูลสถานะฟิลด์สเกลาร์

syntax = "proto3";

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

A has_baz()/ hasBaz()method ถูกสร้างขึ้นสำหรับoptionalฟิลด์ด้านบนเช่นเดียวกับใน proto2

ภายใต้ฝากระโปรง Protoc จะปฏิบัติต่อoptionalสนามอย่างมีประสิทธิภาพราวกับว่ามีการประกาศโดยใช้oneofกระดาษห่อหุ้มตามที่คำตอบของ CyberSnoopyแนะนำ:

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

หากคุณเคยใช้แนวทางดังกล่าวแล้วคุณจะสามารถล้างการประกาศข้อความของคุณ (เปลี่ยนจากoneofเป็นoptional) ได้เมื่อ proto3 optionalสนับสนุนผู้สำเร็จการศึกษาจากสถานะการทดลองเนื่องจากรูปแบบลวดจะเหมือนกัน

คุณสามารถดูรายละเอียดที่สำคัญเกี่ยวกับการมีอยู่ของฟิลด์และoptionalใน proto3 ได้ในบันทึกการใช้งาน:เอกสารการแสดงตนของฟิลด์

ส่ง--experimental_allow_proto3_optionalแฟล็กไปยัง protoc เพื่อใช้ฟังก์ชันนี้ในรีลีส 3.12 ประกาศคุณลักษณะบอกว่ามันจะเป็น“ใช้ได้โดยทั่วไปหวังว่าใน 3.13”

พฤศจิกายน 2020 ปรับปรุง: คุณลักษณะนี้ถือว่ายังคงทดลอง (ธงจำเป็น) ในการเปิดตัว 3.14 มีสัญญาณของความคืบหน้ากำลังทำ

ใน proto3 ช่องทั้งหมดเป็น "ทางเลือก" (ซึ่งจะไม่ใช่ข้อผิดพลาดหากผู้ส่งตั้งค่าไม่สำเร็จ) แต่ช่องนั้นไม่ "เป็นโมฆะ" อีกต่อไปเนื่องจากไม่มีวิธีใดที่จะบอกความแตกต่างระหว่างฟิลด์ที่ตั้งค่าเป็นค่าเริ่มต้นอย่างชัดเจนกับไม่ได้ตั้งค่าเลย

หากคุณต้องการสถานะ "ว่าง" (และไม่มีค่านอกช่วงที่คุณสามารถใช้สำหรับสิ่งนี้ได้) คุณจะต้องเข้ารหัสเป็นฟิลด์แยกแทน ตัวอย่างเช่นคุณสามารถทำได้:

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ค่าการทำงาน

ในที่สุดอีกทางเลือกหนึ่งที่เหมาะสมอย่างยิ่งคือติดกับ proto2 Proto2 ไม่ได้เลิกใช้งานและในความเป็นจริงหลายโครงการ (รวมถึงใน Google) ขึ้นอยู่กับคุณสมบัติของโปรโต 2 ซึ่งถูกลบออกใน proto3 ดังนั้นจึงไม่มีทางเปลี่ยน ดังนั้นจึงปลอดภัยที่จะใช้ต่อไปในอนาคตอันใกล้

วิธีหนึ่งคือoptionalชอบที่อธิบายไว้ในคำตอบที่ยอมรับ: https://stackoverflow.com/a/62566052/1803821

อีกวิธีหนึ่งคือการใช้วัตถุห่อหุ้ม คุณไม่จำเป็นต้องเขียนเองเนื่องจาก Google มีให้แล้ว:

ที่ด้านบนของไฟล์. proto ของคุณให้เพิ่มการนำเข้านี้:

import "google/protobuf/wrappers.proto";

ตอนนี้คุณสามารถใช้กระดาษห่อพิเศษสำหรับทุกประเภทง่ายๆ:

DoubleValue
FloatValue
Int64Value
UInt64Value
Int32Value
UInt32Value
BoolValue
StringValue
BytesValue

ดังนั้นเพื่อตอบคำถามเดิมการใช้ Wrapper อาจเป็นดังนี้:

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

ตัวอย่างเช่นใน Java ฉันสามารถทำสิ่งต่างๆเช่น:

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

จากคำตอบของ Kenton โซลูชันที่เรียบง่าย แต่ใช้งานได้มีลักษณะดังนี้:

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

อีกวิธีหนึ่งในการเข้ารหัสข้อความที่คุณต้องการคือการเพิ่มฟิลด์อื่นเพื่อติดตามฟิลด์ "set":

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)

อีกวิธีหนึ่งคือคุณสามารถใช้ bitmask สำหรับแต่ละฟิลด์ที่เลือกได้ และตั้งค่าบิตเหล่านั้นหากมีการตั้งค่าและรีเซ็ตบิตที่ไม่ได้ตั้งค่า

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