如何在protobuf 3中定义可选字段

我需要在protobuf（proto3语法）中指定一个带有可选字段的消息。用proto 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;
}

就像在proto2中一样，为上面的字段生成一个has_baz()/hasBaz()方法optional。

像Cyber​​Snoopy的回答所示，在底层，protoc有效地将optional字段视为使用oneof包装器声明的字段：

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

如果您已经使用了这种方法，则proto3支持从实验状态毕业后，您就可以清理您的消息声明（从切换oneof到optional）optional，因为有线格式是相同的。

您可以optional在应用笔记：现场状态文档中找到有关现场状态的详细信息，并在proto3中找到。

将--experimental_allow_proto3_optional标记传递给协议以使用版本3.12中的此功能。该功能公告称它将“通常有望在3.13中可用”。

2020年11月更新：该功能在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内部）都非常依赖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()) { ... }

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

您可以使用提供的case选项（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

解决方案取决于您的实际用例：

• 处理部分更新

• 支持空

编码您想要的消息的另一种方法是添加另一个字段来跟踪“设置”字段：

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