跳转到主内容
趣航编程网 - 趣学编程,启航技术之路!

python Protobuf定义消息类型

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

在 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;}这里query、page_number等是字段名,数字 1、2、3 是字段编号,用于二进制编码时识别字段。

立即学习“Python免费学习笔记(深入)

”;

Python 3.14.3微软官方的 Python 扩展,是 VS Code 安装量最高的扩展(209M+)。集成 IntelliSense(通过 Pylance)、调试(通过 Python Debugger)、代码检查、格式化、重构和单元测试等功能。支持 Jupyter Notebook、虚拟环境管理和多 Python 版本切换。

下载生成 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之后就能把这个对象序列化成二进制发送,或者从二进制反序列化回来读取数据。基本上就这些,定义清晰,用起来也方便。

相关文章