一、介紹

Protocol Buffers(簡稱Protobuf) ，是Google出品的序列化框架，與開發語言無關，和平臺無關，具有良好的可擴展性。Protobuf和所有的序列化框架一樣，都可以用于數據存儲、通訊協議。

Protobuf支持生成代碼的語言包括Java、Python、C++、Go、JavaNano、Ruby、C#,官網地址是https://developers.google.com/protocol-buffers/。

Portobuf的序列化的結果體積要比XML、JSON小很多，XML和JSON的描述信息太多了，導致消息要大；此外Portobuf還使用了Varint 編碼，減少數據對空間的占用。

Portobuf序列化和反序列化速度比XML、JSON快很多，是直接把對象和字節數組做轉換，而XML和JSON還需要構建成XML或者JSON對象結構。

二、快速開始

2.1 安裝Protobuf

本文使用的是Windows版本的Protobuf編譯器，版本號是3.1.0。下載地址：https://github.com/google/protobuf/releases，注意選擇protoc-3.1.0-win32.zip。

下載完畢后，將其解壓到磁盤英文路徑下，例如d:/protobuf，里面有bin和include兩個目錄。

配置環境變量，點擊【計算機】-【屬性】-【高級系統設置】-【環境變量】，找到并編輯PATH，在尾巴上增加d:/protobuf/bin;。

驗證，打開cmd窗口，輸入protoc --version，會看到版本信息：libprotoc 3.1.0。否則就是環境變量沒有配置正確。

• Protobuf編譯器對應序列化理論中的IDL Compiler。*

2.2 編寫proto文件

我們需要編寫proto文件，定義程序中需要處理的結構化數據，在protobuf中，結構化數據被稱為 Message。proto 文件非常類似java的pojo bean。我們創建了一個名為Person.proto的文件（txt文本），并在文件里描述了Person數據結構，一共有兩個屬性，分別是age和name。這里我們使用的protobuf語法是proto3，需要在第一行聲明；否則，默認使用proto2。

proto文件對應序列化理論中的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程序，第一個參數java_out指定了生成程序的目錄，第二個參數是Person.proto的位置。也可以使用portoc編譯器把proto文件編譯成其它語言的程序。把生成的java文件拷貝到自己的工程里就可以使用了。

protoc --java_out=./ Person.proto

2.4 序列化調用

本節描述如何調用portoc編譯器生成的java代碼實現序列化和反序列化，需要我們在工程中添加protobuf-java依賴依賴。

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

調用的示例代碼如下，詳情參見注釋。

package org.serialization.protobuf.quickstart;

import com.google.protobuf.InvalidProtocolBufferException;

/**
 * 演示了使用Protobuf序列化和反序列化Person對象。
 */
public class Main {

    public static void main(String[] args) {

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


        // 反序列化，byte[]可以讀文件或者讀取網絡數據構建。
        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();
        }

    }
}

三、關于Message

前文快速開始的例子非常簡單，現實中我們往往需要定義結構更加復雜的Message，接下來我們看一下如何定義嵌套消息和import（引用）消息。

3.1 嵌套消息

下面是一個嵌套消息的示例，并展示了枚舉、List、Map等類型，編譯之后代碼都在一個類里，即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;
}

調用示例

構造Staff的時候，需要先構建嵌套消息PhoneNumber。

public static void main(String[] args) {

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

    // 構建嵌套消息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());

    // 構建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[]可以被寫到磁盤文件，或者通過網絡發送出去。
    byte[] data = zhangsanfeng.toByteArray();
    System.out.println("serialization end.");


    // 反序列化，byte[]可以讀文件或者讀取網絡數據構建。
    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類是很相似的。一些公共的消息內容，可能會單獨定義在一個porto文件中，之后被其它的porto文件引用。我們首先定義一個PhoneNumberBuf.proto文件，然后定義一個Staff.porto文件來引用它。兩個porto文件都需要編譯，每個文件會生成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;

}

調用示例

public static void main(String[] args) {

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

    // 構建引用消息（import message）PhoneNumber
    List list = new ArrayList();
    PhoneNumberBuf.PhoneNumber.Builder phoneBuilder =
                      PhoneNumberBuf.PhoneNumber.newBuilder();
    phoneBuilder.setType(PhoneNumberBuf.PhoneNumber.PhoneType.TELEPHONE);
    phoneBuilder.setNumber("010-12345678");
    PhoneNumberBuf.PhoneNumber phoneNumber = phoneBuilder.build();
    list.add(phoneNumber);
    phoneBuilder.clear();
    phoneBuilder.setType(PhoneNumberBuf.PhoneNumber.PhoneType.MOBILE);
    phoneBuilder.setNumber("13912345678");
    list.add(phoneBuilder.build());
    staffBuilder.addAllPhone(list);
    // 完成staff的構建
    Staffbuf.Staff zhangsanfeng = staffBuilder.build();
    // 序列化，byte[]可以被寫到磁盤文件，或者通過網絡發送出去。
    byte[] data = zhangsanfeng.toByteArray();
    System.out.println("serialization end.");



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

}

3.3 DynamicMessage

ProtoBuf中還支持動態消息，我們可以使用DynamicMessage和Descriptor把數據從byte[]或者InputStream中反序列化出來。

// 服務端可以維護一個Map，從Map中獲取Staff這個Message，然后再獲取Descriptor。
Descriptors.Descriptor descriptor = Staffbuf.Staff.getDescriptor();
DynamicMessage msg = DynamicMessage.parseFrom(descriptor,data);
// 之后再通過反射的方式把DynamicMessage轉換成Staff

（完）