Protobuf的使用

ProtoBuf在中C++使用介绍

ProtoBuf的定义和描述：

Protocol Buffers 是一种语言无关、平台无关、可扩展的序列化结构数据的方法，它可用于（数据）通信协议、数据存储等。
Protocol Buffers 是一种灵活，高效，自动化机制的结构数据序列化方法－可类比 XML，但是比 XML 更小（3 ~ 10倍）、更快（20 ~ 100倍）、更为简单。
你可以定义数据的结构，然后使用特殊生成的源代码轻松的在各种数据流中使用各种语言进行编写和读取结构数据。你甚至可以更新数据结构，而不破坏由旧数据结构编译的已部署程序。

基本概念

数据序列化 (data serialization) 指的是将内存中的数据保存到文件中的过程；与之对应的，数据反序列化 (data deserialization) 指的是将文件中的数据恢复到内存中的过程。
最简单的数据序列化和反序列化方法可以采用 fwrite() 和 fread() 来将一段给定内存空间里的数据写到文件中。这种简单粗暴的方法有几方面局限：

要求数据在内存中是连续的；

如果数据不连续，需要自己编写一系列 fwrite()和fread() 来完成序列化和反序列化；

没有显式的数据格式，一旦数据结构发生变化，之前生成的数据文件都将无法加载；

序列化和反序列化系统需要采用一样的 Endian，即同为大端格式或小端格式；

为了解决这些问题，人们提出了一系列数据序列化和反序列化格式。在大的维度上，可以划分为文本格式和二进制格式两大类，例如 JSON, XML, INI 是文本格式， BSON, PB, PBS 是二进制格式。有一些格式，例如 Protobuf 和 FlatBuffers，同时支持两类格式输出。二进制格式的储存效率和加载速度都显著更高，所以本文主要讨论二进制格式。
常见的数据序列化格式有 Protobuf, Thrift, FlatBuffers, Avro 等，其中 Thrift 出自 Facebook， Protobuf 和 FlatBuffers 出自 Google。维基百科上有一个页面比较了常见的数据序列化格式。
使用 ProtoBuf教程：

对 ProtoBuf 的基本概念有了一定了解之后，我们来看看具体该如何使用 ProtoBuf。
首先看一下文件目录：
ybg@ubuntu:~/test $ tree -L 1 proto
proto
├── example.pb.cc
├── example.pb.h
├── example.proto
├── Example.txt
├── protobuf
├── test_example
└── test_proto.cc

1 directory, 7 files

---

cat example.proto

syntax = “proto2”;
package ybg.proto;
message Example {
optional string name = 1;
optional float pi = 2;
}

在.proto 文件中定义了数据结构，这些数据结构是面向开发者和业务程序的，并不面向存储和传输。当需要把这些数据进行存储或传输时，就需要将这些结构数据进行序列化、反序列化以及读写。ProtoBuf 提供相应的接口代码，可以通过 protoc 这个编译器来生成相应的接口代码，命令如下

./protobuf/bin/protoc -I . --cpp_out . example.proto

生成example.pb.cc和example.pb.h

编写test_example.cc

#include <iostream>
#include <fstream>
#include "example.pb.h"
#include "google/protobuf/io/zero_copy_stream_impl.h"
#include "google/protobuf/text_format.h"
 
 
using namespace ybg;
using namespace proto;
int main(){
  Example p;
  p.set_name("binggang.yin");
  p.set_pi(3.14);
 
  //------------------将pb二进制信息保存到字符串
  std::string str;
  p.SerializeToString(&str);
  std::cout<<"str: ["<<str<<"]"<<std::endl;  
 
  //------------------将pb文本信息写入文件
  std::ofstream fw; 
  fw.open("./Example.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;
 
  //---------------------反序列化
  Example p1;
  p1.ParseFromString(str);
  std::cout<<"name:"<<p1.name()<<",pi:"<<p1.pi()<<std::endl;
 
  return 0;
}

编译：

g++ -g -o test_example test_proto.cc example.pb.cc -I. -Iprotobuf/include -L protobuf/lib-static -lprotobuf -pthread -std=c++11

运行：

./test_example
str: [

binggang.yin��H@]
str1: [name: “binggang.yin”
pi: 3.14
]
name:binggang.yin,pi:3.14

$ cat Example.txt
name: “binggang.yin”
pi: 3.14

api说明：

p.SerializeToString(&str)：将对象p序列化成二进制数据，保存到字符串中；
二进制虽然小，但是可读性差，所以通过google::protobuf::TextFormat::print()方法生成文本数据写入文件；为此需要引入google/protobuf/text_format.h(否则会报‘google::protobuf::TextFormat’ has not been declared错误)、zero_copy_stream_impl.h(否则会报OstreamOutputStream找不到)
除了将pb信息序列化成文本写入文件外，还可以调用google::protobuf::TextFormat::PrintToString(mrlist, &str1); 方法将pb文本信息保存到字符串中；（别忘了加text_format.h头文件）
p1.ParseFromString(str);：将字符串中的二进制信息反序列成Person对象；
C++版pb的api一般为：pb对象.set_消息属性(value)；设置属性值；pb对象.消息属性()；获取属性值。