Protobuf 模式定义
学习如何使用 Protocol Buffers(Protobuf)语法定义消息和服务,以实现强类型约束
Protobuf 模式定义 是 CoddyKit 上的免费 gRPC & High Performance APIs 课时。 这是第 1 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 gRPC & High Performance APIs 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 gRPC & High Performance APIs 课程共包含 4 节课。
本课时的部分内容尚未翻译,以英文显示。
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
.protofile starts with a syntax declaration, usuallysyntax = "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 hereDefining 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 229-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:
.protoFiles: 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!
用 AI 导师学习 gRPC & High Performance APIs — 免费
在浏览器中编写并运行真实代码,获得全天候 AI 导师的即时帮助,并在网页或应用中继续学习。
- 课程
- 12
- 课程
- 48
常见问题解答
「Protobuf 模式定义」课时是免费的吗?
是的 — 「Protobuf 模式定义」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 gRPC & High Performance APIs 课程的其余内容,请升级到 CoddyKit PRO。 gRPC & High Performance APIs 课程共包含 4 节课。
「Protobuf 模式定义」这节课中我会学到什么?
学习如何使用 Protocol Buffers(Protobuf)语法定义消息和服务,以实现强类型约束 你通过在浏览器中直接运行的动手代码来练习 gRPC & High Performance APIs,全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 gRPC & High Performance APIs 需要有经验吗?
无需任何先前经验。CoddyKit 上的 gRPC & High Performance APIs 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 1 节课,共 4 节。
「Protobuf 模式定义」课时需要多长时间?
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。
我能在这节 gRPC & High Performance APIs 课中编写并运行代码吗?
能。每节 gRPC & High Performance APIs 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。
此课程中的所有课时
- Protobuf 模式定义
- 生成 gRPC 代码
- 简单的一元 gRPC 服务
- 流式 RPC:服务器、客户端与双向流