Protobuf簡介
Protocol Buffer是google 的一種數(shù)據(jù)交換的格式偷溺,已經(jīng)在Github開源蜗细,目前最新版本是3.1.0。它獨立于語言蹭劈,獨立于平臺。google 提供了多種語言的實現(xiàn):Java线召、C#铺韧、C++、Go 和 Python,Objective-C缓淹,每一種實現(xiàn)都包含了相應(yīng)語言的編譯器以及庫文件哈打。由于它是一種二進制的格式,比使用 XML 進行數(shù)據(jù)交換快許多讯壶×险蹋可以把它用于分布式應(yīng)用之間的數(shù)據(jù)通信或者異構(gòu)環(huán)境下的數(shù)據(jù)交換。作為一種效率和兼容性都很優(yōu)秀的二進制數(shù)據(jù)傳輸格式伏蚊,可以用于諸如網(wǎng)絡(luò)傳輸立轧、配置文件、數(shù)據(jù)存儲等諸多領(lǐng)域。
說明
- protobuf3.0.0以上才官方支持Objective-C氛改,低于3.0.0的請忽略或使用第三方轉(zhuǎn)換工具
- 開發(fā)環(huán)境:32bit & 64bit iOS, 64bit OS X帐萎,Xcode7.0+
- 基于性能原因沒有使用ARC,但可以被ARC代碼調(diào)用
步驟
- 轉(zhuǎn)換:將我們編寫好的XXX.proto文件轉(zhuǎn)成Objective C文件平窘,也就是XXX.h和XXX.m文件吓肋,轉(zhuǎn)換的工具是使用protoc這種二進制文件來生成的,這文件需要自己生成瑰艘,稍后會介紹如何使用它來轉(zhuǎn)換Objective-C文件
- 集成:如果在iOS項目中加入protobuf庫以及步驟1生成的OC文件
轉(zhuǎn)換
生成protoc
如果沒有裝autoconf automake libtool需要先裝這幾個是鬼,這里使用brew來安裝,在shell執(zhí)行 brew install autoconf automake libtool即可紫新,如果沒有brew請自行先安裝brew均蜜。
下載面向Objective-C的protobuf庫,地址為(https://github.com/google/protobuf/releases),要下載對應(yīng)Objective-C的版本比如 protobuf-objectivec-3.1.0.zip芒率,解壓囤耳。
cd到下載的目錄,依次執(zhí)行:
- $ ./autogen.sh
- $ ./configure
- $ make
- $ make check
- $ sudo make install
再執(zhí)行
- objectivec/DevTools/full_mac_build.sh
執(zhí)行完后會看到src目錄下生成了protoc二進制文件
使用protoc轉(zhuǎn)換
創(chuàng)建proto文件,比如Person.proto
syntax = "proto3";
message Person
{
int32 age = 1;
string username = 2;
string phone = 3;
}
需要注意的是要指明proto的語法規(guī)則是proto2還是proto3偶芍。
在src目錄(protoc所在目錄)執(zhí)行
protoc --proto_path=... --objc_out=... XXX.proto
其中proto_path是我們創(chuàng)建的proto文件所在目錄充择,objc_out為Objective-C文件輸出路徑,XXX.proto是我們創(chuàng)建的proto文件,可以一次轉(zhuǎn)換多個proto文件匪蟀,加在XXX.proto后面即可椎麦。
舉例:我們在src目錄下新建兩個文件夾,gen和protocols文件夾材彪,gen為輸出目錄观挎,protocols用于存放proto文件,將創(chuàng)建的Person.proto放在protocols文件夾下段化,執(zhí)行命令
protoc --proto_path=protocols --objc_out=gen protocols/Person.proto
然后在gen文件夾下就會生成Person.pbobjc.h和Person.pbobjc.m文件嘁捷。
集成
將生成的Ojective-C文件(上面例子的Person.pbobjc.h和Person.pbobjc.m)放到項目中,如果項目使用了ARC,要將.m(例子的Person.pbobjc.m)的Complier Flags設(shè)為-fno-objc-arc显熏。(protobuf基于性能原因沒有使用ARC)
加入protobuf庫雄嚣,有兩種方式
-
第一種是使用CocoaPods集成
- 使用CocoaPods集成,有一個現(xiàn)成的pod可以使用–Protobuf,可以pod search Protobuf搜索查看詳情佃延,pod內(nèi)容為
platform :ios, '7.1' pod 'Protobuf', '~> 3.1.0'
需要注意的是 platform :ios, '7.1'
7.1及以上才能導(dǎo)入這個庫,這種方式優(yōu)點是操作簡單现诀,缺點是platform :ios, '7.1' 要7.1或以上 -
第二種是把相關(guān)文件拖入項目中。
- 拖入相關(guān)文件到項目中履肃,將objectivec文件夾下的所有的.h文件和.m文件(除了GPBProtocolBuffers.m)(GPB開頭的那些文件)以及整個google文件夾add到項目中仔沿,如果項目中使用了ARC需要將以上所有.m文件的的Complier Flags設(shè)為-fno-objc-arc。這種方法的優(yōu)點是靈活性強尺棋,沒有7.1的束縛封锉。缺點是操作麻煩點绵跷,如果用了ARC的話還要手動添加-fno-objc-arc(使用CocoaPods集成會自動添加)
簡單使用
直接上代碼
- (void)viewDidLoad {
[super viewDidLoad];
Person *person = [[Person alloc] init];
person.age = 100;
person.username = @"huang";
person.phone = @"10086";
NSData *data = [person data];
Person *p = [Person parseFromData:data error:nil];
NSLog(@"person:%@",p);
}