Protocol Buffers使用教程

最新推荐文章于 2024-10-11 08:07:37 发布

NoahDSun

最新推荐文章于 2024-10-11 08:07:37 发布

阅读量5k

点赞数

分类专栏：通用技术分享文章标签： pb protocol buffers protocol-buffers

本文链接：https://blog.csdn.net/samdy2008/article/details/52139047

版权

Protocol Buffers是一种高效的数据序列化方法，用于结构化数据的串行化，类似于XML但更小、更快。本文档详细介绍了Protocol Buffers的工作原理、安装、语言指导、编码原理，以及与其他序列化技术的性能比较，旨在帮助开发者快速理解和使用Protocol Buffers。

摘要由CSDN通过智能技术生成

Protocol Buffers使用教程

1 概述

1.1 什么是protocol buffers？

ProtocolBuffer是用于结构化数据串行化的灵活、高效、自动的方法，类似 XML，不过它更小、更快、也更简单。你可以定义自己的数据结构，然后使用代码生成器生成的代码来读写这个数据结构。你甚至可以在无需重新部署程序的情况下更新数据结构。

1.2 他们如何工作

你首先需要在一个.proto文件中定义你需要做串行化的数据结构信息。每个ProtocolBuffer信息是一小段逻辑记录，包含一系列的键值对。这里有个非常简单的.proto文件定义了个人信息:

message Person {

required string name=1;

required int32 id=2;

optional string email=3;

enum PhoneType {

MOBILE=0;

HOME=1;

WORK=2;

}

message PhoneNumber {

required string number=1;

optional PhoneType type=2 [default=HOME];

}

repeated PhoneNumber phone=4;

}

有如你所见，消息格式很简单，每个消息类型拥有一个或多个特定的数字字段，每个字段拥有一个名字和一个值类型。值类型可以是数字(整数或浮点)、布尔型、字符串、原始字节或者其他ProtocolBuffer类型，还允许数据结构的分级。你可以指定可选字段，必选字段和重复字段。你可以在( http://code.google.com/apis/protocolbuffers/docs/proto.html )找到更多关于如何编写 .proto 文件的信息。

一旦你定义了自己的报文格式(message)，你就可以运行ProtocolBuffer编译器，将你的.proto文件编译成特定语言的类。这些类提供了简单的方法访问每个字段(像是 query() 和 set_query() )，像是访问类的方法一样将结构串行化或反串行化。例如你可以选择C++语言，运行编译如上的协议文件生成类叫做 Person 。随后你就可以在应用中使用这个类来串行化的读取报文信息。你可以这么写代码:

Person person;

person.set_name("John Doe");

person.set_id(1234);

person.set_email("jdoe@example.com");

fstream.output("myfile",ios::out | ios::binary);

person.SerializeToOstream(&output);

然后，你可以读取报文中的数据:

fstream input("myfile",ios::in | ios:binary);

Person person;

person.ParseFromIstream(&input);

cout << "Name: " << person.name() << endl;

cout << "E-mail: " << person.email() << endl;

你可以在不影响向后兼容的情况下随意给数据结构增加字段，旧有的数据会忽略新的字段。所以如果使用ProtocolBuffer作为通信协议，你可以无须担心破坏现有代码的情况下扩展协议。

你可以在API参考( http://code.google.com/apis/protocolbuffers/docs/reference/overview.html )中找到完整的参考，而关于ProtocolBuffer的报文格式编码则可以在( http://code.google.com/apis/protocolbuffers/docs/encoding.html )中找到。

1.3 为什么不使用xml？

ProtocolBuffer拥有多项比XML更高级的串行化结构数据的特性，ProtocolBuffer：

更简单

小3-10倍

快20-100倍

更少的歧义

可以方便的生成数据存取类

例如，让我们看看如何在XML中建模Person的name和email字段:

<email>jdoe@example.com</email>

</person>

对应的ProtocolBuffer报文则如下:

#ProtocolBuffer的文本表示

#这不是正常时使用的二进制数据

person {

name: "John Doe"

email: "jdoe@example.com"

}

当这个报文编码到ProtocolBuffer的二进制格式( http://code.google.com/apis/protocolbuffers/docs/encoding.html )时(上面的文本仅用于调试和编辑)，它只需要28字节和100-200ns的解析时间。而XML的版本需要69字节(除去空白)和5000-10000ns的解析时间。

当然，操作ProtocolBuffer也很简单:

cout << "Name: " << person.name() << endl;

cout << "E-mail: " << person.email() << endl;

而XML的你需要:

cout << "Name: "

<< person.getElementsByTagName("name")->item(0)->innerText()

<< endl;

cout << "E-mail: "

<< person.getElementsByTagName("email")->item(0)->innerText()

<< end;

当然，ProtocolBuffer并不是在任何时候都比XML更合适，例如ProtocolBuffer无法对一个基于标记文本的文档建模（比如HTML），因为你根本没法方便的在文本中插入结构。另外，XML是便于人类阅读和编辑的，而ProtocolBuffer则不是。还有XML是自解释的，而 ProtocolBuffer仅在你拥有报文格式定义的.proto 文件时才有意义。