Google Protocol Buffer入門實戰（附原始碼）

Google Protocol Buffer（後面簡稱PB）是Google開源的一款二進位制序列化工具，佔用空間小，傳輸效率高。最近由於專案中使用到了PB，所以特地學習了PB，這篇文章也是自己學習PB的一些小結。

根據官方定義，PB是一個語言中立，平臺中立的，用於序列化結構化資料的協議。

說到序列化，可能大家最容易想到的是JDK自帶的序列化協議，使用PB而不使用自帶的序列化協議主要基於以下幾點考慮：

• 佔用空間希望儘可能小
• 傳輸效率儘可能高
• 跨平臺

那麼，JDK自帶的序列化就不能滿足需求了，而且PB將資料序列化成二進位制資料，大大降低空間佔用。PB的優勢主要體現在以下幾點：

• 更簡單
• 降低3-10倍的佔用空間
• 20至100倍的速度提升
• 低侵入性
• 更易於程式設計的資料訪問類

PB入門實戰

使用PB也是極其簡單的，首先需要定義一個字尾為.proto的檔案，然後使用PB編譯器生成資料訪問類，使用PB的API讀寫資料。需要下載PB編譯器執行編譯，然後在IDE中下載PB外掛。

以IntelliJ IDEA為例，可以安裝Google Protocol Buffers support外掛，在Plugins欄目中選擇Browse repositories，在搜尋框中搜索Google Protocol Buffers support，出現下圖，點選安裝，之後重啟IDEA就可以了。

建立Maven工程，配置PB編譯器的安裝路徑（文後有下載地址）：

pom.xml依賴檔案：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 

    <modelVersion>4.0.0</modelVersion>

    <groupId>com.rhwayfun</groupId>
    <artifactId>protocol-buffer-demo</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>
        <dependency>
            <groupId>com.google.protobuf</groupId>
            <artifactId>protobuf-java</artifactId>
            <version>2.5.0</version>
        </dependency>
    </dependencies>
</project>

安裝之後就需要編寫.proto的檔案了，作為示例，程式碼如下：

package com.rhwayfun.demo;

message Person {
    required string name = 1;
    required int32 id = 2;
    optional string email = 3;

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

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

    repeated PhoneNumber phone = 4;
}

因為是Maven工程，因此需要配置PB編譯器的編譯路徑，在IDEA中配置如下：

使用PB編譯器編譯後的結果如下：

// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: PersonMessage.proto

package com.rhwayfun.demo;

public final class PersonMessage {
  private PersonMessage() {}
  public static void registerAllExtensions(
      com.google.protobuf.ExtensionRegistry registry) {
  }
  public interface PersonOrBuilder extends
      // @@protoc_insertion_point(interface_extends:com.rhwayfun.demo.Person)
      com.google.protobuf.MessageOrBuilder {

    /**
     * <code>required string name = 1;</code>
     */
    boolean hasName();
    /**
     * <code>required string name = 1;</code>
     */
    java.lang.String getName();
    /**
     * <code>required string name = 1;</code>
     */
    com.google.protobuf.ByteString
        getNameBytes();

    /**
     * <code>required int32 id = 2;</code>
     */
    boolean hasId();
    /**
     * <code>required int32 id = 2;</code>
     */
    int getId();

    /**
     * <code>optional string email = 3;</code>
     */
    boolean hasEmail();
    /**
     * <code>optional string email = 3;</code>
     */
    java.lang.String getEmail();

    // 此處省略其他程式碼

編寫測試程式碼如下：

package com.rhwayfun.demo;

import org.junit.Test;

import static org.junit.Assert.*;

/**
 * @Description: PersonOuterClassTest
 * @author: ZhongCB
 * @date: 2016/08/09
 */
public class PersonMessageTest {

    @Test
    public void testMakeInstance(){
        PersonMessage.Person person = PersonMessage.Person.newBuilder().setId(1)
                .setEmail("[email protected]")
                .setName("rhwayfun").build();
        assertEquals(person.getName(), "rhwayfun");
        assertEquals(person.getEmail(), "[email protected]");
    }
}

最後的執行結果如下：

附原始碼和PB編譯器下載地址：下載地址