在 GitHub 上有名為 protobuf-objc 的開源庫,它的 README 詳細說明了如何把 protoc 安裝到我們的電腦中。接著透過 protoc(也就是 Protocol Buffers 的編譯器)編譯 .proto 文件,即可生成對應的 .h 與 .m 文件。
在移動 App 中,Protocol Buffers 可以用於本地儲存、網絡傳輸,以及各種與數據打交道的場景。最簡單的例子:假設你要記錄用戶資料,比如帳號、密碼、性別、有無伴侶等,為了把這些數據高效地傳輸到服務器,就需要一套合適的數據結構。相比 JSON、XML 等方案,Protocol Buffers 憑藉更小的體積與更快的解析速度,在移動端有著明顯優勢。
以下步驟整理自 alexeyxo/protobuf-objc 的官方文檔:
brew -vruby -e $(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)brew install automake、brew install libtool、brew install protobufln -s /usr/local/Cellar/protobuf/2.6.1/bin/protoc /usr/local/bingit clone https://github.com/alexeyxo/protobuf-objc.git./build.sh簡單解釋一下這些命令的作用:brew 是 macOS 上類似 Ubuntu apt-get 的包管理工具,-v 表示查看版本。Homebrew 安裝命令會透過 curl 訪問指定 URL,並在 Ruby 環境下完成下載安裝。brew install 系列命令用於安裝 protobuf 主程序及 automake、libtool 兩個依賴庫。git clone 從 GitHub 下載工程,./build.sh 則負責編譯。
注意:編譯過程中可能出現錯誤,別慌,先看提示信息。多數錯誤只是因為環境變量或路徑未配置好,缺少某些依賴庫,按照提示補上對應路徑即可。
打開 Xcode 新建一個工程。把 protobuf 加入工程有兩種方式:直接添加,或使用 CocoaPods。強烈推薦後者,因為 CocoaPods 能方便地管理第三方類庫,日後對方工程升級時,只需一行 pod update 即可搞定。
在 Podfile 中加入:
platform :ios, '6.0'
pod 'ProtocolBuffers', '~> 1.9.7'
保存後,在終端 cd 到工程目錄執行:
pod install
稍等片刻,CocoaPods 就會幫我們配置好。此後應打開工程的 workspace(因為已把 pod 作為子工程引入)。
在工程內新建一個文件夾(例如命名為 Protobuf),在其中新建一個 proto 文件。以本地儲存用戶信息為例,新建 user.proto,內容如下:
package csdnblog;
message PBUser {
required string userId = 1; // 用戶 ID
optional string nick = 2; // 用戶昵稱
optional string avatar = 3; // 用戶頭像
optional string password = 7;
optional string email = 8;
optional string mobile = 9; // 手機號碼
optional string qqOpenId = 10; // QQ ID
optional string sinaId = 11; // SINA UserID
optional string weixinId = 12; // WeChat UserID
}
這個例子涵蓋了兩個關鍵要素。第一是包名(package)。Objective-C 本身沒有包的概念,但 Java 有,C++ 的 namespace 也大同小異。順帶一提,OC 通常在庫名前加上兩個字母前綴(如官方的 NS、AFNetworking 的 AF),起到類似包的分層組織作用。
第二個要素是 message。一個 message 就是一個整體,內部定義了哪些字段是必須的、哪些是可有可無的。更詳細的 proto 語法網上資料很多,這裡不再冗述。
寫好 proto 文件後,接下來就是編譯它。protobuf-objc 這個類庫會生成一批源碼,作為讀寫 proto 數據的接口 API。建議在工程下單獨新建一個文件夾(例如 Gen)作為輸出路徑,用來存放生成的 .pb.h 與 .pb.m 文件。
打開終端,cd 到工程路徑下執行:
protoc --plugin=/usr/local/bin/protoc-gen-objc person.proto --objc_out=./Gen
完成後,你就能在 Gen 目錄中看到生成的接口文件,並在工程裡調用它們來讀寫 Protocol Buffers 數據了。