Protobuf 序列化协议详解

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

猜你喜欢

转载自blog.csdn.net/junerseven7/article/details/71077734
今日推荐