Protobuf簡介
Protocol Buffer是google 的一種數(shù)據(jù)交換的格式叁怪,已經(jīng)在Github開源审葬,目前最新版本是3.1.0。它獨(dú)立于語言奕谭,獨(dú)立于平臺(tái)涣觉。google 提供了多種語言的實(shí)現(xiàn):Java、C#血柳、C++官册、Go 和 Python,Objective-C,每一種實(shí)現(xiàn)都包含了相應(yīng)語言的編譯器以及庫文件难捌。由于它是一種二進(jìn)制的格式膝宁,比使用 XML 進(jìn)行數(shù)據(jù)交換快許多「酰可以把它用于分布式應(yīng)用之間的數(shù)據(jù)通信或者異構(gòu)環(huán)境下的數(shù)據(jù)交換员淫。作為一種效率和兼容性都很優(yōu)秀的二進(jìn)制數(shù)據(jù)傳輸格式,可以用于諸如網(wǎng)絡(luò)傳輸击敌、配置文件介返、數(shù)據(jù)存儲(chǔ)等諸多領(lǐng)域。
說明
protobuf3.0.0以上才官方支持Objective-C愚争,低于3.0.0的請(qǐng)忽略或使用第三方轉(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這種二進(jìn)制文件來生成的,這文件需要自己生成鞍陨,稍后會(huì)介紹如何使用它來轉(zhuǎn)換Objective-C文件
- 集成:如果在iOS項(xiàng)目中加入protobuf庫以及步驟1生成的OC文件
轉(zhuǎn)換
生成protoc
如果沒有裝autoconf automake libtool需要先裝這幾個(gè)步淹,這里使用brew來安裝从隆,在shell執(zhí)行 brew install autoconf automake libtool即可,如果沒有brew請(qǐng)自行先安裝brew缭裆。
下載面向Objective-C的protobuf庫键闺,地址為(https://github.com/google/protobuf/releases),要下載對(duì)應(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í)行完后會(huì)看到src目錄下生成了protoc二進(jìn)制文件
使用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)換多個(gè)proto文件,加在XXX.proto后面即可内边。
舉例:我們?cè)趕rc目錄下新建兩個(gè)文件夾榴都,gen和protocols文件夾,gen為輸出目錄漠其,protocols用于存放proto文件嘴高,將創(chuàng)建的Person.proto放在protocols文件夾下,執(zhí)行命令
protoc --proto_path=protocols --objc_out=gen protocols/Person.proto
然后在gen文件夾下就會(huì)生成Person.pbobjc.h和Person.pbobjc.m文件和屎。
集成
將生成的Ojective-C文件(上面例子的Person.pbobjc.h和Person.pbobjc.m)放到項(xiàng)目中拴驮,如果項(xiàng)目使用了ARC,要將.m(例子的Person.pbobjc.m)的Complier Flags設(shè)為-fno-objc-arc。(protobuf基于性能原因沒有使用ARC)
加入protobuf庫眶俩,有兩種方式
- 第一種是使用CocoaPods集成
使用CocoaPods集成莹汤,有一個(gè)現(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)入這個(gè)庫,這種方式優(yōu)點(diǎn)是操作簡單颠印,缺點(diǎn)是platform :ios, ‘7.1’ 要7.1或以上
- 第二種是把相關(guān)文件拖入項(xiàng)目中。
拖入相關(guān)文件到項(xiàng)目中抹竹,將objectivec文件夾下的所有的.h文件和.m文件(除了GPBProtocolBuffers.m)(GPB開頭的那些文件)以及整個(gè)google文件夾add到項(xiàng)目中线罕,如果項(xiàng)目中使用了ARC需要將以上所有.m文件的的Complier Flags設(shè)為-fno-objc-arc。這種方法的優(yōu)點(diǎn)是靈活性強(qiáng)窃判,沒有7.1的束縛钞楼。缺點(diǎn)是操作麻煩點(diǎn),如果用了ARC的話還要手動(dòng)添加-fno-objc-arc(使用CocoaPods集成會(huì)自動(dòng)添加),記得添加User Header Search Paths為$(PROJECT_DIR)/項(xiàng)目名/后接文件地址 不然頭文件會(huì)報(bào)錯(cuò)
簡單使用
直接上代碼
- (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);
}
附加 Homebrew 安裝地址:https://brew.sh/index_zh-cn.html
原文地址