Comment définir un champ optionnel dans protobuf 3

Question

J'ai besoin de spécifier un message avec un champ optionnel dans protobuf (syntaxe proto3). En termes de syntaxe proto 2, le message que je veux exprimer est quelque chose comme :

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

D'après ce que j'ai compris, le concept "optionnel" a été supprimé de la syntaxe proto 3 (avec le concept obligatoire). Bien que l'alternative ne soit pas claire - utiliser la valeur par défaut pour indiquer qu'un champ n'a pas été spécifié par l'expéditeur, laisse une ambiguïté si la valeur par défaut appartient au domaine des valeurs valides (considérez par exemple un type booléen).

Alors, comment suis-je censé coder le message ci-dessus ? Merci.

Answer 1

Dans proto3, tous les champs sont "facultatifs" (en ce sens que l'expéditeur ne commet pas d'erreur s'il ne les définit pas). Mais les champs ne sont plus "nullables", en ce sens qu'il n'y a aucun moyen de faire la différence entre un champ explicitement défini à sa valeur par défaut et un champ qui n'a pas été défini du tout.

Si vous avez besoin d'un état "nul" (et qu'il n'y a pas de valeur hors gamme que vous pouvez utiliser pour cela), vous devrez l'encoder dans un champ distinct. Par exemple, vous pourriez le faire :

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

Alternativement, vous pouvez utiliser oneof :

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

El oneof est plus explicite et plus efficace sur le fil mais nécessite de comprendre comment oneof le travail sur les valeurs.

Enfin, une autre option parfaitement raisonnable consiste à s'en tenir à proto2. Proto2 n'est pas déprécié, et en fait, de nombreux projets (y compris au sein de Google) dépendent beaucoup des fonctionnalités de proto2 qui sont supprimées dans proto3, donc ils ne changeront probablement jamais. Il est donc prudent de continuer à l'utiliser dans un avenir prévisible.

Answer 2

L'un des moyens est de optional comme décrit dans la réponse acceptée : https://stackoverflow.com/a/62566052/1803821

Une autre solution consiste à utiliser des objets enveloppants. Vous n'avez pas besoin de les écrire vous-même puisque Google les fournit déjà :

En haut de votre fichier .proto, ajoutez cette importation :

import "google/protobuf/wrappers.proto";

Vous pouvez maintenant utiliser des enveloppes spéciales pour chaque type simple :

DoubleValue
FloatValue
Int64Value
UInt64Value
Int32Value
UInt32Value
BoolValue
StringValue
BytesValue

Ainsi, pour répondre à la question initiale, l'utilisation d'un tel wrapper pourrait être la suivante :

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

Maintenant, par exemple, en Java, je peux faire des choses comme :

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

Answer 3

Sur la base de la réponse de Kenton, une solution plus simple mais qui fonctionne ressemble à ceci :

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

Answer 4

Pour développer la suggestion de @cybersnoopy aquí

si vous aviez un fichier .proto avec un message comme celui-ci :

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

Vous pouvez utiliser les options de l'affaire fourni (code généré en java) :

Nous pouvons donc maintenant écrire du code comme suit :

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

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

Answer 5

Vous pouvez savoir si l'un d'eux a été initialisé en comparant les références avec l'instance par défaut :

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