iOS 集成Protobuf,轉換proto文件
原文地址：http://blog.csdn.net/hyq4412/article/details/54891038
附加Homebrew安裝地址：https://brew.sh/index_zh-cn.html
Protobuf簡介
Protocol Buffer是google 的一種數據交換的格式，已經在Github開源，目前最新版本是3.1.0。它獨立於語言，獨立於平臺。google 提供了多種語言的實現：Java、C#、C++、Go 和 Python,Objective-C，每一種實現都包含了相應語言的編譯器以及庫文件。由於它是一種二進制的格式，比使用 XML 進行數據交換快許多。可以把它用於分布式應用之間的數據通信或者異構環境下的數據交換。作為一種效率和兼容性都很優秀的二進制數據傳輸格式，可以用於諸如網絡傳輸、配置文件、數據存儲等諸多領域。
說明
- protobuf3.0.0以上才官方支持Objective-C，低於3.0.0的請忽略或使用第三方轉換工具
- 開發環境：32bit & 64bit iOS, 64bit OS X，Xcode7.0+
- 基於性能原因沒有使用ARC，但可以被ARC代碼調用
步驟
- 轉換：將我們編寫好的XXX.proto文件轉成Objective C文件，也就是XXX.h和XXX.m文件，轉換的工具是使用protoc這種二進制文件來生成的，這文件需要自己生成，稍後會介紹如何使用它來轉換Objective-C文件
- 集成：如果在iOS項目中加入protobuf庫以及步驟1生成的OC文件
轉換
生成protoc
如果沒有裝autoconf automake libtool需要先裝這幾個，這裏使用brew來安裝，在shell執行 brew install autoconf automake libtool即可，如果沒有brew請自行先安裝brew。
下載面向Objective-C的protobuf庫，地址為(https://github.com/google/protobuf/releases),要下載對應Objective-C的版本比如 protobuf-objectivec-3.1.0.zip，解壓。
cd到下載的目錄,依次執行：
- $ ./autogen.sh
- $ ./configure
- $ make
- $ make check
- $ sudo make install
再執行
- objectivec/DevTools/full_mac_build.sh
執行完後會看到src目錄下生成了protoc二進制文件
使用protoc轉換
創建proto文件，比如Person.proto
syntax = "proto3";
message Person
{
int32 age = 1;
string username = 2;
string phone = 3;
}- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 1
- 2
- 3
- 4
- 5
- 6
- 7
需要註意的是要指明proto的語法規則是proto2還是proto3。
在src目錄(protoc所在目錄)執行
protoc --proto_path=... --objc_out=... XXX.proto- 1
- 1
其中proto_path是我們創建的proto文件所在目錄，objc_out為Objective-C文件輸出路徑,XXX.proto是我們創建的proto文件，可以一次轉換多個proto文件，加在XXX.proto後面即可。
舉例：我們在src目錄下新建兩個文件夾，gen和protocols文件夾，gen為輸出目錄，protocols用於存放proto文件，將創建的Person.proto放在protocols文件夾下，執行命令
protoc --proto_path=protocols --objc_out=gen protocols/Person.proto- 1
- 1
然後在gen文件夾下就會生成Person.pbobjc.h和Person.pbobjc.m文件。
集成
將生成的Ojective-C文件（上面例子的Person.pbobjc.h和Person.pbobjc.m）放到項目中，如果項目使用了ARC,要將.m（例子的Person.pbobjc.m）的Complier Flags設為-fno-objc-arc。（protobuf基於性能原因沒有使用ARC）
加入protobuf庫，有兩種方式
-
第一種是使用CocoaPods集成
- 使用CocoaPods集成，有一個現成的pod可以使用–Protobuf,可以pod search Protobuf搜索查看詳情，pod內容為
platform :ios, ‘7.1‘ pod ‘Protobuf‘, ‘~> 3.1.0‘- 1
- 2
- 1
- 2
需要註意的是 platform :iOS, ‘7.1’
7.1及以上才能導入這個庫,這種方式優點是操作簡單，缺點是platform :ios, ‘7.1’ 要7.1或以上 - 使用CocoaPods集成，有一個現成的pod可以使用–Protobuf,可以pod search Protobuf搜索查看詳情，pod內容為
-
第二種是把相關文件拖入項目中。
- 拖入相關文件到項目中，將objectivec文件夾下的所有的.h文件和.m文件（除了GPBProtocolBuffers.m）(GPB開頭的那些文件)以及整個google文件夾add到項目中，如果項目中使用了ARC需要將以上所有.m文件的的Complier Flags設為-fno-objc-arc。這種方法的優點是靈活性強，沒有7.1的束縛。缺點是操作麻煩點，如果用了ARC的話還要手動添加-fno-objc-arc（使用CocoaPods集成會自動添加）,記得添加User Header Search Paths為$(PROJECT_DIR)/項目名/後接文件地址 不然頭文件會報錯
簡單使用
直接上代碼
- (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);
}- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
iOS 集成Protobuf,轉換proto文件