c++如何使用protobuf c++数据序列化教程【实例】

C++中使用Protobuf序列化需三步:编写.proto文件定义结构,用protoc生成C++代码,再在程序中创建、序列化(SerializeToOstream)和反序列化(ParseFromIstream)对象,全程需检查布尔返回值确保成功。

在 C++ 中使用 Protocol Buffers(Protobuf)做数据序列化,核心是三步:写 .proto 文件定义结构 → 用 protoc 编译生成 C++ 类 → 在代码中创建、序列化、反序列化对象。下面以一个简单但完整的实例带你走通全流程。

1. 定义消息格式(.proto 文件)

新建 person.proto,描述一个“人”的基本信息:

syntax = "proto3";
package tutorial;

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

说明:
syntax = "proto3" 表示使用 Protobuf v3 语法;
package 避免命名冲突,生成的 C++ 类会放在 tutorial::Person 命名空间;
repeated 表示可变长字段(对应 std::vector<:string>);
• 数字(1/2/3/4)是字段唯一标识符,不能随意改动,影响二进制兼容性。

2. 生成 C++ 代码

确保已安装 protoc(Protobuf 编译器),执行:

protoc --cpp_out=. person.proto

会生成两个文件:
person.pb.h —— 包含类声明和内联方法;
person.pb.cc —— 包含实现,需参与编译。

注意:
• 若提示找不到 google/protobuf 头文件,请确认已安装 protobuf 开发包(如 Ubuntu 下 sudo apt install libprotobuf-dev protobuf-compiler);
• 编译时需链接 -lprotobuf

3. 编写 C++ 序列化与反序列化代码

新建 main.cpp

#include 
#include 
#include 
#include "person.pb.h"

int main() {
  // 创建并填充 Person 对象
  tutorial::Person person;
  person.set_name("张三");
  person.set_id(12345);
  person.set_email("zhangsan@example.com");
  person.add_phone("138-0013-8000");
  person.add_phone("0755-1234567");

  // 序列化为二进制(保存到文件)
  std::ofstream output("person.dat", std::ios::binary);
  if (!person.SerializeToOstream(&output)) {
    std::cerr << "序列化失败\n";
    return -1;
  }
  output.close();

  // 反序列化(从文件读取)
  tutorial::Person restored;
  std::ifstream input("person.dat", std::ios::binary);
  if (!restored.ParseFromIstream(&input)) {
    std::cerr << "反序列化失败\n";
    return -1;
  }
  input.close();

  // 打印验证
  std::cout << "Name: " << restored.name() << "\n";
  std::cout << "ID: " << restored.id() << "\n";
  std::cout << "Email: " << restored.email() << "\n";
  for (const auto& phone : restored.phone()) {
    std::cout << "Phone: " << phone << "\n";
  }

  return 0;
}

关键点:
• 所有字段访问器(set_xxx()xxx()add_xxx())均由 Protobuf 自动生成;
SerializeToOstream()ParseFromIstream() 是最常用、最安全的 I/O 方式;
• 若需内存中序列化(如网络传输),可用 SerializeToString()SerializeToArray()
• 所有 Protobuf 操作默认不抛异常,务必检查返回值(bool)判断成败。

4. 编译与运行

假设使用 g++,命令如下:

g++ -std=c++11 main.cpp person.pb.cc -lprotobuf -o person_demo

然后运行:

./person_demo

输出应显示张三的信息,且生成 person.dat 二进制文件(不可读,但体积小、解析快)。

不复杂但容易忽略