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代碼調用

步驟

1. 轉換：将我們編寫好的XXX.proto檔案轉成Objective C檔案，也就是XXX.h和XXX.m檔案，轉換的工具是使用protoc這種二進制檔案來生成的，這檔案需要自己生成，稍後會介紹如何使用它來轉換Objective-C檔案
2. 內建：如果在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 = ;
    string username = ;
    string phone = ;
}           

• 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或以上

• 第二種是把相關檔案拖入項目中。
  • 拖入相關檔案到項目中，将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 = ; 
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