ProtobufC++ 使用详解

一、安装与环境配置

1、ProtobufC++ 是 Google 开发的一个开源序列化数据格式，支持多语言，对数据进行声明式的描述，可以生成代码用于数据的序列化和反序列化。使用 protobuf 前，需要先在本机上安装 Protocol Buffer，可以在官网下载安装包，也可以通过源代码进行安装。安装完 protobuf 后，还需要在环境变量中加入 protoc 的路径。

2、接着，下载 ProtobufC++ 的源码，使用命令行进入解压后的目录，使用 make 进行编译，生成 libprotobuf.a 和 libprotobuf-lite.a 两个静态库文件，将文件放入 lib 目录下，再将 include 目录下的头文件拷贝到系统目录中。

示例代码：

#安装 protobuf
$ sudo apt-get install protobuf-compiler
$ sudo apt-get install libprotobuf-dev

#下载 ProtobufC++

$ wget https://github.com/protobuf-c/protobuf-c/releases/download/v1.3.3/protobuf-c-1.3.3.tar.gz
$ tar -xvf protobuf-c-1.3.3.tar.gz
$ cd protobuf-c-1.3.3/
$ ./configure --prefix=/usr
$ make
$ sudo make install
$ sudo ldconfig

#检验安装是否成功
$ protoc --version

二、ProtobufC++ 的基本使用

1、定义 proto 文件

定义一个 proto 文件需要遵循一定的格式和规范，定义了消息的名称、字段个数、类型和顺序。下面是一个简单的 proto 文件：

syntax = "proto3";

message Person {
  string name = 1;
  int32 age = 2;
  bool is_student = 3;
}

2、生成 C++ 代码

使用 protoc 命令将 proto 文件编译成 C++ 代码。如下所示：

$ protoc --cpp_out=. person.proto

命令会生成 person.pb.h 和 person.pb.cc 两个文件。

3、序列化

使用生成的 C++ 代码对数据进行序列化，将数据打包成二进制格式。下面是一个序列化的示例代码：

Person person;
person.set_name("Tom");
person.set_age(20);
person.set_is_student(true);

std::string pbStr = person.SerializeAsString();

4、反序列化

使用生成的 C++ 代码将二进制数据反序列化为原始数据。下面是一个反序列化的示例代码：

Person person;
person.ParseFromString(pbStr);

std::cout << person.name() << std::endl;
std::cout << person.age() << std::endl;
std::cout << person.is_student() << std::endl;

三、ProtobufC++ 的进阶用法

1、自定义数据类型

除了支持基本数据类型，ProtobufC++ 还支持自定义数据类型。例如，我们可以定义一个枚举类型：

enum Gender {
  UNKNOWN = 0;
  MALE = 1;
  FEMALE = 2;
}

message Person {
  string name = 1;
  int32 age = 2;
  Gender gender = 3;
}

2、嵌套类型

可以在 message 中定义其他的 message 或枚举类型，例如定义一个 Address 类型：

message Address {
  string province = 1;
  string city = 2;
  string area = 3;
}

message Person {
  string name = 1;
  int32 age = 2;
  Address address = 3;
}

3、使用 protobuf 对象作为字段

可以将一个 message 对象作为另一个 message 的字段类型，例如定义一个 Student 类型：

message Course {
  string name = 1;
  float score = 2;
}

message Student {
  string name = 1;
  int32 age = 2;
  repeated Course courses = 3;
}

4、使用 oneof 定义多个可选字段

使用 oneof 关键字可以定义一个 message 中多个可选字段，只能同时存在一个字段有值。例如定义一个成绩类型，可以有学生得分或者课程得分：

message Score {
  oneof score {
    float student_score = 1;
    float course_score = 2;
  }
}

四、ProtobufC++ 常用函数

1、set_字段名()

设置 message 中某个字段的值，函数的名称为 set_字段名()，例如：

person.set_name("Tom");

2、字段名() 和 mutable_字段名()

获取 message 中某个字段的值，其中字段名() 用于获取 const 类型的字段，mutable_字段名() 用于获取非 const 类型的字段：

std::string name = person.name();
person.mutable_address()->set_city("Shanghai");

3、SerializeToString() 和 ParseFromString()

对 message 进行序列化和反序列化的函数：

std::string pbStr = person.SerializeAsString();

Person person;
person.ParseFromString(pbStr);

五、总结

以上就是 ProtobufC++ 的基本使用和进阶用法，包括环境配置、 proto 文件定义、生成 C++ 代码、序列化和反序列化、自定义类型、嵌套类型、使用 message 作为字段、使用 oneof 定义多个可选字段以及常用函数。

通过对 ProtobufC++ 的学习和使用，可以更高效地进行数据序列化和反序列化，使得程序性能更优。

原创文章，作者：RKPGH，如若转载，请注明出处：https://www.506064.com/n/361565.html