Énumérations Protocol Buffers : traiter les valeurs numériques inconnues selon le comportement du runtime

Ce que c'est

Protocol Buffers documente le comportement des énumérations ouvertes et fermées et note des différences d'implémentation selon les bibliothèques de langage. Une valeur numérique inconnue peut être conservée comme valeur de champ pour une énumération ouverte, ou traitée via le stockage des champs inconnus pour une énumération fermée. La syntaxe ou l'édition choisie, ainsi que le runtime, relèvent donc de l'analyse de compatibilité. Comportement des énumérations Protocol Buffers

Pourquoi c'est important

Un agent de codage peut générer un switch exhaustif à partir des valeurs nommées actuelles et supposer que les futurs producteurs ne peuvent rien envoyer d'autre. Décider ce qu'un consommateur plus ancien doit faire d'une valeur qu'il ne comprend pas : la rejeter, la conserver lors de la retransmission, ou emprunter une branche conservatrice documentée.

Comment l'appliquer

• Consigner la syntaxe ou l'édition du schéma, l'ouverture de l'énumération et les versions concrètes du runtime de langage utilisées par chaque participant. Lire le comportement propre au runtime plutôt que de supposer que toutes les API générées sont identiques.
• Définir le comportement applicatif pour un nombre inconnu. Garder ce cas distinct d'une valeur par défaut connue ou non spécifiée lorsqu'elles ont des significations différentes.
• Proposer un message issu d'un schéma plus récent contenant une valeur d'énumération nouvellement ajoutée. Le décoder avec le consommateur plus ancien et examiner à la fois l'état visible par l'application et tout traitement de champ inconnu.
• Si le consommateur retransmet les messages, réencoder et redécoder avec l'implémentation plus récente. Vérifier si la valeur et l'ordonnancement pertinent survivent au chemin requis.
• Ajouter des tests explicites pour les champs d'énumération répétés et les transformations via JSON lorsque celles-ci se produisent dans le système réel.

Pièges

Inconnu ne signifie pas autorisé ou valide pour une opération donnée. Préserver la compatibilité sans attribuer silencieusement aux nouvelles valeurs un sens permissif. La documentation protobuf liste des écarts propres à chaque runtime, si bien qu'une explication générique ne peut se substituer à la matrice réelle producteur-consommateur. Cet article propose des vérifications d'interopérabilité et ne revendique aucun résultat multilangage exécuté ni aucune garantie que toutes les données inconnues survivent à chaque transformation.