Protobuf在ios上的使用

標籤：google   ios   戴維營   

戴維營教育原創文章，轉載請註明出處。我們的夢想是做最好的iOS開發培訓！

介紹

在不同平台通訊的時候，首先需要將對象進行序列化。iOS平台上我們常用NSKeyedArchiver進行歸檔，當然也可以將資料處理為JSON或者XML格式。NSKeyedArchiver只能在iOS/Mac平台使用，因此它歸檔的位元據不適合於在不同平台之間使用。JSON和XML雖然由於容易維護，易讀而應用比較廣泛，但是對資料的利用效率都不是高。Google提出了 Protocol Buffers 作為一種跨平台、語言無關的序列化資料格式。Protocol Buffers提供代碼產生工具，能夠根據定義好的資料格式產生不同語言的代碼，然後整合到項目中使用。Protocol Buffers目前有兩種格式：proto2和proto3。Protocol Buffers支援Java、Python、C++、Objective-C等代碼的產生。

準備工作

1. 下載Protocol Buffers的源碼()，也可以到官網上下載。

2. 編譯Protocol Buffers。雖然我們是可以直接將它的代碼或者項目引入Xcode中，但是還是需要編譯重要的代碼產生工具（protoc）。由於Protocol Buffers編譯時間使用了autoconf/automake/libtool等UNIX工具，Mac可能沒有內建，需要手動安裝。我們可以使用HomeBrew或者MacPort進行安裝(二選一就行)。

• 使用 HomeBrew 安裝:

  $ brew install autoconf  $ brew install automake  $ brew install libtool

• 使用 MacPort 安裝:

  $ sudo port install autoconf automake libtool

README.md中說可以直接用./configure進行配置並編譯運行了，但實際還差一步，就是運行./autogen.sh指令碼，否則會發生錯誤。然而遺憾的是，autogen.sh中會下載https://googlemock.googlecode.com/files/gmock-1.7.0.zip。gmock處於 牆外 ，只能用梯子出去取（沒梯子的可以找 戴維營教育 交流群免費索取，會不會被請喝茶啊）。

沒有運行autogen.sh的情境：

$ ./configure --with-protoc=protoc$ ./configure: line 2215: syntax error near unexpected token ‘enable‘$ ./configure: line 2215: ‘AM_MAINTAINER_MODE(enable)‘

一旦開啟VPN了，運行下面的指令碼：

$ ./autogen.sh$ ./configure$ make# 如果希望安裝protoc，執行下面的命令$ make install

iOS中使用Protocol Buffers

1. 建立 proto 檔案指定資料格式，可以選擇proto2和proto3格式，它們有些細微的區別，在產生代碼的時候會提示的，具體情況查看文檔Language Guide proto3。下面使用proto3格式，並且儲存為Person.proto。

syntax = "proto3";message Person {  string name = 1;  int32 uid = 2;  string email = 3;  enum PhoneType {    MOBILE = 0;    HOME = 1;    WORK = 2;  }  message PhoneNumber {    string number = 1;    PhoneType type = 2;  }  repeated PhoneNumber phone = 4;}

1. 使用 protoc 工具產生Objective-C代碼。其中--proto_path=後跟需要處理的proto檔案所在的檔案夾，--objc_out=指明產生的是Objective-C代碼以及目標檔案存放路徑，最後是需要處理的檔案。

$ protoc --proto_path=. --objc_out=. Person.proto$ lsPerson.pbobjc.h Person.pbobjc.m Person.proto

處理完成後，產生兩個檔案，分別是 Person.pbobjc.h 和 Person.pbobjc.m 。這兩個檔案是採用的手動引用計數，因此在加入項目後需要設定它們的編譯參數。

650) this.width=650;" src="http://io.diveinedu.com/images/objc/protobuf_3.png" />

1. 為了方便管理，我們直接將Protocol Buffers中的iOS靜態庫項目引入進來。當然，如果喜歡用C++的話，可以直接將C++代碼匯入項目，記得設定 Header Search Paths 或者 User Header Search Paths 。

650) this.width=650;" src="http://io.diveinedu.com/images/objc/protobuf_1.png" />

設定依賴和串連庫。

650) this.width=650;" src="http://io.diveinedu.com/images/objc/protobuf_2.png" />

1. 引入標頭檔開始使用。

#import "GPBProtocolBuffers.h"#import "Person.pbobjc.h"- (void)viewDidLoad {    [super viewDidLoad];    Person *person = [[Person alloc] init];    person.name = @"Zhangsan";    person.email = @"[email protected]";    person.uid = 23;    NSData *data = [person data];    NSString *path = @"/Users/apple/Desktop/test.data";    [data writeToFile:path atomically:YES];    NSData *ldata = [NSData dataWithContentsOfFile:path];    Person *p = [Person parseFromData:ldata error:nil];    NSLog(@"\nname:%@\nemail:%@\nuid:%d", p.name, p.email, p.uid);}

列印結果如下：

2015-12-02 13:09:46.890 ProtobufDemo[34761:150533]name:Zhangsanemail:[email protected]uid:23

1. Protocol Buffer效率測試 我們這裡說的效率是指空間佔用率。簡單和JSON格式比較一下，同樣是儲存下面的資訊：

name: Zhangsanemail: [email protected]uid: 23

採用Protocol Buffers的資料大小為30個位元組。而實用JSON儲存時，儘管我們將Key變成一個位元組，如下：

NSDictionary *dict = @{@"n":@"Zhangsan",                       @"e":@"[email protected]",                       @"u":@23};NSData *jd = [NSJSONSerialization dataWithJSONObject:dict options:0 error:nil];NSLog(@"jd: %lu", jd.length);

JSON資料還是佔了46個位元組，並且隨著可讀性提高，效率更低。XML就更不用說了。

總結

如果希望獲得更好的的可讀性，可以選用JSON和XML這類文字格式設定。但如果從資料效率上將，Protocol Buffer是一個不錯的選擇。儲存效率高，並且proto檔案的可讀性和可維護性都比較強。

戴維營學院（進階開發視頻）: http://v.diveinedu.com

潛心俱樂部（iOS面試必備）: http://divein.club

650) this.width=650;" src="http://io.diveinedu.com/images/qrcode-diveinedu-mp-weixin.jpg" style="width:200px;height:200px;" />

Protobuf在ios上的使用