「Protocol_Buffer」之基本使用與格式定義

「Protocol Buffer」系列教程

1.「Protocol_Buffer」之基本使用與格式定義
2.「Protocol Buffer」之PB在HTTP協議中的應用

---

簡介

Protocol Buffers以下簡稱pb，是google開發的一個可以序列化 反序列化object的數據交換格式，類似於xml，但是比xml 更輕，更快，更簡單。而且以上的重點突出一個跨平臺，和xml json等數據序列化一樣，跨平臺跨語言。
是一個語言無關，平臺無關，可擴展的結構化數據序列化方案, 用於協議通訊, 數據存儲和其他更多用途.
如果需要進行深入學習點擊這裏

安裝

1.github:https://github.com/google/protobuf/releases 下載最新版本的對應語言的pb
2.下載完畢之後運行包中自帶config文件。
3.make&&make ×××tall。
4.進入python文件夾 
5.運行安裝命令
>  $ python setup.py build
>  $ python setup.py test

PB描述文件定義

PB的使用需要定義一個.proto文件，該文件裏面會定義號數據類型和格式。我在這裏就不再搬運各語言對應的字段，因爲這些官方文檔中都寫的非常清楚。這裏直接最典型的使用方法。

syntax = "proto3";

package people;

message Person {
    string name = 1;
    int32 id = 2;
    enum Gender {     //定義枚舉類型，每個枚舉定義必須包含一個映射到0的常量作爲它的第一個元素
        FEMALE = 0;
        MALE = 1;
    }
    Gender gender = 3;

    enum PhoneType {    //定義枚舉類型，每個枚舉定義必須包含一個映射到0的常量作爲它的第一個元素
        MOBILE = 0;
        HOME = 1;
        WORK = 2;
    }

    message PhoneNumber {     //定義嵌套消息類型
        string number = 1;
        PhoneType type = 2;
    }
    repeated PhoneNumber phones = 4;      //動態數組，構成元素的數據類型是上面定義的PhoneNumber
}

編譯

生成對應語言的描述文件

Python命令：
protoc -I=$SRC_DIR --python_out=$DST_DIR $SRC_DIR/people.proto
生成一個people_pb2.py文件
C++命令：
protoc -I=$SRC_DIR --cpp_out=$DST_DIR $SRC_DIR/ people.proto
生成people.pb.h和people.pb.cc文件
Java命令：
protoc -I=$SRC_DIR --java_out=$DST_DIR $SRC_DIR/ people.proto
每個message生成一個.java文件

Python+PB實例

這裏用python作爲演示，如何使用生成的python版的描述文件

from test_pb2 import Person

person = Person()

person.name = "xx.xxx"
person.id = 123456
person.gender = 1

#數組+嵌套類型的使用，元素1添加
phone1 = person.phones.add()
phone1.number = "654321"
phone1.type = 2

#數組+嵌套類型的使用，元素2添加
phone2 = person.phones.add()
phone2.number = "123456"
phone2.type = 1

#序列化
result = person.SerializeToString()

print(person)
print(result)

#反序列化
person = Person()
person.ParseFromString(result)
print(person)

運行結果如下
```python
$ python3 main.py 

#序列化前的結果
name: "xx.xxx"
id: 123456
gender: MALE
phones {
  number: "654321"
  type: WORK
}
phones {
  number: "123456"
  type: HOME
}

#序列化後的數據
b'\n\x06xx.xxx\x10\xc0\xc4\x07\x18\x01"\n\n\x06654321\x10\x02"\n\n\x06123456\x10\x01'

#反序列化後的數據
name: "xx.xxx"
id: 123456
gender: MALE
phones {
  number: "654321"
  type: WORK
}
phones {
  number: "123456"
  type: HOME
}

後續

這裏介紹了Protocol Buffer的基本用法，接下來會介紹PB如何與gRPC配合使用