Protobuf记述与使用-Aet

Bingliaolong 2022-01-24 15:05 Aet | 隐藏边栏 | 抢沙发 | 8 0

文章评分 2 次，平均分 5.0 ：

理解

protobuf允许不同编程语言的程序员以自己熟悉的方式在.proto文件里定义消息结构
然后protobuf的引擎把这个.proto文件里描述的消息结构进行解析，最后生成对应语言的代码，这些代码里描述了之前定义的消息结构
然后在项目中，需要用到这些消息结构的模块，只需引入这些代码，就可以使用生成的代码中提供的一些接口来序列化或反序列化

差异

序列化方法

原始内存数据结构以二进制形式发送或保存。
1. 缺陷是必须使用完全相同的内存布局、字节序等来编译接收/读取代码
发明一种特殊方式将数据项编码为单个字符串。
1. 适合编码非常简单的数据
将数据序列化为 XML
1. 问题是XML 是空间密集型的，编码/解码它会给应用程序带来巨大的性能损失
2. 导航 XML DOM 树比导航类中的简单字段通常要复杂得多

protobuf

解决上面的问题。
编写.proto要存储的数据结构的描述
协议缓冲区编译器创建了一个类：
1. 该类以高效的二进制格式实现协议缓冲区数据的自动编码和解析
2. 生成的类为构成协议缓冲区的字段提供了 getter 和 setter
3. 并将读写协议缓冲区的细节作为一个单元处理
4. 重要的是，协议缓冲区格式支持随着时间的推移扩展格式的想法，这样代码仍然可以读取使用旧格式编码的数据

基础

类型

bool
int32
float
double
string
其他message类型

message Person {

optional string name = 1;

optional int32 id = 2;

optional string email = 3;

enum PhoneType {

MOBILE = 0;

HOME = 1;

WORK = 2;

}

message PhoneNumber {

optional string number = 1;

optional PhoneType type = 2 [default = HOME];

}

repeated PhoneNumber phones = 4;

}

message AddressBook {

repeated Person people = 1;

}

语法

还可以定义enum类型，让某些字段具有预定义的值（如上述PhoneType）
每个元素后面的= 1,= 2标记，标识该字段在二进制编码中使用的唯一“标签”。
1. 标签编号 1-15 比更高的编号需要少一个字节来编码
2. 因此作为一种优化，您可以决定将这些标签用于常用或重复的元素，而将标签 16 和更高的标签用于不太常用的可选元素
optional
1. 该字段可以设置也可以不设置
2. 如果未设置可选字段值，则使用默认值
  对于简单类型，您可以指定自己的默认值，就像上面的type那样
  否则，使用系统默认值：数字类型为零，字符串为空字符串，布尔值为 false
  对于message，默认值始终是消息的“默认实例”或“原型”，没有设置任何字段
  调用访问器以获取未显式设置的可选（或必需）字段的值始终返回该字段的默认值
repeated
1. 该字段可以重复任意次数（包括零次）
2. 可以将重复字段视为动态大小的数组
required
1. 必须提供该字段的值，否则该消息将被视为“未初始化”
2. 如果libprotobuf在调试模式下编译，序列化未初始化的message将导致断言失败
  在优化的构建中，会跳过检查并且无论如何都会写入消息
  但是，解析未初始化的消息总是会失败（从Parse）

编译

下载生成工具：地址
Windows下下载Win32压缩包
proto文件定义

syntax = "proto2";

package tutorial;

message Person {

optional string name = 1;

optional int32 id = 2;

optional string email = 3;

enum PhoneType {

MOBILE = 0;

HOME = 1;

WORK = 2;

}

message PhoneNumber {

optional string number = 1;

optional PhoneType type = 2 [default = HOME];

}

repeated PhoneNumber phones = 4;

}

message AddressBook {

repeated Person people = 1;

}

命令如下图：

API

解析和序列化

每个协议缓冲区类都有使用协议缓冲区二进制格式写入和读取您选择的类型的消息的方法
bool SerializeToString(string* output) const;
1. 序列化消息并将字节存储在给定的字符串中
2. 需要注意的是，字节是二进制的，而不是文本；使用string类只是作为一个方便的容器
bool ParseFromString(const string& data);
1. 从给定的字符串解析消息
bool SerializeToOstream(ostream* output) const;
1. 将消息写入给定的 C++ ostream
bool ParseFromIstream(istream* input);
1. 解析来自给定 C++ 的消息istream

使用

#include <iostream>

#include <fstream>

#include <string>

#include "test.pb.h"

using namespace std;

// This function fills in a Person message based on user input.

void PromptForAddress(tutorial::Person* person) {

cout << "Enter person ID number: ";

int id;

cin >> id;

person->set_id(id);

cin.ignore(256, '\n');

cout << "Enter name: ";

getline(cin, *person->mutable_name());

cout << "Enter email address (blank for none): ";

string email;

getline(cin, email);

if (!email.empty()) {

person->set_email(email);

}

while (true) {

cout << "Enter a phone number (or leave blank to finish): ";

string number;

getline(cin, number);

if (number.empty()) {

break;

}

tutorial::Person::PhoneNumber* phone_number = person->add_phones();

phone_number->set_number(number);

cout << "Is this a mobile, home, or work phone? ";

string type;

getline(cin, type);

if (type == "mobile") {

phone_number->set_type(tutorial::Person::MOBILE);

} else if (type == "home") {

phone_number->set_type(tutorial::Person::HOME);

} else if (type == "work") {

phone_number->set_type(tutorial::Person::WORK);

} else {

cout << "Unknown phone type. Using default." << endl;

}

// Main function: Reads the entire address book from a file,

// adds one person based on user input, then writes it back out to the same

// file.

int main(int argc, char* argv[]) {

// Verify that the version of the library that we linked against is

// compatible with the version of the headers we compiled against.

GOOGLE_PROTOBUF_VERIFY_VERSION;

if (argc != 2) {

cerr << "Usage: " << argv[0] << " ADDRESS_BOOK_FILE" << endl;

return -1;

}

tutorial::AddressBook address_book;

{

// Read the existing address book.

fstream input(argv[1], ios::in | ios::binary);

if (!input) {

cout << argv[1] << ": File not found. Creating a new file." << endl;

} else if (!address_book.ParseFromIstream(&input)) {

cerr << "Failed to parse address book." << endl;

return -1;

}

// Add an address.

PromptForAddress(address_book.add_people());

{

// Write the new address book back to disk.

fstream output(argv[1], ios::out | ios::trunc | ios::binary);

if (!address_book.SerializeToOstream(&output)) {

cerr << "Failed to write address book." << endl;

return -1;

}

// Optional: Delete all global objects allocated by libprotobuf.

google::protobuf::ShutdownProtobufLibrary();

return 0;

}

理解
差异
序列化方法
protobuf
基础
类型
语法
编译
API
解析和序列化
使用

本文为原创文章，版权归Aet所有，欢迎分享本文，转载请保留出处！

Bingliaolong 关注：0 粉丝：0 最后编辑于：2024-07-03

Everything will be better.

一	二	三	四	五	六	日
1	2	3	4	5	6	7
8	9	10	11	12	13	14
15	16	17	18	19	20	21
22	23	24	25	26	27	28
29	30	31

理解

差异

序列化方法

protobuf

基础

类型

语法

编译

API

解析和序列化

使用

你可能也喜欢

热评文章

发表评论

标签云集