[[414951]]

本文轉載自微信公眾號「程序新視界」，作者二師兄。轉載本文請聯系程序新視界公眾號。

我們通常習慣用Json、XML等形式的數據存儲格式，但相信還有很多人沒有聽說過Protocol Buffer(簡稱protobuf)。protobuf是Google開源的一個語言無關、平臺無關的通信協議，其小巧、高效和友好的兼容性設計，使其被廣泛使用。性能比Json、XML真的強太多了!

而且，隨著微服務架構的流行，RPC框架也成為服務框架的重要組成部分。在很多RPC的設計中，都采用了高性能的編解碼技術，而protobuf就屬于其中的佼佼者。

也就說，要想深入了解微服務架構中的RPC環節底層實現，設計出高效的傳輸、序列化、編碼解碼等功能，學習protobuf的使用和原理非常有必要。

protobuf簡介

protobuf是一種序列化對象框架(或者說是編解碼框架)。它有兩部分功能組成：結構化數據(數據存儲結構)和序列化&反序列化。

其中數據存儲結構的作用與XML、JSON相似;序列化和反序列化的作用與Java自帶的序列化、Facebook的Thrift和JBoss Marshalling等相似。

總之：protobuf是通過定義結構化數據，并提供對數據的序列化和反序列化功能，從而實現數據存儲/RPC數據交換的功能。

它的特點是：

• 語言無關、平臺無關
• 簡潔
• 高性能(序列化速度快 & 序列化后的數據體積小)
• 良好的兼容性

可以通過數據直觀的看一下不同框架在序列化響應時間上的對比：

protobuf

可以看出，protobuf的性能要遠高于其他框架。

protobuf的使用流程

上面介紹了protobuf的功能，但僅僅知道這些功能我們無法知道它是怎么使用的?？戳司W上很多的文章，要么直接開始寫代碼要么直接開始分析報文格式，對于新手來說往往會一頭霧水。

所以，我們先來梳理一下使用protobuf的步驟。

protobuf

在上圖中將protobuf的使用分了四個步驟：

• 步驟一，搭建環境：使用protobuf要定義通信的數據結構，并編譯生成不同的編程語言代碼，這就需要有這么一個編譯器的環境。
• 步驟二，構建數據：使用protobuf是要傳輸數據的，那么數據包含什么，有哪些項目，整個結構層次是什么樣子的。這里基于protobuf的語法來進行數據結構的定義。
• 步驟三，項目集成：集成pom依賴(Java為例)、集成編譯的Java類(對照proto文件);
• 步驟四，具體使用：通過集成進來的Java類，來構建消息、賦值，然后基于protobuf進行序列化，接收方進行反序列化操作;

了解了上述步驟，下面就針對具體的步驟來進行實戰演示。

這里演示基于Mac OS操作系統和Java編程語言來進行操作。如果你使用的是其他操作系統和編程語言，基本思路一樣，在不同的步驟時可針對性的找一下具體操作。

安裝Protocol Buffers

安裝protobuf是為了進行數據結構的定義和對應編程語言代碼的生成。通常有兩種方式：本地安裝和IDE插件。我們先來看本地安裝。

protobuf的代碼是托管在GitHub上的，對應地址為：https://github.com/protocolbuffers/protobuf 。

點擊項目右邊的release鏈接可看到對應版本：https://github.com/protocolbuffers/protobuf/releases 。

protobuf

這里包含了各種編程語言、環境的版本。本文選protobuf-java-3.17.3.zip版本。

在Mac操作系統下，需要先安裝一下依賴組件，才能夠對protobuf進行編譯和安裝。

安裝依賴組件：

// 安裝 Protocol Buffer依賴 
// 注：Protocol Buffer依賴于autoconf、automake、libtool、curl 
brew install autoconf automake libtool curl 

解壓protobuf-java-3.17.3.zip，進入根目錄，執行以下命令：

// 運行autogen.sh腳本 
./autogen.sh 
 
// 運行configure.sh腳本 
./configure 
  
// 編譯未編譯的依賴包 
make 
  
// 檢查依賴包是否完整 
make check 
  
// 開始安裝Protocol Buffer 
make install 

安裝完成，檢驗版本：

$protoc --version 
libprotoc 3.14.0 

輸出版本信息，說明安裝成功。

這里的protoc命令就是Protocol Buffer的編譯器，可以將 .proto文件編譯成對應平臺的頭文件和源代碼文件。

另外一種方式就是安裝IDE插件，這里以IDEA為例，搜索插件：

protobuf

關于protobuf的插件比較多，選擇適合自己就行。

然后gRPC官方推薦了一種更優雅的使用姿勢，可以通過maven輕松搞定(需安裝上圖中的“Protobuf Support”插件)。也就是引入grpc的一些組件，然后在maven的build中進行配置，編譯proto文件成為Java代碼。此種方式暫時不展開，后續可直接看項目集成部分的源代碼。

構建數據

在Java中，如果通過JSON來傳輸一個數據，我們首先要定義一個對象，這里以Person為例：

public class Person { 
    private String name; 
    private Integer id; 
    // ... getter/setter 
} 

那么，如果用protobuf來定義Person這個對象的數據結構是什么樣呢?

先創建一個person.proto文件，然后定義如下的結構：

syntax = "proto3"; // 聲明為protobuf 3定義文件 
package tutorial; 
 
option java_package = "com.choupangxia.protobuf.message"; // 聲明生成消息類的java包路徑 
option java_outer_classname = "Person";  // 聲明生成消息類的類名 
 
message PersonProto { 
    string name = 1; 
    int32 id = 2; 
} 

上面每項語法的具體說明可參看注釋部分。當然Person的結構可以更豐富，這里只是出于演示需要，做了最簡單的示例，更多語法可參看官方文檔。

編譯protot文件

定義完成之后，我們可以通過兩種方式來生成目標Java類。這里先采用本機安裝的編譯器來進行操作。

執行protoc命令之前，可先執行-h命令來查看protoc的使用說明：

protoc -h 

進入person.proto文件所在目錄，執行以下命令進行編譯：

protoc --java_out=../java ./person.proto 

--java_out參數指定了Java類的輸出路徑，第二個參數執行的要編譯的文件為當前目錄下的person.proto文件。

執行命令，會發現com.choupangxia.protobuf.message下生成了名為Person的類。注意proto中定義的message名稱不要與Java類名重復，否則會出現命令執行失敗的狀況。

對應的Person類比較復雜，甚至有一些語法層面的錯誤或改進，如果需要，進行對應的改進優化即可。

protobuf

上圖為生成的Person類的部分結構。比如上面的java.lang.String getName()這個方法的返回值就可以進行優化，不用指定String的package。

項目集成

其實上面講生成的Person代碼放入項目，已經算是項目集成的一部分了。如果未引入protobuf的依賴，上面的代碼還是會報錯的。

Maven項目的pom文件中添加protobuf依賴：

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

如果想通過IDEA直接編譯proto文件，需安裝“Protobuf Support”插件，還需引入grpc的依賴，完整依賴如下：

<properties> 
    <grpc.version>1.6.1</grpc.version> 
    <protobuf.version>3.17.3</protobuf.version> 
</properties> 
 
<dependencies> 
    <dependency> 
        <groupId>com.google.protobuf</groupId> 
        <artifactId>protobuf-java</artifactId> 
        <version>${protobuf.version}</version> 
    </dependency> 
    <!-- 編譯使用部分 --> 
    <dependency> 
        <groupId>io.grpc</groupId> 
        <artifactId>grpc-netty</artifactId> 
        <version>${grpc.version}</version> 
        <scope>provided</scope> 
    </dependency> 
    <dependency> 
        <groupId>io.grpc</groupId> 
        <artifactId>grpc-protobuf</artifactId> 
        <version>${grpc.version}</version> 
        <scope>provided</scope> 
    </dependency> 
    <dependency> 
        <groupId>io.grpc</groupId> 
        <artifactId>grpc-stub</artifactId> 
        <version>${grpc.version}</version> 
        <scope>provided</scope> 
    </dependency> 
</dependencies> 
<build> 
    <extensions> 
        <extension> 
            <groupId>kr.motd.maven</groupId> 
            <artifactId>os-maven-plugin</artifactId> 
            <version>1.5.0.Final</version> 
        </extension> 
    </extensions> 
    <plugins> 
        <plugin> 
            <groupId>org.xolstice.maven.plugins</groupId> 
            <artifactId>protobuf-maven-plugin</artifactId> 
            <version>0.5.0</version> 
            <configuration> 
                <protocArtifact>com.google.protobuf:protoc:${protobuf.version}:exe:${os.detected.classifier}</protocArtifact> 
                <pluginId>grpc-java</pluginId> 
                <pluginArtifact>io.grpc:protoc-gen-grpc-java:${grpc.version}:exe:${os.detected.classifier}</pluginArtifact> 
            </configuration> 
            <executions> 
                <execution> 
                    <goals> 
                        <goal>compile</goal> 
                        <goal>compile-custom</goal> 
                    </goals> 
                </execution> 
            </executions> 
        </plugin> 
    </plugins> 
</build> 

在執行執行maven compile命令進行編譯之前，將需要編譯的proto文件放在與src/main/java同級目錄下的/src/main/proto目錄。

protobuf

此時將生成的Java復制到對應的包下即可。

業務應用

一切準備就緒，現在就來寫個例子使用對應的代碼了。

public class Test { 
 
    public static void main(String[] args) throws InvalidProtocolBufferException { 
        Person.PersonProto sourcePersonProto = Person.PersonProto.newBuilder().setId(123).setName("Tom").build(); 
 
        // 序列化 
        byte[] binaryInfo = sourcePersonProto.toByteArray(); 
        System.out.println("序列化字節碼內容：" + Arrays.toString(binaryInfo)); 
        System.out.println("序列化字節碼長度：" + binaryInfo.length); 
 
        System.out.println("-----------以下為接收方反序列化操作-------------"); 
        // 反序列化 
        Person.PersonProto targetPersonProto = Person.PersonProto.parseFrom(binaryInfo); 
 
        System.out.println("反序列化結果：" + targetPersonProto.toString()); 
    } 
} 

上述代碼就是基于生成的Person類的基本使用。首先通過，Person類中的內部類和Builder方法進行參數的封裝，然后調用其toByteArray方法，即可將報文信息進行序列化。接收方呢，有同樣的一套代碼，先獲得Person.PersonProto對象，然后執行parseFrom方法即可進行反序列化操作。

為什么protobuf比較高效

單從序列化后的數據體積角度來分析。與XML、JSON這類文本協議相比，ProtoBuf通過T-(L)-V(TAG-LENGTH-VALUE)方式編碼，不需要", {, }, :等分隔符來結構化信息。同時在編碼層面使用varint壓縮，所以描述同樣的信息，protobuf序列化后的體積要小很多，在網絡中傳輸消耗的網絡流量更少，進而對于網絡資源緊張、性能要求非常高的場景，ProtoBuf協議是不錯的選擇。

做一個簡單直觀的例子：

{"id":1,"firstName":"Chris","lastName":"Richardson","email":[{"type":"PROFESSIONAL","email":"aicchrrdson@email.com"}]} 

對于上面的JSON數據，使用JSON序列化后的數據大小為118byte，而使用protobuf序列化后的數據大小為48byte。如果數據量更多，層次結構更復雜，差距還是很明顯的。

從序列化/反序列化速度角度，與XML、JSON相比，protobuf序列化/反序列化的速度更快，比XML要快20-100倍。

但protobuf是基于二進制的協議，編碼后的數據可讀性差，如果沒有idl文件，就無法理解二進制數據流，對調試不友好。

小結

本文帶大家從0到1學習了protobuf的使用步驟。很多文章之所以看不懂，就是因為沒有梳理清楚使用protobuf的整個核心邏輯。只要掌握了如何搭建環境、如何編寫數據結構、如何編譯、如何集成到項目中并運用。那么，protobuf的其他知識點逐步在實踐中補充即可。

隨著微服務的不斷發展，RPC框架為了追求高效的通信，使用像protobuf這類框架也必然是趨勢。也是想更好的學習微服務架構的底層的必備知識。 

本文源碼：https://github.com/secbr/protobuf-demo