簡介
Google Protocol Buffer( 簡稱 Protobuf) 是 Google 公司內(nèi)部的混合語言數(shù)據(jù)標(biāo)準(zhǔn)窃蹋，目前已經(jīng)正在使用的有超過 48,162 種報文格式定義和超過 12,183 個 .proto 文件馆里。他們用于 RPC 系統(tǒng)和持續(xù)數(shù)據(jù)存儲系統(tǒng)始苇。
Protocol Buffers 是一種輕便高效的結(jié)構(gòu)化數(shù)據(jù)存儲格式寓免，可以用于結(jié)構(gòu)化數(shù)據(jù)串行化产喉，或者說序列化努释。它很適合做數(shù)據(jù)存儲或 RPC 數(shù)據(jù)交換格式夹姥。可用于通訊協(xié)議儡陨、數(shù)據(jù)存儲等領(lǐng)域的語言無關(guān)褪子、平臺無關(guān)、可擴展的序列化結(jié)構(gòu)數(shù)據(jù)格式骗村。目前提供了 C++嫌褪、Java、Python 三種語言的 API
Protobuf 的優(yōu)點
Protobuf 有如 XML胚股，不過它更小笼痛、更快、也更簡單琅拌。你可以定義自己的數(shù)據(jù)結(jié)構(gòu)缨伊，然后使用代碼生成器生成的代碼來讀寫這個數(shù)據(jù)結(jié)構(gòu)。你甚至可以在無需重新部署程序的情況下更新數(shù)據(jù)結(jié)構(gòu)进宝。只需使用 Protobuf 對數(shù)據(jù)結(jié)構(gòu)進(jìn)行一次描述刻坊，即可利用各種不同語言或從各種不同數(shù)據(jù)流中對你的結(jié)構(gòu)化數(shù)據(jù)輕松讀寫。
它有一個非常棒的特性即彪，即“向后”兼容性好紧唱，人們不必破壞已部署的、依靠“老”數(shù)據(jù)格式的程序就可以對數(shù)據(jù)結(jié)構(gòu)進(jìn)行升級隶校。這樣您的程序就可以不必?fù)?dān)心因為消息結(jié)構(gòu)的改變而造成的大規(guī)模的代碼重構(gòu)或者遷移的問題漏益。因為添加新的消息中的 field 并不會引起已經(jīng)發(fā)布的程序的任何改變。
Protobuf 語義更清晰深胳，無需類似 XML 解析器的東西（因為 Protobuf 編譯器會將 .proto 文件編譯生成對應(yīng)的數(shù)據(jù)訪問類以對 Protobuf 數(shù)據(jù)進(jìn)行序列化绰疤、反序列化操作）。
使用 Protobuf 無需學(xué)習(xí)復(fù)雜的文檔對象模型舞终，Protobuf 的編程模式比較友好轻庆，簡單易學(xué)癣猾，同時它擁有良好的文檔和示例，對于喜歡簡單事物的人們而言余爆，Protobuf 比其他的技術(shù)更加有吸引力纷宇。具體借鑒網(wǎng)上分享與JSON，XML等比較的測試結(jié)果圖蛾方，具體如下：
序列化數(shù)據(jù)對比
bytes字節(jié)數(shù)對比
Protobuf 的不足
Protbuf 與 XML 相比也有不足之處像捶。它功能簡單，無法用來表示復(fù)雜的概念桩砰。
XML 已經(jīng)成為多種行業(yè)標(biāo)準(zhǔn)的編寫工具拓春，Protobuf 只是 Google 公司內(nèi)部使用的工具，在通用性上還差很多亚隅。
由于文本并不適合用來描述數(shù)據(jù)結(jié)構(gòu)硼莽，所以 Protobuf 也不適合用來對基于文本的標(biāo)記文檔（如 HTML）建模。另外煮纵，由于 XML 具有某種程度上的自解釋性懂鸵，它可以被人直接讀取編輯，在這一點上 Protobuf 不行行疏，它以二進(jìn)制的方式存儲矾瑰，除非你有 .proto 定義，否則你沒法直接讀出 Protobuf 的任何內(nèi)容
在Android Studio配置google protobuf
在project的build.gradle中配置
buildscript {
repositories {
jcenter()
mavenCentral()
}
dependencies {
classpath 'com.android.tools.build:gradle:2.2.3'
classpath 'com.google.protobuf:protobuf-gradle-plugin:0.8.0'
}
}
注意 Gradle版本至少是 2.12 并且Java 7隘擎，本例子使用的是2.2.3，protobuf-gradle-plugin使用最新的0.8.0版本凉夯。
在app的build.gradle中配置
頂部添加protobuf插件
apply plugin: 'com.google.protobuf'
android{
...
android結(jié)點增加proto文件位置配置
sourceSets {
main {
proto {
srcDir 'src/main/proto'
include '**/*.proto'
}
java {
srcDir 'src/main/java'
}
}
}
}
添加依賴
dependencies {
...
compile 'com.google.protobuf:protobuf-java:3.1.0'
compile 'com.google.protobuf:protoc:3.1.0'
}
增加protobuf結(jié)點
protobuf {
protoc {
artifact = 'com.google.protobuf:protoc:3.1.0'
}
generateProtoTasks {
all().each { task ->
task.builtins {
remove java
}
task.builtins {
java {}
// Add cpp output without any option.
// DO NOT omit the braces if you want this builtin to be added.
cpp {}
}
}
}
generatedFilesBaseDir = "$projectDir/src/generated"
}
java端配置ProtoBuf
下載Protocol Buffers
在官方地址或者maven倉庫中下載即可货葬。
通過.proto文件生成對應(yīng)的.java/.h/.cc等文件
然后cmd cd到該目錄 執(zhí)行protoc.exe --java_out=./ book.proto，此時在這個目錄下回生成BookOuterClass.java文件
在java客戶端
序列化：
BookOuterClass.Book book=BookOuterClass.Book.newBuilder()
.setId(1)
.setDesc("codeBook")
.setName("Prime")
.build();
byte [] value = p.toByteArray()
反序列化：
BookOuterClass.Book book=BookOuterClass.Book.parseFrom(value);
在JAVA中如何使用生成的數(shù)據(jù)模型
protobuf與java type區(qū)分
proto描述文件的編寫
-
語法
3.5的語法跟以前的protobuf語法有很大的變化劲够，詳細(xì)的可以參考官方文檔震桶，
地址：https://developers.google.com/protocol-buffers/docs/proto3這里有一個中文翻譯的文檔
地址：http://blog.csdn.net/u011518120/article/details/54604615
例子
//syntax = "proto2";//聲明proto版本，2.0與3.0以后語法差異很大
syntax = "proto3";
option java_package = "com.crf.jason.myapplication";
package bean;
message Book {
// required int32 id = 1;//Proto 2.0版本征绎，需要聲明requires蹲姐、optional等
// required string name = 2;
// optional string desc = 3;
int32 id = 1;//Proto 3.0版本，不需要聲明requires人柿、optional等
string name = 2;
string desc = 3;
}
注意：
- 頂部必須申明句法的版本號柴墩，如果不申明，則默認(rèn)是2.0的語法凫岖。
- 下面Message節(jié)里面的字段就是業(yè)務(wù)需要的各個字段了江咳，等號后面的數(shù)字是序號，必須指定哥放。在3.5版本中不用指定required歼指、等關(guān)鍵字了爹土。如果有需要使用2.0版本，具體參數(shù)的含義具體如下：
- required：一個格式良好的消息一定要含有1個這種字段踩身。表示該值是必須要設(shè)置的胀茵；
- optional：消息格式中該字段可以有0個或1個值（不超過1個）
- repeated：在一個格式良好的消息中砂客，這種字段可以重復(fù)任意多次（包括0次）正罢。重復(fù)的值的順序會被保留。表示該值可以重復(fù)择同，相當(dāng)于java中的List
- Book 的名稱格式與為生成的java文件的名稱是有關(guān)系的赁濒。當(dāng)然你也可以在文件里自定義java文件的名稱
-
生成的java代碼中的的builder還是按照默認(rèn)格式來生成的轨奄，所以，建議大家就直接按照默認(rèn)規(guī)則來設(shè)計即可拒炎。 此外挪拟，還可以指定改java代碼的包路徑，命令如下：option java_package = "com.crf.jason.myapplication";（Android studio環(huán)境）
image
在Android項目中使用
上述第四點可見击你，通過.proto文件會在debug目錄生成對應(yīng)的java或者cpp文件玉组，這個文件就是我們用來處理服務(wù)端的響應(yīng)轉(zhuǎn)變成我們需要的java類，具體如下：
BookOuterClass.Book book=BookOuterClass.Book.parseFrom(out.toByteArray());
在java端使用
具體參考：Google官網(wǎng)的開發(fā)者文檔
Google官方例子：
syntax = "proto2";
package tutorial;
option java_package = "com.example.tutorial";
option java_outer_classname = "AddressBookProtos";
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 phones = 4;
}
message AddressBook {
repeated Person people = 1;
}