gRPC & High Performance APIs · Leçon

Définir un schéma Protobuf

Apprenez à définir des messages et des services à l’aide de la syntaxe Protocol Buffers (Protobuf) pour bénéficier d’un typage fort.

Définir un schéma Protobuf est une leçon gRPC & High Performance APIs gratuite sur CoddyKit. Ceci est la leçon 1 sur 4. Tu peux lire la leçon complète ci-dessous gratuitement — puis la pratiquer en direct dans le navigateur avec un éditeur de code intégré et un tuteur IA 24/7. Elle fait partie du parcours d'apprentissage gRPC & High Performance APIs, et ta progression se synchronise sur le web et l'application CoddyKit. Le cours gRPC & High Performance APIs comprend 4 leçons au total.

Certaines parties de cette leçon n'ont pas encore été traduites et s'affichent en anglais.

What are Protocol Buffers?

Welcome! In this lesson, we'll dive into Protocol Buffers, often called Protobuf. It's a key technology for gRPC.

Protobuf is a language-neutral, platform-neutral, extensible mechanism for serializing structured data. Think of it as a highly efficient way to define and exchange data.
It's like JSON or XML, but smaller, faster, and simpler.
gRPC uses Protobuf to define the service interface and the structure of the payload messages.

The .proto File

Protobuf schemas are defined in special files ending with the .proto extension. These files act as contracts for your data.

Every .proto file starts with a syntax declaration, usually syntax = "proto3";. This tells the Protobuf compiler which version of the syntax to use.
It's crucial for forward and backward compatibility.

syntax = "proto3";

// Your Protobuf definitions go here

Defining Your First Message

In Protobuf, a message is a structured record of information. It's similar to a class in object-oriented programming or a struct in C.

You define a message using the message keyword, followed by its name and a body containing its fields.

syntax = "proto3";

message MyMessage {
  // fields will go here
}

Fields, Types & Numbers

Inside a message, you define fields, each with a specific data type and a unique field number.

Data Type: Specifies the type of data (e.g., string, int32, bool).
Field Name: A unique identifier for the field within the message.
Field Number: A unique, positive integer tag (from 1 to 2²⁹-1). These numbers are critical for identifying fields in the binary format and must remain stable for compatibility.

Common Scalar Data Types

Protobuf supports a range of scalar data types. Here are some of the most common ones:

int32, int64: Integer numbers.
float, double: Floating-point numbers.
bool: Boolean (true/false).
string: UTF-8 encoded text.
bytes: Raw byte sequences.

Choose the type that best fits your data to optimize storage and transmission.

Example: A Simple Person Message

Let's define a Person message with a few common fields. Notice the unique field numbers assigned to each field.

These numbers are like unique IDs for your data pieces. If you change a field's name, its number must stay the same for older systems to understand it.

syntax = "proto3";

message Person {
  string name = 1;
  int32 age = 2;
  bool is_active = 3;
}

Using Enums for Fixed Choices

Sometimes you need a field to have a value from a predefined list of options. This is where enums come in handy.

Enums define a set of named integer constants.
The first value in an enum must be 0, as it's the default value when a field isn't set.

syntax = "proto3";

enum UserRole {
  GUEST = 0;
  MEMBER = 1;
  ADMIN = 2;
}

Example: User Message with Role

Now, let's create a User message and include our UserRole enum as a field. This ensures that the user's role can only be one of the defined values.

It provides strong typing and prevents invalid data from being sent.

syntax = "proto3";

enum UserRole {
  GUEST = 0;
  MEMBER = 1;
  ADMIN = 2;
}

message User {
  string id = 1;
  string username = 2;
  UserRole role = 3;
}

Nesting Messages for Structure

For more complex data, you can nest messages within other messages. This helps organize your schema and represent hierarchical data naturally.

Think of it like having an object inside another object in programming languages.

syntax = "proto3";

message UserProfile {
  string email = 1;
  message Address {
    string street = 1;
    string city = 2;
    string zip_code = 3;
  }
  Address home_address = 2;
}

Quick Check: Protobuf Basics

Consider the following Protobuf message definition:

syntax = "proto3";

message Product {
  string name = 1;
  int32 price_cents = 2;
  bool in_stock = 3;
  enum ProductCategory {
    ELECTRONICS = 0;
    BOOKS = 1;
    CLOTHING = 2;
  }
  ProductCategory category = 4;
}

Recap: Protobuf Schema

Great job! You've learned the fundamentals of defining Protobuf schemas:

.proto Files: The contract for your data.
Messages: Structured data definitions, similar to classes.
Fields: Each has a type, name, and unique field number.
Scalar Types: Common types like string, int32, bool.
Enums: For predefined sets of values, starting with 0.
Nesting: Organizing complex data by embedding messages.

Next, we'll see how to turn these definitions into code!

Questions Fréquemment Posées

La leçon « Définir un schéma Protobuf » est-elle gratuite ?

Oui — le texte complet de « Définir un schéma Protobuf » est gratuit à lire ici sur le web. Pour la pratiquer de manière interactive (un éditeur de code intégré et un tuteur IA 24/7) et déverrouiller le reste du cours gRPC & High Performance APIs, passe à CoddyKit PRO. Le cours gRPC & High Performance APIs comprend 4 leçons au total.

Qu'est-ce que j'apprendrai dans « Définir un schéma Protobuf » ?

Apprenez à définir des messages et des services à l’aide de la syntaxe Protocol Buffers (Protobuf) pour bénéficier d’un typage fort. Tu pratiques gRPC & High Performance APIs avec du code pratique que tu exécutes directement dans le navigateur, et un tuteur IA 24/7 répond à tes questions au fur et à mesure que tu avances dans la leçon.

Dois-je avoir de l'expérience pour commencer gRPC & High Performance APIs ?

Aucune expérience préalable n'est requise. gRPC & High Performance APIs sur CoddyKit est structuré pour les débutants jusqu'aux apprenants avancés, donc tu peux commencer ici ou depuis le début et avancer à ton rythme. Ceci est la leçon 1 sur 4.

Combien de temps prend la leçon « Définir un schéma Protobuf » ?

La plupart des leçons CoddyKit prennent environ 5–10 minutes. Chacune est courte et interactive, tu progresses régulièrement et tu repiques exactement où tu t'es arrêté sur le web et l'app.

Peux-tu écrire et exécuter du code dans cette leçon gRPC & High Performance APIs ?

Oui. Chaque leçon gRPC & High Performance APIs inclut un éditeur de code intégré, tu écris et exécutes du vrai code directement dans ton navigateur et tu reçois des retours IA instantanés — aucune configuration locale requise.

Toutes les leçons de ce cours

Définir un schéma Protobuf
Générer du code gRPC
Service gRPC unaire simple
RPC en flux : serveur, client et bidirectionnel

← Retour à gRPC & High Performance APIs