【C++版本】protobuf与gRPC

news2024/9/9 1:09:34

文章目录

一、Protobuf
二、安装以及使用protoc
参考

一、Protobuf

在这里插入图片描述

Google Protocol Buffers（protobuf）是一种语言中立、平台中立的序列化协议，旨在高效地将结构化数据进行序列化和反序列化。它主要用于通信协议、数据存储和其他需要高效编码和解码结构化数据的场景。protobuf 由 Google 开发和开源，广泛用于 Google 的内部系统以及众多开源项目和商业应用中。

Protobuf 的用途
（1）数据序列化：

Protobuf 将数据结构化为紧凑的二进制格式，适用于网络传输、持久化存储等需要高效数据编码的场景。
相较于 XML 和 JSON，protobuf 编码后的数据占用更少的空间，解析速度更快。
跨语言和跨平台通信：

（2）Protobuf 支持多种编程语言，如 C++, Java, Python, Go, Ruby 等，适用于异构系统间的通信。

数据结构定义在 .proto 文件中，不同语言的代码生成器可以从 .proto 文件生成相应语言的类，实现数据的编解码。
远程过程调用（RPC）：

（3）Protobuf 可以与 gRPC 结合使用，定义和实现高效的 RPC 协议，支持流式传输和双向通信。

gRPC 通过 protobuf 定义服务接口和消息格式，自动生成客户端和服务端代码，简化了分布式系统的开发。

（4）数据存储：

Protobuf 可以用于将数据序列化后存储到文件或数据库中，确保数据存储和传输的高效性。
由于 protobuf 的二进制格式紧凑，特别适合在存储空间有限或网络带宽受限的环境中使用。

（5）Protobuf 的优点

高效性：序列化后的数据格式紧凑，占用更少的存储空间和带宽，解析速度快。
可扩展性：支持向后兼容和向前兼容，允许在不破坏现有数据格式的情况下添加新字段。
多语言支持：生成的代码可在多种编程语言中使用，便于不同语言系统之间的数据交换。
简洁性：定义数据结构的 .proto 文件简单直观，便于维护和管理。

二、安装以及使用protoc

$ apt install -y protobuf-compiler
$ protoc --version  # Ensure compiler version is 3+

定义person.proto文件

//person.proto
package yaojun;
 
message Person {
  required string name = 1;
  required int32 id = 2;
  optional string email = 3;
}

语法规则：
字段定义：

每个字段有三部分：修饰符、类型和字段名，以及一个唯一的编号。
修饰符：
required：表示字段是必需的，消息必须包含该字段，否则解析消息时会报错。
optional：表示字段是可选的，消息中可以包含也可以不包含该字段。
repeated（示例中未使用）：表示字段可以重复零次或多次，通常用于列表或数组。
类型：
string：表示字符串类型。
int32：表示32位整数类型。
字段名和编号：
每个字段有一个唯一的编号，用于标识字段。这些编号在消息的二进制表示中非常重要，用于解码数据。
编号必须是正整数，且在同一消息类型中必须唯一。

在这个例子中：

required string name = 1;：定义了一个必需的字符串字段 name，编号为 1。
required int32 id = 2;：定义了一个必需的 32 位整数字段 id，编号为 2。
optional string email = 3;：定义了一个可选的字符串字段 email，编号为 3。

~/code/PremiumProject/protobuf main 
 protoc --proto_path=.  --cpp_out=. person.proto

代码：

// yaojun_person.cpp
#include "google/protobuf/io/zero_copy_stream_impl.h"
#include "google/protobuf/text_format.h"
#include "person.pb.h"
#include <fstream>
#include <iostream>

using namespace yaojun;
int main() {
  Person p;
  p.set_name("test");
  p.set_id(100);
  p.set_email("940334249@qq.com");

  // 将pb二进制信息保存到字符串, 序列化
  std::string str;
  p.SerializeToString(&str);
  std::cout << "str: [" << str << "]" << std::endl;

  // 将pb文本信息写入文件
  std::ofstream fw;
  fw.open("./Person.txt", std::ios::out | std::ios::binary);
  google::protobuf::io::OstreamOutputStream *output =
      new google::protobuf::io::OstreamOutputStream(&fw);
  google::protobuf::TextFormat::Print(p, output);

  delete output;
  fw.close();

  // 将pb文本信息保存到字符串
  std::string str1;
  google::protobuf::TextFormat::PrintToString(p, &str1);
  std::cout << "str1: [" << str1 << "]" << std::endl;

  // 反序列化
  Person p1;
  p1.ParseFromString(str);
  std::cout << "name:" << p1.name() << ",email:" << p1.email()
            << ",id:" << p1.id() << std::endl;

  return 0;
}