Protobuf的介紹和使用

一辩棒、介紹

Protocol Buffers(簡稱Protobuf) 贞绳，是Google出品的序列化框架，與開發(fā)語言無關(guān)操骡，和平臺(tái)無關(guān)九火，具有良好的可擴(kuò)展性。Protobuf和所有的序列化框架一樣册招，都可以用于數(shù)據(jù)存儲(chǔ)岔激、通訊協(xié)議。

Protobuf支持生成代碼的語言包括Java是掰、Python鹦倚、C++、Go冀惭、JavaNano震叙、Ruby、C#,官網(wǎng)地址是https://developers.google.com/protocol-buffers/散休。

Portobuf的序列化的結(jié)果體積要比XML媒楼、JSON小很多，XML和JSON的描述信息太多了戚丸，導(dǎo)致消息要大划址；此外Portobuf還使用了Varint 編碼，減少數(shù)據(jù)對(duì)空間的占用限府。

Portobuf序列化和反序列化速度比XML夺颤、JSON快很多，是直接把對(duì)象和字節(jié)數(shù)組做轉(zhuǎn)換胁勺，而XML和JSON還需要構(gòu)建成XML或者JSON對(duì)象結(jié)構(gòu)世澜。

二、快速開始

2.1 安裝Protobuf

本文使用的是Windows版本的Protobuf編譯器署穗，版本號(hào)是3.1.0寥裂。下載地址：https://github.com/google/protobuf/releases，注意選擇protoc-3.1.0-win32.zip案疲。

下載完畢后封恰，將其解壓到磁盤英文路徑下，例如d:/protobuf褐啡，里面有bin和include兩個(gè)目錄诺舔。

配置環(huán)境變量，點(diǎn)擊【計(jì)算機(jī)】-【屬性】-【高級(jí)系統(tǒng)設(shè)置】-【環(huán)境變量】备畦，找到并編輯PATH低飒，在尾巴上增加d:/protobuf/bin;。

驗(yàn)證萍恕，打開cmd窗口逸嘀，輸入protoc --version，會(huì)看到版本信息：libprotoc 3.1.0允粤。否則就是環(huán)境變量沒有配置正確崭倘。

Protobuf編譯器對(duì)應(yīng)序列化理論中的IDL Compiler。*

2.2 編寫proto文件

我們需要編寫proto文件类垫，定義程序中需要處理的結(jié)構(gòu)化數(shù)據(jù)司光，在protobuf中，結(jié)構(gòu)化數(shù)據(jù)被稱為 Message悉患。proto 文件非常類似java的pojo bean残家。我們創(chuàng)建了一個(gè)名為Person.proto的文件（txt文本），并在文件里描述了Person數(shù)據(jù)結(jié)構(gòu)售躁，一共有兩個(gè)屬性坞淮，分別是age和name茴晋。這里我們使用的protobuf語法是proto3，需要在第一行聲明回窘；否則诺擅，默認(rèn)使用proto2。

proto文件對(duì)應(yīng)序列化理論中的IDL(Interface description language啡直，接口描述語言)烁涌。

syntax="proto3"; 
option java_package = "org.serialization.protobuf.quickstart";   
option java_outer_classname = "PersonProtobuf";   
message Person  {   
  int32 age = 1;
  string name = 2;
}

2.3 編譯

使用portoc編譯器，把proto文件編譯成java程序酒觅，第一個(gè)參數(shù)java_out指定了生成程序的目錄撮执，第二個(gè)參數(shù)是Person.proto的位置。也可以使用portoc編譯器把proto文件編譯成其它語言的程序舷丹。把生成的java文件拷貝到自己的工程里就可以使用了抒钱。

protoc --java_out=./ Person.proto

2.4 序列化調(diào)用

本節(jié)描述如何調(diào)用portoc編譯器生成的java代碼實(shí)現(xiàn)序列化和反序列化，需要我們在工程中添加protobuf-java依賴依賴掂榔。

<dependency>
    <groupId>com.google.protobuf</groupId>
    <artifactId>protobuf-java</artifactId>
    <version>3.1.0</version>
</dependency>

調(diào)用的示例代碼如下继效，詳情參見注釋。

package org.serialization.protobuf.quickstart;

import com.google.protobuf.InvalidProtocolBufferException;

/**
 * 演示了使用Protobuf序列化和反序列化Person對(duì)象装获。
 */
public class Main {

    public static void main(String[] args) {

        //  序列化
        // 創(chuàng)建Person的Builder
        PersonProtobuf.Person.Builder personBuilder = 
                            PersonProtobuf.Person.newBuilder();
        // 設(shè)置Person的屬性
        personBuilder.setAge(18);
        personBuilder.setName("張三豐");
        // 創(chuàng)建Person
        PersonProtobuf.Person zhangsanfeng = personBuilder.build();
        // 序列化瑞信，byte[]可以被寫到磁盤文件，或者通過網(wǎng)絡(luò)發(fā)送出去穴豫。
        byte[] data = zhangsanfeng.toByteArray();
        System.out.println("serialization end.");


        // 反序列化凡简，byte[]可以讀文件或者讀取網(wǎng)絡(luò)數(shù)據(jù)構(gòu)建。
        System.out.println("deserialization begin.");
        try {
            PersonProtobuf.Person person = PersonProtobuf.Person.parseFrom(data);
            System.out.println(person.getAge());
            System.out.println(person.getName());
        } catch (InvalidProtocolBufferException e) {
            e.printStackTrace();
        }

    }
}

三精肃、關(guān)于Message

前文快速開始的例子非常簡單秤涩，現(xiàn)實(shí)中我們往往需要定義結(jié)構(gòu)更加復(fù)雜的Message，接下來我們看一下如何定義嵌套消息和import（引用）消息司抱。

3.1 嵌套消息

下面是一個(gè)嵌套消息的示例筐眷，并展示了枚舉、List习柠、Map等類型匀谣，編譯之后代碼都在一個(gè)類里，即Staffbuf资溃。

syntax = "proto3";
option java_package = "org.serialization.protobuf.advanced";
option java_outer_classname = "Staffbuf";
message Staff {
    int32 id = 1;
    string name = 2;
    string email = 3;

    // 枚舉示例
    enum PhoneType {
        MOBILE = 0;
        TELEPHONE = 1;
    }
    
    // 嵌套示例
    message PhoneNumber {
        string number = 1;
        PhoneType type = 2;

    }
    
    // list示例
    repeated PhoneNumber phone = 4;
        
    message Map {
        string key = 1;
        int32 value = 2;
    }

    // map示例
    Map map = 5;
}

調(diào)用示例

構(gòu)造Staff的時(shí)候武翎，需要先構(gòu)建嵌套消息PhoneNumber。

public static void main(String[] args) {

    //  序列化
    // 創(chuàng)建Staff的Builder
    Staffbuf.Staff.Builder staffBuilder = Staffbuf.Staff.newBuilder();
    staffBuilder.setId(1);
    staffBuilder.setName("張三豐");
    //staffBuilder.setEmail("zhangsanfeng@wudang.org");

    // 構(gòu)建嵌套消息PhoneNumber
    List list = new ArrayList();
    Staffbuf.Staff.PhoneNumber.Builder phoneBuilder = 
                        Staffbuf.Staff.PhoneNumber.newBuilder();
    phoneBuilder.setType(Staffbuf.Staff.PhoneType.TELEPHONE);
    phoneBuilder.setNumber("010-12345678");
    Staffbuf.Staff.PhoneNumber phoneNumber = phoneBuilder.build();
    list.add(phoneNumber);
    phoneBuilder.clear();
    //phoneBuilder.setType(Staffbuf.Staff.PhoneType.MOBILE);
    phoneBuilder.setNumber("13912345678");
    list.add(phoneBuilder.build());

    // 構(gòu)建Map
    Staffbuf.Staff.Map.Builder mapBuilder = Staffbuf.Staff.Map.newBuilder();
    mapBuilder.setKey("a");
    mapBuilder.setValue(100);

    staffBuilder.addAllPhone(list);
    staffBuilder.setMap(mapBuilder);
    Staffbuf.Staff zhangsanfeng = staffBuilder.build();
    // 序列化溶锭，byte[]可以被寫到磁盤文件宝恶，或者通過網(wǎng)絡(luò)發(fā)送出去。
    byte[] data = zhangsanfeng.toByteArray();
    System.out.println("serialization end.");


    // 反序列化，byte[]可以讀文件或者讀取網(wǎng)絡(luò)數(shù)據(jù)構(gòu)建垫毙。
    System.out.println("deserialization begin.");
    try {
        Staffbuf.Staff staff = Staffbuf.Staff.parseFrom(data);
        System.out.println(staff.getName());
        staff.getPhoneList().forEach( x -> System.out.println(x.toString()));
    } catch (InvalidProtocolBufferException e) {
        e.printStackTrace();
    }

}

3.2 引入消息 Import Message

Porto引入消息霹疫，和java import類是很相似的。一些公共的消息內(nèi)容综芥，可能會(huì)單獨(dú)定義在一個(gè)porto文件中更米，之后被其它的porto文件引用。我們首先定義一個(gè)PhoneNumberBuf.proto文件毫痕，然后定義一個(gè)Staff.porto文件來引用它。兩個(gè)porto文件都需要編譯迟几，每個(gè)文件會(huì)生成java代碼消请。

PhoneNumberBuf.proto

syntax="proto3"; 
option java_package = "org.serialization.protobuf.imported";   
option java_outer_classname = "PhoneNumberBuf";   
message PhoneNumber  {   
   string number = 1; 
  
  // 枚舉示例
  enum PhoneType { 
    MOBILE = 0; 
    TELEPHONE = 1; 
  }
   PhoneType type = 2;
 
}

Staff.porto

syntax="proto3"; 
import "PhoneNumberbuf.proto"; // 引入消息
option java_package = "org.serialization.protobuf.imported";   
option java_outer_classname = "Staffbuf";   
message Staff  {   
  int32 id = 1;
  string name = 2;
  string email = 3;
    
  // 引入的消息類型
  repeated PhoneNumber phone = 4;

}