protobuf学习使用总结

2019/7/23 10:46:59 人评论 次浏览 分类:学习教程


protobuf是google团队开发的用于高效存储和读取结构化数据的工具。
xml、json也可以用来存储此类结构化数据,但是使用protobuf表示的数据能更加高效,并且将数据压缩得更小,大约是json格式的1/10,xml格式的1/20。
以下介绍基于protobuf 2.6版本

定义message结构
protobuf将一种结构称为一个message类型,对应C/C++中的struct;
我们以电话簿中的数据为例。
struct Person {
    string name;
    int32 id;
    string email;
    list<int32> samples;
};

对应到protobuf的定义如下:

message Person {
  required string name = 1;
  required int32 id = 2; [default = 0]
  optional string email = 3;
  repeated int32 samples = 4 [packed=true];
}
其中Person是message这种结构的名称,name、id、email是其中的Field,每个Field保存着一种数据类型,=后面的1、2、3是Filed对应的id。
id在1-15之间编码只需要占一个字节,包括Filed数据类型和Filed对应数字id,在16-2047之间编码需要占两个字节,所以最常用的数据对应id要尽量小一些。

Field最前面的required,optional,repeated是这个Filed的规则,分别表示该数据结构中这个Filed有且只有1个,可以是0个或1个,可以是0个或任意个。
required: 必须设置它的值
optional: 可以设置,也可以不设置它的值
repeated: 可以认为是动态分配的数组
google工程师认为使用required威害更大,他们更喜欢使用optional, repeated.
optional后面可以加default默认值,如果不加,数据类型的默认为0,字符串类型的默认为空串。repeated后面加[packed=true]会使用新的更高效的编码方式。
注意:使用required规则的时候要谨慎,因为以后结构若发生更改,这个Filed若被删除将可能导致兼容性的问题。

保留Filed和保留Filed number
每个Filed对应唯一的数字id,但是如果该结构在之后的版本中某个Filed删除了,为了保持向前兼容性,需要将一些id或名称设置为保留的,即不能被用来定义新的Field

message Person {
  reserved 2, 15, 9 to 11;
  reserved "samples", "email";
}

引用其它message类
在同一个文件中,可以直接引用定义过的message类型。
在同一个项目中,可以用import来导入其它message类型。如 import "OnstarInterfaceAndroid.proto";
也可以在一个message类型中嵌套定义其它的message类型。

message扩展
如果要import的 proto 中有如下定义
message Person {
  // ...
  extensions 100 to 199;
}
在另一个文件中,import 这个proto之后,可以对Person这个message进行扩展。
extend Person {
  optional int32 bar = 126;
}


枚举类型
比如电话号码,只有移动电话、家庭电话、工作电话三种类型,因此枚举作为选项,枚举类型的默认值为第一项。
在上面的例子中在个人message中加入电话号码这个Filed。如果枚举类型中有不同的名字对应相同的数字id,需要加入option allow_alias = true这一项,否则会报错。
枚举类型中也有reserverd Filed和number,定义和message中一样。
message Person {
  required string name = 1;
  required int32 id = 2;
  optional string email = 3;

  enum PhoneType {
    //allow_alias = true;
    MOBILE = 0;
    HOME = 1;
    WORK = 2;
  }

  message PhoneNumber {
    required string number = 1;
    optional PhoneType type = 2 [default = HOME];
  }

  repeated PhoneNumber phones = 4;
}

枚举定义之后,在生成源代码时会在编解码的接口中检查有效性

数据类型对应关系
在使用规则创建proto类型的数据结构文件之后,会将其转化成对应编程语言中的头文件或者类定义。
proto中的数据类型和c++,Python中的数据类型对应规则如下:
.proto    C++    Python    介绍
double    double    float
float    float    float
int32    int32    int    可变长编码,对负数效率不高
int64    int64    int/long
uint32    uint32    int/long
uint64    uint64    int/long
sint32    int32    int    可变长编码,对负数效率较高
sint64    int64    int/long
fixed32    uint32    int/long    32位定长编码
fixed64    uint64    int/long
sfixed32    int32    int
sfixed64    int64    int/long
bool    bool    bool
string    string    str/unicode    UTF-8编码或者7-ASCII编码
bytes    string    str
由此可知,proto类型和C++类型几乎完全一致;

编码规则
protobuf有一套高效的数据编码规则。
可变长整数编码
每个字节有8bits,其中第一个bit是most significant bit(msb),0表示结束,1表示还要读接下来的字节。
对message中每个Filed来说,需要编码它的数据类型、对应id以及具体数据。
数据类型有以下6种,可以用3个bits表示。每个整数编码用最后3个bits表示数据类型。所以,对应id在1~15之间的Filed,可以用1个字节编码数据类型、对应id。
Type    Meaning        Used For
0        Varint        int32, int64, uint32, uint64, sint32, sint64, bool, enum
1        64-bit        fixed64, sfixed64, double
2        Length-delimited        string, bytes, embedded messages, packed repeated    fields
3        Start group        groups (deprecated)
4        End group        groups (deprecated)
5        32-bit            fixed32, sfixed32, float

(id + 数据类型) + 数值
比如对于下面这个例子来说,如果给a赋值150,那么最终得到的编码是什么呢?
message Test {
  optional int32 a = 1;
}

首先数据类型编码是000,因此id和它联合起来的编码是00001000. 
然后值150的编码是1 0010110,采用小端序交换位置,即0010110 0000001,前面补1后面补0,即10010110 00000001,即96 01,
加上最前面的数据类型编码字节,总的编码为08 96 01。

有符号整数编码
如果用int32来保存一个负数,结果总是有10个字节长度,被看做是一个非常大的无符号整数。
使用有符号类型会更高效。它使用一种ZigZag的方式进行编码。即0还是0,-1编码成1,1编码成2,-2编码成3这种形式。
也就是说,对于sint32来说,n编码成 (n << 1) ^ (n >> 31),注意到第二个移位是算法移位。

定长编码
定长编码是比较简单的情况。

安装protobuf包
首先官方下载源码并解压
后面以ubuntu安装为例
$ sudo apt-get install autoconf automake libtool curl make g++ unzip
$ sudo ./autogen.sh
$ sudo ./configure
$ sudo make -j8
$ sudo make check
$ sudo sudo make install
$ sudo sudo ldconfig #refresh shared library cache.

实例演示
首先,定义下面的test.proto文件
message Info{
    required string name = 1;
    optional int32   age = 2;
}
message是protobuf中定义的数据结构;
1)    reuqied关键字表示这个参数必须包含在消息体中(如果用optional关键字来定义这个参数,那表示该参数可以缺省)
2)    string是参数Info的数据类型
3)    name是参数名称
4)    =1表示name是该消息体的第1个参数


定义proto文件之后需要用protobuf提供的编译工具将proto文件编译成不同语言的源码,此处使用C++。
protoc -I=./ --cpp_out=./ test.proto
将会生成两个文件, test.pb.h 和test.pb.cc;按照C++习惯我们把test.pb.cc文件更名为test.pb.cpp

编写C++源代码进行测试
/* helloproto.cpp */
#include <stdio.h>
#include <iostream>
#include <iomanip>
#include <string>
#include "test.pb.h"
using namespace std;

int main() {
    int length = 0;
    /* 首先设置各字段的value,然后序列化 */
    Info *pinfo = new Info();
    pinfo->set_name("testname");
    pinfo->set_age(655384);
    cout << "info.name=" << pinfo->name() << ", age=" << hex << pinfo->age() << endl;
    length = pinfo->ByteSize();
    uint8_t *buf = new uint8_t[length];
    pinfo->SerializeToArray(buf, length); /* 序列化 */

    for (int i = 0; i < length; i++)
    {
        printf("%02X(%c) ", buf[i], buf[i]);
        /* cout << hex << buf[i] << " "; */
    }
    cout << endl; 

    /* 首先解序列化,然后获取各字段的value; */
    Info *pinfo2 = new Info();
    pinfo2->ParseFromArray(buf, length);
    cout << pinfo2->name() << endl;
    cout << pinfo2->age()  << endl;

    delete buf;
    delete pinfo;
    delete pinfo2;
    return 0;
}

编译
# 首先确定libprotobuf.so的位置
$ which protoc
#/usr/local/bin/protoc
$ sudo find /usr/ -name libprotobuf.so
#/usr/local/lib/libprotobuf.so

$ g++ helloproto.cpp test.pb.cpp -L /usr/local/lib/ -lprotobuf -pthread -o helloproto
$ ./helloproto

参考资料
https://developers.google.com/protocol-buffers/docs/cpptutorial
https://www.jianshu.com/p/419efe983cb2

相关资讯

    暂无相关的资讯...

共有访客发表了评论 网友评论

验证码: 看不清楚?
    -->