Protocol Buffers序列化协议及应用

赵祥翔
赵祥翔 2015-03-20 12:53 6 5247

Protocol Buffers是Google开发一种数据描述语言,能够将结构化数据序列化,可用于数据存储、通信协议等方面。据Google官方文档介绍,现在Google内部已经有48,162个消息类型定义在12,183个proto文件中。本文会从快速入门、语言规范、编码协议、性能评估等几个方面对Prototol Buffers进行介绍。

替代文字

替代文字

不了解Protocol Buffers的同学可以把它理解为更快、更简单、更小的JSON或者XML,区别在于Protocol Buffers是二进制格式,而JSON和XML是文本格式。

替代文字

相对于XML,Protocol Buffers的具有如下几个优点:

  • 简洁
  • 体积小:消息大小只需要XML的1/10 ~ 1/3
  • 速度快:解析速度比XML快20 ~ 100倍
  • 使用Protocol Buffers的编译器,可以生成更容易在编程中使用的数据访问代码
  • 更好的兼容性,Protocol Buffers设计的一个原则就是要能够很好的支持向下或向上兼容。

替代文字

看一个简单的对比例子,表达一个用户的三个基本的属性,如果使用XML消息体大小为82 bytes。
替代文字

如果使用JSON消息体大小为56 bytes。
替代文字

使用Protocol Buffers咋则只需要 31 bytes,看到这些二进制数据大家可以暂时忽略,后面会具体分析这些二进制数据是如何编码的。
替代文字

接下来先看一个简单的入门示例,在该例子中我们从准备环境开始,编写proto文件,到最后使用Protocol Buffers编译器生成代码,再到具体的使用。
替代文字

https://github.com/google/protobuf下载编译安装protoc,并下载Protobuf SDK。
替代文字

开始编写proto文件,使用message关键字定义消息类型,消息中每个字段需要指定字段类型和字段序号。同一个message中字段
替代文字

使用protoc命令生成代码,使用--cpp_out、--java_out、--python_out命令选项可以生成C++、Java、Python代码,在最新版本Protocol Buffers v3中还加入了ruby语言的支持。
替代文字

生成代码的代码可以直接加入到自己的代码工程中使用,以C++语言为例:
替代文字

这是一段Java语言的使用示例:
替代文字

接下来会详细说明如何定义proto文件:
替代文字

在消息定义中,我们需要确定三个问题:

  • 确定消息命名,给消息取一个有意义的名字。
  • 指定字段的类型
  • 定义字段的编号,在Protocol Buffers中,字段的编号非常重要,字段名仅仅是作为参考和生成代码用。需要注意的是字段的编号区间范围,其中19000 ~ 19999被Protocol Buffers作为保留字段。

    替代文字

    字段约束,required指定该字段必须赋值,禁止为空(在v3中该约束被移除);optional指定字段为可选字段,可以为空,对于optional字段还可以使用[default]指定默认值,如果没有指定,则会使用字段类型的默认值;使用repeated指定字段为集合。
    替代文字

    在一个proto文件中可以同时定义多个message类型,生成代码时根据生成代码的目标语言不同,处理的方式不太一样,如Java会针对每个message类型生成一个.java文件。还可以使用C++风格的注释。
    替代文字

    在Protocol Buffers中提供了很多的标量类型,供我们在定义字段类型时使用。
    替代文字

    可以指定字段的类型为其他message类型,如图中的示例代码所示:
    替代文字

    还可以使用import关键字导入其他proto文件,这有利于你进行自己的proto文件的规划和整理。
    替代文字

    在proto文件中消息的类型还可以嵌套,如你定义的message类型仅作为另外一个Message的字段类型。
    替代文字

    为了便于扩展,在proto文件中可以使用extensions关键字预留一部分字段编号出来,以便于后期给第三方扩展时使用。
    替代文字

    oneof关键字指定一组字段中,至少要有一个字段必须赋值。如在用户登录系统中,使用邮箱和用户名都可以登录该系统,所以通常会要求至少提供用户名或者邮箱。
    替代文字

    在这一部分总我们会仔细分析,Protocol Buffers序列化后的二进制代码的编码协议,不知道这些并不会影响我们使用Protocol Buffers,但是了解之后有助于我们更好的使用Protocol Buffers和进行调试。
    替代文字

    先从一个简单的例子开始,如图中的代码所示,我们有这样一个消息定义,在使用中给a赋值为150,最终编码得到的结果是 08 96 01,为什么编码的结果是这样,其中08又代表什么?后续一一为你介绍。
    替代文字

    在Protocol Buffers中采用Base-128变长编码,所谓变长编码是和定长编码相对的,定长编码使用固定字节数来表示,如int32类型的数字固定使用4 bytes表示,而变长编码是需要几个字节就使用几个字节,如对于int32类型的数字1来说,只需要1 bytes足够。Base-128变长编码的原则就两条:

  • 每个字节使用使用低7位表示数字,除了最后一个字节,其他字节的最高位都设置为1。

  • 采用Little-Endian字节序

替代文字

一个Protocol Buffers的消息包含一系列字段key/value,每个字段由一个变长32位整数作为字段头,后面跟随字段体。字段头的格式如下:

(field_number << 3) | wire_type

-field_number:    字段序号 
-wire_type:    字段编码类型

替代文字

这里是详细的字段说明,其中3、4已经放弃:
替代文字

替代文字

替代文字

替代文字

替代文字

替代文字

接下来我们对Protocol Buffers的性能做一些测试。
替代文字

在测试过程中,我们使用一个统一的消息体格式,主要评估以下两个性能指标:

  • 序列化速度
  • 报文大小

替代文字

替代文字

替代文字

替代文字

替代文字

尽管Protocol Buffers有序列化速度快、报文体积小以及更好的兼容性等优点,但同时也有一些缺点,在使用时要根据实际情况来选择使用。

  • 缺乏自描述,可读性差,可以使用TextFormat
  • 适用于内部服务和存储,而不适合直接对外公开,如Open API,protobuf v3将加入对json的支持,可解决此问题

替代文字

与Protocol Buffers类似的框架有微软出的Bond和Facebook出的Thrift,感兴趣的同学可以去下载研究一下。
替代文字

替代文字

Worktle 免费了

评 论

mark

感觉不错

朱磊 朱磊
10-10 19:38 #6

这里还没实战解决多协议的问题,你现在客户端和服务端是已经知传的是时候. 正常开发中数据结构那么多,靠啥识别阿.