CocoaPods 簡介

每種語言發展到一個階段，就會出現相應的依賴管理工具，例如 Java 語言的 Maven，nodejs 的 npm。隨著 iOS 開發者的增多，業界也出現了為 iOS 程式提供依賴管理的工具，它的名字叫做：CocoaPods。

CocoaPods專案的原始碼 在 Github 上管理。該專案開始於 2011 年 8 月 12 日，經過多年發展，現在已經成為 iOS 開發事實上的依賴管理標準工具。開發 iOS 專案不可避免地要使用第三方開源庫，CocoaPods 的出現使得我們可以節省設定和更新第三方開源庫的時間。

我在開發猿題庫客戶端時，使用了 24 個第三方開源庫。在沒有使用 CocoaPods 以前，我需要:

1. 把這些第三方開源庫的原始碼檔案複製到專案中，或者設定成 git 的 submodule。
2. 對於這些開源庫通常需要依賴系統的一些 framework，我需要手工地將這些 framework 分別增加到專案依賴中，比如通常情況下，一個網路庫就需要增加以下 framework: CFNetwork, SystemConfiguration, MobileCoreServices, CoreGraphics, zlib。
3. 對於某些開源庫，我還需要設定-licucore或者 -fno-objc-arc等編譯引數
4. 管理這些依賴包的更新。

這些體力活雖然簡單，但毫無技術含量並且浪費時間。在使用 CocoaPods 之後，我只需要將用到的第三方開源庫放到一個名為 Podfile 的檔案中，然後執行pod install

CocoaPods 的安裝和使用介紹

安裝

安裝方式異常簡單 , Mac 下都自帶 ruby，使用 ruby 的 gem 命令即可下載安裝：

1
2

$ sudo gem install cocoapods
$ pod setup

如果你的 gem 太老，可能也會有問題，可以嘗試用如下命令升級 gem:

1

sudo gem update --system

另外，ruby 的軟體源 https://rubygems.org 因為使用的是亞馬遜的雲服務，所以被牆了，需要更新一下 ruby 的源，使用如下程式碼將官方的 ruby 源替換成國內淘寶的源：

1
2
3

gem sources --remove https://rubygems.org/
gem sources -a https://ruby.taobao.org/
gem sources -l

還有一點需要注意，pod setup在執行時，會輸出Setting up CocoaPods master repo，但是會等待比較久的時間。這步其實是 Cocoapods 在將它的資訊下載到 ~/.cocoapods目錄下，如果你等太久，可以試著 cd 到那個目錄，用du -sh *來檢視下載進度。你也可以參考本文接下來的使用 cocoapods 的映象索引一節的內容來提高下載速度。

使用 CocoaPods 的映象索引

所有的專案的 Podspec 檔案都託管在https://github.com/CocoaPods/Specs。第一次執行pod setup時，CocoaPods 會將這些podspec索引檔案更新到本地的 ~/.cocoapods/目錄下，這個索引檔案比較大，有 80M 左右。所以第一次更新時非常慢，筆者就更新了將近 1 個小時才完成。

一個叫 akinliu 的朋友在 gitcafe 和 oschina 上建立了 CocoaPods 索引庫的映象，因為 gitcafe 和 oschina 都是國內的伺服器，所以在執行索引更新操作時，會快很多。如下操作可以將 CocoaPods 設定成使用 gitcafe 映象：

1
2
3

pod repo remove master
pod repo add master https://gitcafe.com/akuandev/Specs.git
pod repo update

將以上程式碼中的 https://gitcafe.com/akuandev/Specs.git 替換成 http://git.oschina.net/akuandev/Specs.git 即可使用 oschina 上的映象。

使用 CocoaPods

使用時需要新建一個名為 Podfile 的檔案，以如下格式，將依賴的庫名字依次列在檔案中即可

1
2
3
4
5

platform :ios
pod 'JSONKit',       '~> 1.4'
pod 'Reachability',  '~> 3.0.0'
pod 'ASIHTTPRequest'
pod 'RegexKitLite'

然後你將編輯好的 Podfile 檔案放到你的專案根目錄中，執行如下命令即可：

1
2

cd "your project home"
pod install

現在，你的所有第三方庫都已經下載完成並且設定好了編譯引數和依賴，你只需要記住如下 2 點即可：

1. 使用 CocoaPods 生成的 .xcworkspace 檔案來開啟工程，而不是以前的 .xcodeproj 檔案。
2. 每次更改了 Podfile 檔案，你需要重新執行一次pod update命令。

查詢第三方庫

你如果不知道 cocoaPods 管理的庫中，是否有你想要的庫，那麼你可以通過 pod search 命令進行查詢，以下是我用 pod search json 查詢到的所有可用的庫：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

$ pod search json
-> AnyJSON (0.0.1)
   Encode / Decode JSON by any means possible.
   - Homepage: https://github.com/mattt/AnyJSON
   - Source:   https://github.com/mattt/AnyJSON.git
   - Versions: 0.0.1 [master repo]
-> JSONKit (1.5pre)
   A Very High Performance Objective-C JSON Library.
   - Homepage: https://github.com/johnezang/JSONKit
   - Source:   git://github.com/johnezang/JSONKit.git
   - Versions: 1.5pre, 1.4 [master repo]
// ... 以下省略若干行

關於 Podfile.lock

當你執行pod install之後，除了 Podfile 外，CocoaPods 還會生成一個名為Podfile.lock的檔案，Podfile.lock 應該加入到版本控制裡面，不應該把這個檔案加入到.gitignore中。因為Podfile.lock會鎖定當前各依賴庫的版本，之後如果多次執行pod install 不會更改版本，要pod update才會改Podfile.lock了。這樣多人協作的時候，可以防止第三方庫升級時造成大家各自的第三方庫版本不一致。

CocoaPods 的這篇 官方文件 也在What is a Podfile.lock一節中介紹了Podfile.lock的作用，並且指出：

This file should always be kept under version control.

為自己的專案建立 podspec 檔案

我們可以為自己的開源專案建立podspec檔案，首先通過如下命令初始化一個podspec檔案：

1

pod spec create your_pod_spec_name

該命令執行之後，CocoaPods 會生成一個名為your_pod_spec_name.podspec的檔案，然後我們修改其中的相關內容即可。

具體步驟可以參考這兩篇博文中的相關內容：

使用私有的 pods

我們可以直接指定某一個依賴的podspec，這樣就可以使用公司內部的私有庫。該方案有利於使企業內部的公共專案支援 CocoaPods。如下是一個示例：

1

pod 'MyCommon', :podspec => 'https://yuantiku.com/common/myCommon.podspec'

不更新 podspec

CocoaPods 在執行pod install和pod update時，會預設先更新一次podspec索引。使用--no-repo-update引數可以禁止其做索引更新操作。如下所示：

1
2

pod install --no-repo-update
pod update --no-repo-update

生成第三方庫的幫助文件

如果你想讓 CococaPods 幫你生成第三方庫的幫助文件，並整合到 Xcode 中，那麼用 brew 安裝 appledoc 即可：

1

brew install appledoc

關於 appledoc，我在另一篇部落格 《使用 Objective-C 的文件生成工具:appledoc》 中有專門介紹。它最大的優點是可以將幫助文件整合到 Xcode 中，這樣你在敲程式碼的時候，按住 opt 鍵單擊類名或方法名，就可以顯示出相應的幫助文件。

原理

大概研究了一下 CocoaPods 的原理，它是將所有的依賴庫都放到另一個名為 Pods 專案中，然後讓主專案依賴 Pods 專案，這樣，原始碼管理工作都從主專案移到了 Pods 專案中。發現的一些技術細節有：

1. Pods 專案最終會編譯成一個名為 libPods.a 的檔案，主專案只需要依賴這個 .a 檔案即可。
2. 對於資原始檔，CocoaPods 提供了一個名為 Pods-resources.sh 的 bash 指令碼，該指令碼在每次專案編譯的時候都會執行，將第三方庫的各種資原始檔複製到目標目錄中。
3. CocoaPods 通過一個名為 Pods.xcconfig 的檔案來在編譯時設定所有的依賴和引數。