Google Protobuf简明教程

Protobuf是什么

Protobuf实际是一套类似Json或者XML的数据传输格式和规范,用于不同应用或进程之间进行通信时使用。通信时所传递的信息是通过Protobuf定义的message数据结构进行打包,然后编译成二进制的码流再进行传输或者存储。

Protobuf的优点

相比较而言,Protobuf有如下优点:

  • 足够简单
  • 序列化后体积很小:消息大小只需要XML的1/10 ~ 1/3
  • 解析速度快:解析速度比XML快20 ~ 100倍
  • 多语言支持
  • 更好的兼容性,Protobuf设计的一个原则就是要能够很好的支持向下或向上兼容

如何安装使用Protobuf

安装

使用Python的话简便的安装方法如下

pip install protobuf    # 安装protobuf库
sudo apt-get install protobuf-compiler  # 安装protobuf编译器

如果自己编译安装的话可以参考git上安装指导,虽然写得不清楚:)

使用

使用Protobuf有如下几个步骤:

  1. 定义消息
  2. 初始化消息以及存储传输消息
  3. 读取消息并解析

下面以一个实际的例子来说明如何使用Protobuf,先展示出项目的实际目录结构:

.
├── my
│   ├── helloworld_pb2.py
│   ├── helloworld_pb2.pyc
│   └── __init__.py
├── mybuffer.io
├── my.helloworld.proto
├── reader.py
└── writer.py

定义消息

Protobuf的消息结构是通过一种叫做Protocol Buffer Language的语言进行定义和描述的,实际上Protocol Buffer Language分为两个版本,版本2和版本3,默认不声明的情况下使用的是版本2,下面以版本2为来举个栗子, 假设我们定义了文件名为my.helloworld.proto的文件,如下:

package my;
message helloworld
{
    required int32 id = 1;
    required string str = 2;
    optional int32 wow = 3;
}

然后我们需要使用protoc进行编译

protoc -I=./ --python_out=./ ./my.helloworld.proto
  • -I: 是设定源路径
  • --python_out: 用于设定编译后的输出结果,如果使用其它语言请使用对应语言的option
  • 最后一个参数是你要编译的proto文件

现在已经定义好了消息的数据结构,接下来看下如何使用

消息初始化和存储传输

我们来通过writer.py来初始化消息并存储为文件,代码如下:

from my.helloworld_pb2 import helloworld

def main():
    hw = helloworld()
    hw.id = 123
    hw.str = "eric"
    print hw

    with open("mybuffer.io", "wb") as f:
        f.write(hw.SerializeToString())

if __name__ == "__main__":
    main()

执行writer.py之后就会将序列化的结果存储在文件mybuffer.io中,然后看下如何读取

消息读取与解析

我们通过reader.py来读取和解析消息,代码如下:

from my.helloworld_pb2 import helloworld


def main():
    hw = helloworld()
    with open("mybuffer.io", "rb") as f:
        hw.ParseFromString(f.read())
        print hw.id
        print hw.str


if __name__ == "__main__":
    main()

Reference:

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 127,681评论 18 546
  • 由于工程项目中拟采用一种简便高效的数据交换格式,百度了一下发现除了采用 xml、JSON 还有 ProtoBuf(...
    黄海佳阅读 14,378评论 1 13
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 74,776评论 12 116
  • 有一个名字,念出来就是一段风景——阮玲玉;有一个名字,读出来就是一段伤情——阮玲玉。 她16岁投身影坛,在九年内拍...
    归途行者阅读 137评论 1 0
  • 应用场景:在开发app过程中,你肯定需要有测试环境,而测试环境和线上环境的切换如果你是根据修改代码来实现那你就太l...
    木木少烈阅读 756评论 0 2