Protobuf在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)'

一旦打開***了,運行下面的腳本:

$ ./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$ ls
Person.pbobjc.h Person.pbobjc.m Person.proto

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

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

設置依賴和連接庫。

  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:Zhangsan
email:[email protected]
uid:23
  1. Protocol Buffer效率測試 我們這裏說的效率是指空間佔用率。簡單和JSON格式比較一下,同樣是存儲下面的信息:

name: Zhangsan
email: [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


發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章