Protobuf在ios上的使用

戴維營教育原創(chuàng)文章，轉(zhuǎn)載請注明出處。我們的夢想是做最好的iOS開發(fā)培訓(xùn)！

介紹

在不同平臺通信的時候，首先需要將對象進(jìn)行序列化。iOS平臺上我們常用NSKeyedArchiver進(jìn)行歸檔，當(dāng)然也可以將數(shù)據(jù)處理為JSON或者XML格式。NSKeyedArchiver只能在iOS/Mac平臺使用，因此它歸檔的二進(jìn)制數(shù)據(jù)不適合于在不同平臺之間使用。JSON和XML雖然由于容易維護(hù)，易讀而應(yīng)用比較廣泛，但是對數(shù)據(jù)的利用效率都不是高。Google提出了 Protocol Buffers 作為一種跨平臺、語言無關(guān)的序列化數(shù)據(jù)格式。Protocol Buffers提供代碼生成工具，能夠根據(jù)定義好的數(shù)據(jù)格式生成不同語言的代碼，然后集成到項目中使用。Protocol Buffers目前有兩種格式：proto2和proto3。Protocol Buffers支持Java、Python、C++、Objective-C等代碼的生成。

準(zhǔn)備工作

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

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

• 使用 HomeBrew 安裝:

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

• 使用 MacPort 安裝:

  $ sudo port install autoconf automake libtool

README.md中說可以直接用./configure進(jìn)行配置并編譯運(yùn)行了，但實際還差一步，就是運(yùn)行./autogen.sh腳本，否則會發(fā)生錯誤。然而遺憾的是，autogen.sh中會下載https://googlemock.googlecode.com/files/gmock-1.7.0.zip。gmock處于 墻外 ，只能用×××出去?。]×××的可以找 戴維營教育 交流群免費(fèi)索取，會不會被請喝茶?。?。

沒有運(yùn)行autogen.sh的場景：

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

一旦打開×××了，運(yùn)行下面的腳本：

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

iOS中使用Protocol Buffers

1. 創(chuàng)建 proto 文件指定數(shù)據(jù)格式，可以選擇proto2和proto3格式，它們有些細(xì)微的區(qū)別，在生成代碼的時候會提示的，具體情況查看文檔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代碼以及目標(biāo)文件存放路徑，最后是需要處理的文件。

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

處理完成后，生成兩個文件，分別是 Person.pbobjc.h 和 Person.pbobjc.m 。這兩個文件是采用的手動引用計數(shù)，因此在加入項目后需要設(shè)置它們的編譯參數(shù)。

1. 為了方便管理，我們直接將Protocol Buffers中的iOS靜態(tài)庫項目引入進(jìn)來。當(dāng)然，如果喜歡用C++的話，可以直接將C++代碼導(dǎo)入項目，記得設(shè)置 Header Search Paths 或者 User Header Search Paths 。

設(shè)置依賴和連接庫。

1. 引入頭文件開始使用。

#import "GPBProtocolBuffers.h"
#import "Person.pbobjc.h"

- (void)viewDidLoad {
    [super viewDidLoad];

    Person *person = [[Person alloc] init];
    person.name = @"Zhangsan";
    person.email = @"diveinedu@qq.com";
    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);
}

打印結(jié)果如下：

2015-12-02 13:09:46.890 ProtobufDemo[34761:150533]name:Zhangsan
email:diveinedu@qq.com
uid:23

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

name: Zhangsan
email: diveinedu@qq.com
uid: 23

采用Protocol Buffers的數(shù)據(jù)大小為30個字節(jié)。而實用JSON存儲時，盡管我們將Key變成一個字節(jié)，如下：

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

JSON數(shù)據(jù)還是占了46個字節(jié)，并且隨著可讀性提高，效率更低。XML就更不用說了。

總結(jié)

如果希望獲得更好的的可讀性，可以選用JSON和XML這類文本格式。但如果從數(shù)據(jù)效率上將，Protocol Buffer是一個不錯的選擇。存儲效率高，并且proto文件的可讀性和可維護(hù)性都比較強(qiáng)。

戴維營學(xué)院（高級開發(fā)視頻）: http://v.diveinedu.com

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