[GO] Zusammenfassung zum Schreiben von in gRPC verwendeten .proto-Dateien

• In gRPC werden Daten durch Serialisierung im Protokollpufferformat ausgetauscht.
• Sie können das Schema in der Datei ".proto" definieren und den Code mit dem Tool generieren. Wenn diese .proto-Datei von jedem Client und Server gemeinsam genutzt werden kann, ist es daher möglich, die Entwicklung ohne Abweichungen in den Spezifikationen fortzusetzen.
• In diesem Artikel werde ich die Syntax von .proto-Dateien kurz zusammenfassen.

Ganze Probe

• GitHub

//Versionsdefinition
syntax = "proto3";

//Paketdefinition
package sample;

// import
import "google/protobuf/timestamp.proto";
import "google/protobuf/duration.proto";

//Service- und RPC-Methodendefinition
service SampleService {
    rpc Sample (SampleRequest) returns (SampleResponse);

    //Server-Streaming-RPC
    rpc SampleServerStreamMethod (SampleRequest) returns (stream SampleResponse);

    //Client-Streaming-RPC
    rpc SampleClientStreamMethod (stream SampleRequest) returns (SampleResponse)

    //Bidirektionales Streaming von RPC
    rpc SampleBidirectionalMethod (stream SampleRequest) returns (stream SampleResponse)
}

message SampleRequest {
    string name = 1;
}

message SampleResponse {
    Sample sample = 1;
}


//Nachrichtentyp
//Die Nummer rechts ist die "Tag-Nummer"
message Sample {
    //Skalartyp
    //Es gibt Zahlen, Zeichenfolgen, Boolesche Werte und Byte-Arrays
    int32 id = 1;
    string name = 2;
    bool isBool = 3;

    //veraltet Geben Sie Felder an, die veraltet und veraltet sind
    string duplicated_field = 4 [deprecated = true]

    //reservierte Kennung Nicht mehr verfügbare Tag-Nummer
    reserved 7, 8, 10 to 12;

    //Liste (Array)
    //Mehrdimensionales Array kann nicht definiert werden
    repeated SampleList sample_list = 5;

    //Karte (assoziatives Array)
    map<string, string> sample_map = 6;

    //Jeder aus mehreren
    oneof message {
        string one = 1;
        string other = 2;
    }

    // Well Known Types
    google.protobuf.Duration sample_duration = 9;
    google.protobuf.Timestamp create_time = 13;

    //Aufzählungstyp
    enum SampleEnum {
        UNKNOWN = 0;
        TEST1 = 1;
        TEST2 = 2;
        TEST3 = 3;
    }

}

Versionsdefinition

syntax = "proto3";

Paketdefinition

• Sie können den Paketnamen festlegen, um Namenskonflikte zu vermeiden, z. B. wenn Sie Nachrichten verwenden, die in anderen .proto-Dateien definiert sind.

package sample;

import

• Verwenden Sie diese Option, wenn Sie den in einer anderen .proto-Datei definierten Nachrichtentyp verwenden möchten
• Hier importieren wir eine von Google erstellte .proto-Datei.

import "google/protobuf/timestamp.proto";
import "google/protobuf/duration.proto";

Dienste und RPC-Methoden

--API-Definitionskörper

• Definieren Sie einen Dienst namens SampleService
• Definiert eine Methode namens Sample, die SampleRequest als Argument verwendet und SampleResponse zurückgibt.
• Wenn Sie streamen möchten, fügen Sie dem Argument Stream hinzu und geben Sie den Wert zurück.
• One-Way-Streaming
• Server-Streaming-RPC (Stream als Rückgabewert festlegen)
• Die Serverseite gibt mehrere Antworten asynchron zurück --Client Streaming RPC (Stream als Argument festlegen)
• Senden Sie mehrere Anforderungen asynchron von der Clientseite und geben Sie eine Antwort auf der Serverseite zurück
• Bidirektionales Streaming
• Fügen Sie dem Argument und dem Rückgabewert einen Stream hinzu

service SampleService {
    rpc Sample (SampleRequest) returns (SampleResponse);

    //Server-Streaming-RPC
    rpc SampleServerStreamMethod (SampleRequest) returns (stream SampleResponse);

    //Client-Streaming-RPC
    rpc SampleClientStreamMethod (stream SampleRequest) returns (SampleResponse);

    //Bidirektionales Streaming von RPC
    rpc SampleBidirectionalMethod (stream SampleRequest) returns (stream SampleResponse);
}

Skalartyp

--Numerischer Wert, Zeichenfolge, Boolescher Wert, Byte-Array sind Datentypen

• Details zu Datentypen und Korrespondenz von Datentypen nach dem Kompilieren in jede Sprache
• Standardwert

Nachrichtentyp

--Typ mit mehreren Feldern --Tag Nummer

• Die Nummer rechts vom Feld.
• Muss innerhalb derselben Nachricht eindeutig sein --reservierte Kennung
• Geben Sie die Tag-Nummer ein, die aufgrund des Löschens von Feldern usw. eingestellt wurde.
• veraltete Option
• Geben Sie veraltete und veraltete Felder an

message Sample {
    //Skalartyp
    //Es gibt Zahlen, Zeichenfolgen, Boolesche Werte und Byte-Arrays
    int32 id = 1;
    string name = 2;
    bool isBool = 3;

    //veraltet Geben Sie Felder an, die veraltet und veraltet sind
    string duplicated_field = 4 [deprecated = true]

    //reservierte Kennung Nicht mehr verfügbare Tag-Nummer
    reserved 7, 8, 10 to 12;

　　//~ Ausgelassen ~
}

Liste (Array)

• Ein Array kann definiert werden, indem dem Typ wiederholt vorangestellt wird
• Kann sowohl für den Skalartyp als auch für den Nachrichtentyp verwendet werden
• Mehrdimensionales Array kann nicht definiert werden

    //Liste (Array)
    //Mehrdimensionales Array kann nicht definiert werden
    repeated SampleList sample_list = 5;

Karte (assoziatives Array)

• Für Schlüssel können nur ganzzahlige Werte, Zeichenfolgen und boolesche Werte verwendet werden. --map kann kein Array sein

    map<string, string> sample_map = 6;

Aufzählungstyp

• Der Aufzählungstyp kann definiert werden, indem dem Typ eine Aufzählung vorangestellt wird

    //Aufzählungstyp
    enum SampleEnum {
        UNKNOWN = 0;
        TEST1 = 1;
        TEST2 = 2;
        TEST3 = 3;
    }

oneof

• Durch Hinzufügen eines davon können Sie eines aus mehreren Dingen definieren.
• Hier ist es ein Nachrichtentyp, der "das eine" oder "das andere" zurückgibt

    oneof message {
        string one = 1;
        string other = 2;
    }

Well Known Types

• Von Google definierter Nachrichtentyp
• Es gibt Dinge wie Datum und Uhrzeit, den Zeitraum und die Tatsache, dass kein Rückgabewert zurückgegeben wird.

    google.protobuf.Duration sample_duration = 9;
    google.protobuf.Timestamp create_time = 13;

Codegenerierung

• Generieren Sie auf der Grundlage der oben definierten .proto-Datei mit dem Befehl protoc für jede Sprache auf beiden Seiten des Client-Servers einen Kesselplattencode.

Referenz

• gRPC wird gestartet
• Protocol Buffers：Language Guide (proto3)