Python使用ProtoBuffer

时间：2022-09-21 06:14:26

Python使用ProtoBuffer

Protocol Buffers，是Google公司开发的一种数据描述语言，类似于XML能够将结构化数据序列化，可用于数据存储、通信协议等方面。

就可读性而言感觉没有JSON直接，不过由于使用二进制传输，效率得到大大提升，用在RPC比较合适

1. 安装

在Ubuntu下非常方便

pip install protobuf    # 安装protobuf库

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

2. 定义数据类型

syntax = "proto2";

package demo; // 申明包，防止命名冲突

// message类似于class,用于定义一个数据结构

// message之间可以相互嵌套

message Person{

    required string name = 1; // 1,2,3是字段的标识符

    required int32 id = 2;

    optional string email = 3;

    enum PhoneType {

        MOBILE = 1;

        HOME = 2;

        WORK = 3;

    }

    message PhoneNumber {

        required string number = 1;

        optional PhoneType type = 2 [default = HOME];

    }

    // 修饰符:required表示必须有，optional表示可选

    // repeated表示可有多个(包括０个)

    repeated PhoneNumber phones = 4;

}

message AdressBook {

    required Person people = 1;

}

3.编译

# 通用格式

protoc -I=$SRC_DIR --python_out=$DST_DIR $SRC_DIR/addressbook.proto

# 这里，我们直接在当前目录编译

protoc --python_out=./ ./addressbook.proto

结果会在目标地址下生成addressbook_pb2.py

4. 文件写入

# coding=utf-8

import addressbook_pb2

address_book = addressbook_pb2.AdressBook()

#### person1 ###

p1 = address_book.people.add()

p1.name = "Jack"

p1.id = 20

p1.email = "jack@qq.com"

phone_num1 = p1.phones.add()

phone_num1.number = "123"

phone_num1.type = 2  # 与默认类型不同

phone_num2 = p1.phones.add()

phone_num2.number = "456"

print(p1)

### person2 ###

p2 = address_book.people.add()

p2.name = "Chen"

p2.id = 21

# 遍历，输出repeated类型的成员

for phone in p1.phones:

    print(phone.type)

# 保存到二进制文件

f = open("address.pb", "wb")

f.write(address_book.SerializeToString()) # 调用串行化接口

f.close()

运行输出

name: "Jack"

id: 20

email: "jack@qq.com"

phones {

  number: "123"

  type: HOME

}

phones {

  number: "456"

}

2

3

5.　文件读取

# coding=utf-8

import addressbook_pb2

f = open("address.pb", "rb")

address_book = addressbook_pb2.AdressBook()

address_book.ParseFromString(f.read())

f.close()

for person in address_book.people:

    print(person.name)

运行输出

Jack

Chen

6.小结

protobuffer用二进制来传输，性能应该会有提升．但是双方都要保留一份编译后的pb2文件，相当于协议，感觉稍重稍复杂

相关文章