[GO] Résumé de l'écriture des fichiers .proto utilisés dans gRPC

--Dans gRPC, les données sont échangées par sérialisation au format Protocol Buffers.

• Vous pouvez définir le schéma dans le fichier .proto et générer le code à l'aide de l'outil. Par conséquent, si ce fichier .proto peut être partagé par chaque client et serveur, il est possible de procéder au développement sans aucune divergence de spécifications.
• Dans cet article, je résumerai brièvement la syntaxe des fichiers .proto.

Échantillon entier

• GitHub

//Définition de version
syntax = "proto3";

//Définition du package
package sample;

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

//Définition du service et de la méthode RPC
service SampleService {
    rpc Sample (SampleRequest) returns (SampleResponse);

    //Serveur de streaming RPC
    rpc SampleServerStreamMethod (SampleRequest) returns (stream SampleResponse);

    //Client streaming RPC
    rpc SampleClientStreamMethod (stream SampleRequest) returns (SampleResponse)

    //RPC de streaming bidirectionnel
    rpc SampleBidirectionalMethod (stream SampleRequest) returns (stream SampleResponse)
}

message SampleRequest {
    string name = 1;
}

message SampleResponse {
    Sample sample = 1;
}


//Type de message
//Le numéro à droite est le "numéro de tag"
message Sample {
    //Type scalaire
    //Il y a des nombres, des chaînes, des booléens, des tableaux d'octets
    int32 id = 1;
    string name = 2;
    bool isBool = 3;

    //obsolète Spécifiez les champs obsolètes et obsolètes
    string duplicated_field = 4 [deprecated = true]

    //identifiant réservé Numéro d'étiquette abandonnée
    reserved 7, 8, 10 to 12;

    //Liste (tableau)
    //Le tableau multidimensionnel ne peut pas être défini
    repeated SampleList sample_list = 5;

    //Carte (tableau associatif)
    map<string, string> sample_map = 6;

    //N'importe lequel de plusieurs
    oneof message {
        string one = 1;
        string other = 2;
    }

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

    //Type d'énumération
    enum SampleEnum {
        UNKNOWN = 0;
        TEST1 = 1;
        TEST2 = 2;
        TEST3 = 3;
    }

}

Définition de version

syntax = "proto3";

Définition du package

• Vous pouvez définir le nom du package pour éviter les conflits de nom, comme lors de l'utilisation de messages définis dans d'autres fichiers .proto.

package sample;

import

• À utiliser lorsque vous souhaitez utiliser le type de message défini dans un autre fichier .proto
• Ici, nous importons un fichier .proto créé par Google.

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

Services et méthodes RPC

• Corps de définition de l'API --Définissez un service appelé SampleService --Définit une méthode appelée Sample qui prend SampleRequest comme argument et renvoie SampleResponse.
• Si vous souhaitez diffuser, ajoutez un flux à l'argument et renvoyez la valeur.
• Streaming unidirectionnel --Server streaming RPC (définir le flux comme valeur de retour) --Le côté serveur renvoie plusieurs réponses de manière asynchrone --Client Streaming RPC (définir le flux comme argument) --Envoyez plusieurs demandes de manière asynchrone du côté client et renvoyez une réponse du côté serveur
• Streaming bidirectionnel
• Ajouter un flux à la fois à l'argument et à la valeur de retour

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

    //Serveur streaming RPC
    rpc SampleServerStreamMethod (SampleRequest) returns (stream SampleResponse);

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

    //RPC de streaming bidirectionnel
    rpc SampleBidirectionalMethod (stream SampleRequest) returns (stream SampleResponse);
}

Type scalaire

• La valeur numérique, la chaîne de caractères, la valeur booléenne, le tableau d'octets sont des types de données
• Détails des types de données et correspondance des types de données après avoir été compilés dans chaque langue
• Valeur par défaut

Type de message

--Type avec plusieurs champs --Numéro d'étiquette

• Le numéro à droite du champ.
• Doit être unique dans le même message
• identifiant réservé
• Entrez le numéro de tag qui a été interrompu en raison de la suppression du champ, etc.
• option obsolète --Spécifier les champs obsolètes et obsolètes

message Sample {
    //Type scalaire
    //Il y a des nombres, des chaînes, des booléens, des tableaux d'octets
    int32 id = 1;
    string name = 2;
    bool isBool = 3;

    //obsolète Spécifiez les champs qui sont obsolètes et obsolètes
    string duplicated_field = 4 [deprecated = true]

    //identifiant réservé Numéro d'étiquette abandonnée
    reserved 7, 8, 10 to 12;

　　//~ Omis ~
}

Liste (tableau)

--Un tableau peut être défini en préfixant le type avec --Peut être utilisé pour le type scalaire et le type de message

• Le tableau multidimensionnel ne peut pas être défini

    //Liste (tableau)
    //Le tableau multidimensionnel ne peut pas être défini
    repeated SampleList sample_list = 5;

Carte (tableau associatif)

• Seules les valeurs entières, les chaînes de caractères et les valeurs booléennes peuvent être utilisées pour les clés. --map ne peut pas être un tableau

    map<string, string> sample_map = 6;

Type d'énumération

• Le type d'énumération peut être défini en préfixant le type avec enum

    //Type d'énumération
    enum SampleEnum {
        UNKNOWN = 0;
        TEST1 = 1;
        TEST2 = 2;
        TEST3 = 3;
    }

oneof

• En ajoutant oneof, vous pouvez en définir un parmi plusieurs choses.
• Ici, c'est un type de message qui renvoie ʻun ou ʻautre

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

Well Known Types --Type de message défini par Google

• Il y a des éléments tels que la date et l'heure, la période et le fait qu'aucune valeur de retour n'est renvoyée.

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

Génération de code

• Basé sur le fichier .proto défini ci-dessus, générez le code de la plaque chauffante en utilisant la commande protoc pour chaque langue des deux côtés du serveur client.

référence

• Démarrage de gRPC
• Protocol Buffers：Language Guide (proto3)