登录
首页 >  文章 >  python教程

Protobuf消息类型定义全解析

时间:2025-12-01 15:30:29 168浏览 收藏

哈喽!今天心血来潮给大家带来了《Python中Protobuf消息类型定义详解》,想必大家应该对文章都不陌生吧,那么阅读本文就都不会很困难,以下内容主要涉及到,若是你正在学习文章,千万别错过这篇文章~希望能帮助到你!

编写 .proto 文件定义消息结构,如 search.proto 中声明 proto3 语法并用 message 定义字段;2. 使用 protoc 编译器执行 protoc --python_out=. search.proto 生成 search_pb2.py;3. 在 Python 中导入生成的模块,创建实例并设置字段值,实现序列化与反序列化。

python Protobuf定义消息类型

在 Python 中使用 Protobuf 定义消息类型,核心是先写 .proto 文件,再生成对应的 Python 类。整个过程不复杂,但需要清楚每一步的作用。

编写 .proto 文件定义结构

你需要创建一个以 .proto 为后缀的文件,比如 search.proto,在里面用 Protobuf 语法描述数据结构。

文件开头要声明使用 proto3 语法,然后用 message 关键字定义一个或多个数据类型。每个字段包含类型、名称和唯一的编号。

  • 例如,定义一个搜索请求可以这样写:
syntax = "proto3";
message SearchRequest {
string query = 1;
int32 page_number = 2;
int32 result_per_page = 3;
}

这里 querypage_number 等是字段名,数字 1、2、3 是字段编号,用于二进制编码时识别字段。

生成 Python 可用的类

写好 .proto 文件后,需要用 Protobuf 编译器 protoc 把它转成 Python 能导入的模块。

  • 确保已安装 protoc 工具
  • 执行命令:protoc --python_out=. search.proto

命令执行后会在当前目录生成一个 search_pb2.py 文件。这个文件里包含了由 Protobuf 自动生成的 Python 类,比如 SearchRequest 类。

在 Python 代码中使用消息类型

生成 Python 文件后,就可以在项目中像普通类一样使用它了。

  • 先导入生成的模块:import search_pb2
  • 创建消息实例:request = search_pb2.SearchRequest()
  • 设置字段值:request.query = "关键词"request.page_number = 1

之后就能把这个对象序列化成二进制发送,或者从二进制反序列化回来读取数据。基本上就这些,定义清晰,用起来也方便。

今天带大家了解了的相关知识,希望对你有所帮助;关于文章的技术知识我们会一点点深入介绍,欢迎大家关注golang学习网公众号,一起学习编程~

相关阅读
更多>
最新阅读
更多>
课程推荐
更多>