深入剖析ProtoBuf原理與工程實(shí)踐

ProtoBuf 作為一種跨平臺(tái)、語言無關(guān)、可擴(kuò)展的序列化結(jié)構(gòu)數(shù)據(jù)的方法，已廣泛應(yīng)用于網(wǎng)絡(luò)數(shù)據(jù)交換及存儲(chǔ)。隨著互聯(lián)網(wǎng)的發(fā)展，系統(tǒng)的異構(gòu)性會(huì)愈發(fā)突出，跨語言的需求會(huì)愈加明顯，同時(shí) gRPC 也大有取代Restful之勢(shì)，而 ProtoBuf 作為g RPC 跨語言、高性能的法寶，我們技術(shù)人有必要

深入理解 ProtoBuf 原理，為以后的技術(shù)更新和選型打下基礎(chǔ)。

我將過去的學(xué)習(xí)過程以及實(shí)踐經(jīng)驗(yàn)，總結(jié)成系列文章，與大家一起探討學(xué)習(xí)，希望大家能有所收獲，當(dāng)然其中有不正確的地方也歡迎大家批評(píng)指正。

一、什么是ProtoBuf

ProtoBuf(Protocol Buffers)是一種跨平臺(tái)、語言無關(guān)、可擴(kuò)展的序列化結(jié)構(gòu)數(shù)據(jù)的方法，可用于網(wǎng)絡(luò)數(shù)據(jù)交換及存儲(chǔ)。

在序列化結(jié)構(gòu)化數(shù)據(jù)的機(jī)制中，ProtoBuf是靈活、高效、自動(dòng)化的，相對(duì)常見的XML、JSON，描述同樣的信息，ProtoBuf序列化后數(shù)據(jù)量更小、序列化/反序列化速度更快、更簡(jiǎn)單。

一旦定義了要處理的數(shù)據(jù)的數(shù)據(jù)結(jié)構(gòu)之后，就可以利用ProtoBuf的代碼生成工具生成相關(guān)的代碼。只需使用 Protobuf 對(duì)數(shù)據(jù)結(jié)構(gòu)進(jìn)行一次描述，即可利用各種不同語言(proto3支持C++, Java, Python, Go, Ruby, Objective-C, C#)或從各種不同流中對(duì)你的結(jié)構(gòu)化數(shù)據(jù)輕松讀寫。

二、為什么是 ProtoBuf

大家可能會(huì)覺得 Google 發(fā)明 ProtoBuf 是為了解決序列化速度的，其實(shí)真實(shí)的原因并不是這樣的。

ProtoBuf最先開始是 Google用來解決索引服務(wù)器 request/response 協(xié)議的。沒有ProtoBuf之前，Google 已經(jīng)存在了一種 request/response 格式，用于手動(dòng)處理 request/response 的編解碼。它也能支持多版本協(xié)議，不過代碼不夠優(yōu)雅：

if(protocolVersion=1){
doSomething();
}elseif(protocolVersion=2){
doOtherThing();
}...

如果是非常明確的格式化協(xié)議，會(huì)使新協(xié)議變得非常復(fù)雜。因?yàn)殚_發(fā)人員必須確保請(qǐng)求發(fā)起者與處理請(qǐng)求的實(shí)際服務(wù)器之間的所有服務(wù)器都能理解新協(xié)議，然后才能切換開關(guān)以開始使用新協(xié)議。

這也就是每個(gè)服務(wù)器開發(fā)人員都遇到過的低版本兼容、新舊協(xié)議兼容相關(guān)的問題。

為了解決這些問題，于是ProtoBuf就誕生了。

ProtoBuf 最初被寄予以下 2 個(gè)特點(diǎn)：

• 更容易引入新的字段，并且不需要檢查數(shù)據(jù)的中間服務(wù)器可以簡(jiǎn)單地解析并傳遞數(shù)據(jù)，而無需了解所有字段。
• 數(shù)據(jù)格式更加具有自我描述性，可以用各種語言來處理(C++, Java 等各種語言)。

這個(gè)版本的 ProtoBuf 仍需要自己手寫解析的代碼。

不過隨著系統(tǒng)慢慢發(fā)展，演進(jìn)，ProtoBuf具有了更多的特性：

• 自動(dòng)生成的序列化和反序列化代碼避免了手動(dòng)解析的需要。（官方提供自動(dòng)生成代碼工具，各個(gè)語言平臺(tái)的基本都有）。
• 除了用于數(shù)據(jù)交換之外，ProtoBuf被用作持久化數(shù)據(jù)的便捷自描述格式。

ProtoBuf 現(xiàn)在是 Google 用于數(shù)據(jù)交換和存儲(chǔ)的通用語言。谷歌代碼樹中定義了 48162 種不同的消息類型，包括 12183 個(gè) .proto 文件。它們既用于 RPC 系統(tǒng)，也用于在各種存儲(chǔ)系統(tǒng)中持久存儲(chǔ)數(shù)據(jù)。

ProtoBuf 誕生之初是為了解決服務(wù)器端新舊協(xié)議(高低版本)兼容性問題，名字也很體貼，“協(xié)議緩沖區(qū)”。只不過后期慢慢發(fā)展成用于傳輸數(shù)據(jù)。

Protocol Buffers 命名由來：

Why the name "Protocol Buffers"?

The name originates from the early days of the format, before we had the protocol buffer compiler to generate classes for us. At the time, there was a class called ProtocolBuffer which actually acted as a buffer for an individual method. Users would add tag/value pairs to this buffer individually by calling methods like AddValue(tag, value). The raw bytes were stored in a buffer which could then be written out once the message had been constructed.

Since that time, the "buffers" part of the name has lost its meaning, but it is still the name we use. Today, people usually use the term "protocol message" to refer to a message in an abstract sense, "protocol buffer" to refer to a serialized copy of a message, and "protocol message object" to refer to an in-memory object representing the parsed message.

三、如何使用 ProtoBuf

3.1 ProtoBuf 協(xié)議的工作流程

可以看到，對(duì)于序列化協(xié)議來說，使用方只需要關(guān)注業(yè)務(wù)對(duì)象本身，即 idl 定義，序列化和反序列化的代碼只需要通過工具生成即可。

3.2 ProtoBuf 消息定義

ProtoBuf 的消息是在idl文件(.proto)中描述的。下面是本次樣例中使用到的消息描述符customer.proto：

syntax="proto3";

packagedomain;

optionjava_package="com.protobuf.generated.domain";
optionjava_outer_classname="CustomerProtos";

messageCustomers{
repeatedCustomercustomer=1;
}

messageCustomer{
int32id=1;
stringfirstName=2;
stringlastName=3;

enumEmailType{
PRIVATE=0;
PROFESSIONAL=1;
}

messageEmailAddress{
stringemail=1;
EmailTypetype=2;
}

repeatedEmailAddressemail=5;
}

上面的消息比較簡(jiǎn)單，Customers包含多個(gè)Customer，Customer包含一個(gè)id字段，一個(gè)firstName字段，一個(gè)lastName字段以及一個(gè)email的集合。

除了這些定義外，文件頂部還有三行可幫助代碼生成器：

1. 首先，syntax = "proto3"用于idl語法版本，目前有兩個(gè)版本proto2和proto3，兩個(gè)版本語法不兼容，如果不指定，默認(rèn)語法是proto2。由于proto3比proto2支持的語言更多，語法更簡(jiǎn)潔，本文使用的是proto3。

2. 其次有一個(gè)package domain;定義。此配置用于嵌套生成的類/對(duì)象。

3. 有一個(gè)option java_package定義。生成器還使用此配置來嵌套生成的源。此處的區(qū)別在于這僅適用于Java。在使用Java創(chuàng)建代碼和使用JavaScript創(chuàng)建代碼時(shí)，使用了兩種配置來使生成器的行為有所不同。也就是說，Java類是在包c(diǎn)om.protobuf.generated.domain下創(chuàng)建的，而JavaScript對(duì)象是在包domain下創(chuàng)建的。

ProtoBuf 提供了更多選項(xiàng)和數(shù)據(jù)類型，本文不做詳細(xì)介紹，感興趣可以參考這里^[1]。

3.3 代碼生成

首先安裝 ProtoBuf 編譯器 protoc，這里^[2]有詳細(xì)的安裝教程，安裝完成后，可以使用以下命令生成 Java 源代碼：

protoc--java_out=./src/main/java./src/main/idl/customer.proto

從項(xiàng)目的根路徑執(zhí)行該命令，并添加了兩個(gè)參數(shù)：java_out，定義./src/main/java/為Java代碼的輸出目錄；而./src/main/idl/customer.proto是.proto文件所在目錄。

生成的代碼非常復(fù)雜，但是幸運(yùn)的是它的用法卻非常簡(jiǎn)單。

CustomerProtos.Customer.EmailAddressemail=CustomerProtos.Customer.EmailAddress.newBuilder()
.setType(CustomerProtos.Customer.EmailType.PROFESSIONAL)
.setEmail("crichardson@email.com").build();

CustomerProtos.Customercustomer=CustomerProtos.Customer.newBuilder()
.setId(1)
.setFirstName("Lee")
.setLastName("Richardson")
.addEmail(email)
.build();
//序列化
byte[]binaryInfo=customer.toByteArray();
System.out.println(bytes_String16(binaryInfo));
System.out.println(customer.toByteArray().length);
//反序列化
CustomerProtos.CustomeranotherCustomer=CustomerProtos.Customer.parseFrom(binaryInfo);
System.out.println(anotherCustomer.toString());

3.4 性能數(shù)據(jù)

我們簡(jiǎn)單地以Customers為模型，分別構(gòu)造、選取小對(duì)象、普通對(duì)象、大對(duì)象進(jìn)行性能對(duì)比。

序列化耗時(shí)以及序列化后數(shù)據(jù)大小對(duì)比

反序列化耗時(shí)

更多性能數(shù)據(jù)可以參考官方 Benchmark^[3]

四、總結(jié)

上面介紹了 ProtoBuf 是什么、產(chǎn)生的背景、基本用法，我們?cè)倏偨Y(jié)下。

優(yōu)點(diǎn)：

1. 效率高

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

//我們簡(jiǎn)單做個(gè)對(duì)比
//要描述如下JSON數(shù)據(jù)
{"id":1,"firstName":"Chris","lastName":"Richardson","email":[{"type":"PROFESSIONAL","email":"crichardson@email.com"}]}
#使用JSON序列化后的數(shù)據(jù)大小為118byte
7b226964223a312c2266697273744e616d65223a224368726973222c226c6173744e616d65223a2252696368617264736f6e222c22656d61696c223a5b7b2274797065223a2250524f46455353494f4e414c222c22656d61696c223a226372696368617264736f6e40656d61696c2e636f6d227d5d7d
#而使用ProtoBuf序列化后的數(shù)據(jù)大小為48byte
0801120543687269731a0a52696368617264736f6e2a190a156372696368617264736f6e40656d61696c2e636f6d1001

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

2. 支持跨平臺(tái)、多語言

ProtoBuf是平臺(tái)無關(guān)的，無論是Android與PC，還是C#與Java都可以利用ProtoBuf進(jìn)行無障礙通訊。

proto3支持C++, Java, Python, Go, Ruby, Objective-C, C#。

3. 擴(kuò)展性、兼容性好

具有向后兼容的特性，更新數(shù)據(jù)結(jié)構(gòu)以后，老版本依舊可以兼容，這也是ProtoBuf誕生之初被寄予解決的問題。因?yàn)榫幾g器對(duì)不識(shí)別的新增字段會(huì)跳過不處理。

4. 使用簡(jiǎn)單

ProtoBuf 提供了一套編譯工具，可以自動(dòng)生成序列化、反序列化的樣板代碼，這樣開發(fā)者只要關(guān)注業(yè)務(wù)數(shù)據(jù)idl，簡(jiǎn)化了編碼解碼工作以及多語言交互的復(fù)雜度。

缺點(diǎn)

可讀性差，缺乏自描述

XML，JSON是自描述的，而ProtoBuf則不是。

ProtoBuf是二進(jìn)制協(xié)議，編碼后的數(shù)據(jù)可讀性差，如果沒有idl文件，就無法理解二進(jìn)制數(shù)據(jù)流，對(duì)調(diào)試不友好。

不過Charles已經(jīng)支持ProtoBuf協(xié)議，導(dǎo)入數(shù)據(jù)的描述文件即可，詳情可參考Charles Protocol Buffers^[4]。

此外，由于沒有idl文件無法解析二進(jìn)制數(shù)據(jù)流，ProtoBuf在一定程度上可以保護(hù)數(shù)據(jù)，提升核心數(shù)據(jù)被破解的門檻，降低核心數(shù)據(jù)被盜爬的風(fēng)險(xiǎn)。