Wie kann ich JSON-Feldnamen für Protobuf-Erweiterungen anpassen?

Anpassen von JSON-Feldnamen für Protobuf-Erweiterungen

Protobuf-Erweiterungen verwenden bei der Serialisierung in JSON standardmäßig Feldnamen, die eckige Klammern und ein Präfix enthalten Gibt die übergeordnete Nachricht der Erweiterung an. Dies kann unpraktisch sein, wenn Sie einen prägnanteren oder semantisch aussagekräftigeren JSON-Feldnamen bevorzugen.

Hintergrund

Das jsonpb-Paket von Protobuf generiert JSON aus Protobuf-Nachrichten. Die JSON-Feldnamen werden hauptsächlich von den Nachrichtenfeldnamen abgeleitet. Für Erweiterungen wird jedoch ein spezielles Format verwendet: „[message.extension_message_name]“. Dies soll Feldnamenkonflikte verhindern, wenn mehrere Erweiterungen auf eine Nachricht angewendet werden.

Lösung: Verwenden Sie die json_name-Feldoption

Das Protobuf-Sprachhandbuch bietet eine Problemumgehung für Anpassen von JSON-Feldnamen für Erweiterungen: die Feldoption json_name. Indem Sie das Erweiterungsfeld mit dieser Option annotieren, können Sie den gewünschten JSON-Feldnamen angeben.

Zum Beispiel:

message TestMessage {
    extensions 1 to 10;
    extend TestMessage {
        optional string my_extension_field = 1 [json_name="my_custom_field_name"];
    }
}

In diesem Beispiel wird das Erweiterungsfeld my_extension_field in JSON serialisiert als my_custom_field_name.

Vorteile der Verwendung json_name

• Kontrolle über JSON-Feldnamen: Vermeidet die ausführliche Namenskonvention, die für Erweiterungen verwendet wird.
• Konsistenz mit anderen JSON-Feldnamen: Richtet die Namen der Erweiterungsfelder an den Namenskonventionen aus, die für reguläre Nachrichten verwendet werden Felder.
• Verbesserte Lesbarkeit und Wartbarkeit: Macht die JSON-Ausgabe für Menschen lesbarer und einfacher zu bearbeiten.

Das obige ist der detaillierte Inhalt vonWie kann ich JSON-Feldnamen für Protobuf-Erweiterungen anpassen?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!