Protocol Buffers 使用教程

最新推荐文章于 2025-04-21 10:34:18 发布

薛锨宾

最新推荐文章于 2025-04-21 10:34:18 发布

阅读量1.1k

点赞数 22

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00960/article/details/142837977

Protocol Buffers 使用教程

protobuf 协议缓冲区 - 谷歌的数据交换格式。项目地址: https://gitcode.com/gh_mirrors/pr/protobuf

1. 项目介绍

Protocol Buffers（简称 protobuf）是 Google 开发的一种语言中立、平台中立、可扩展的序列化结构化数据的机制。它允许你定义数据的结构，然后使用生成的代码来轻松地从各种数据流中读写你的结构化数据。

主要特点

语言中立：支持多种编程语言，包括 C++, Java, Python, Go 等。
平台中立：可以在不同的操作系统和硬件平台上运行。
高效：序列化和反序列化速度快，生成的数据体积小。
可扩展：可以在不破坏向后兼容性的情况下扩展数据结构。

2. 项目快速启动

安装 Protocol Buffers 编译器

首先，你需要安装 Protocol Buffers 编译器 protoc。你可以从 GitHub 的 release 页面下载预编译的二进制文件。

# 下载并解压 protoc 编译器
wget https://github.com/protocolbuffers/protobuf/releases/download/v3.19.4/protoc-3.19.4-linux-x86_64.zip
unzip protoc-3.19.4-linux-x86_64.zip -d protoc

# 将 protoc 添加到系统路径
export PATH=$PATH:$(pwd)/protoc/bin

定义 `.proto` 文件

创建一个名为 example.proto 的文件，定义你的数据结构：

syntax = "proto3";

message Person {
  string name = 1;
  int32 id = 2;
  string email = 3;
}

生成代码

使用 protoc 编译器生成代码：

protoc --python_out=. example.proto

这将生成一个 example_pb2.py 文件，其中包含序列化和反序列化 Person 消息的代码。

使用生成的代码

在 Python 中使用生成的代码：

import example_pb2

# 创建一个 Person 实例
person = example_pb2.Person()
person.name = "Alice"
person.id = 123
person.email = "alice@example.com"

# 序列化消息
serialized_person = person.SerializeToString()

# 反序列化消息
new_person = example_pb2.Person()
new_person.ParseFromString(serialized_person)

print(new_person.name)  # 输出: Alice
print(new_person.id)    # 输出: 123
print(new_person.email) # 输出: alice@example.com