文檔更新說明
- 2012-12-02 v1.0 初稿
- 2014-01-08 v1.1 增加設置 ruby 淘寶源相關內容
- 2014-05-25 v2.0 增加國內 spec 鏡像、使用私有 pod、podfile.lock、創建 spec 文件等內容
- 2015-09-03 v2.1 優化排版，調整一些描述方式，使文章更易讀懂。
- 2015-12-21 v2.2 將淘寶的鏡像修改成 https 的。
CocoaPods 簡介
每種語言發展到一個階段，就會出現相應的依賴管理工具，例如 Java 語言的 Maven，nodejs 的 npm。隨着 iOS 開發者的增多，業界也出現了爲 iOS 程序提供依賴管理的工具，它的名字叫做：CocoaPods。
CocoaPods項目的源碼 在 Github 上管理。該項目開始於 2011 年 8 月 12 日，經過多年發展，現在已經成爲 iOS 開發事實上的依賴管理標準工具。開發 iOS 項目不可避免地要使用第三方開源庫，CocoaPods 的出現使得我們可以節省設置和更新第三方開源庫的時間。
我在開發猿題庫客戶端時，使用了 24 個第三方開源庫。在沒有使用 CocoaPods 以前，我需要:
- 把這些第三方開源庫的源代碼文件複製到項目中，或者設置成 git 的 submodule。
- 對於這些開源庫通常需要依賴系統的一些 framework，我需要手工地將這些 framework 分別增加到項目依賴中，比如通常情況下，一個網絡庫就需要增加以下 framework: CFNetwork, SystemConfiguration, MobileCoreServices, CoreGraphics, zlib。
- 對於某些開源庫，我還需要設置
-licucore或者-fno-objc-arc等編譯參數 - 管理這些依賴包的更新。
這些體力活雖然簡單，但毫無技術含量並且浪費時間。在使用 CocoaPods 之後，我只需要將用到的第三方開源庫放到一個名爲 Podfile 的文件中，然後執行pod install。
CocoaPods 就會自動將這些第三方開源庫的源碼下載下來，並且爲我的工程設置好相應的系統依賴和編譯參數。
CocoaPods 的安裝和使用介紹
安裝
安裝方式異常簡單 , Mac 下都自帶 ruby，使用 ruby 的 gem 命令即可下載安裝：
$ sudo gem install cocoapods |
如果你的 gem 太老，可能也會有問題，可以嘗試用如下命令升級 gem:
sudo gem update --system |
另外，ruby 的軟件源 https://rubygems.org 因爲使用的是亞馬遜的雲服務，所以被牆了，需要更新一下 ruby 的源，使用如下代碼將官方的 ruby 源替換成國內淘寶的源：
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 鏡像：
|
將以上代碼中的 https://gitcafe.com/akuandev/Specs.git 替換成http://git.oschina.net/akuandev/Specs.git 即可使用 oschina 上的鏡像。
使用 CocoaPods
使用時需要新建一個名爲 Podfile 的文件，以如下格式，將依賴的庫名字依次列在文件中即可
platform :ios pod 'JSONKit', '~> 1.4' pod 'Reachability', '~> 3.0.0' pod 'ASIHTTPRequest' pod 'RegexKitLite' |
然後你將編輯好的 Podfile 文件放到你的項目根目錄中，執行如下命令即可：
cd "your project home" |
現在，你的所有第三方庫都已經下載完成並且設置好了編譯參數和依賴，你只需要記住如下 2 點即可：
- 使用 CocoaPods 生成的 .xcworkspace 文件來打開工程，而不是以前的 .xcodeproj 文件。
- 每次更改了 Podfile 文件，你需要重新執行一次
pod update命令。
查找第三方庫
你如果不知道 cocoaPods 管理的庫中，是否有你想要的庫，那麼你可以通過 pod search 命令進行查找，以下是我用 pod search json 查找到的所有可用的庫：
$ pod search json |
關於 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文件：
pod spec create your_pod_spec_name |
該命令執行之後，CocoaPods 會生成一個名爲your_pod_spec_name.podspec的文件，然後我們修改其中的相關內容即可。
具體步驟可以參考這兩篇博文中的相關內容：
使用私有的 pods
我們可以直接指定某一個依賴的podspec，這樣就可以使用公司內部的私有庫。該方案有利於使企業內部的公共項目支持 CocoaPods。如下是一個示例：
pod 'MyCommon', :podspec => 'https://yuantiku.com/common/myCommon.podspec' |
不更新 podspec
CocoaPods 在執行pod install和pod update時，會默認先更新一次podspec索引。使用--no-repo-update參數可以禁止其做索引更新操作。如下所示：
pod install --no-repo-update pod update --no-repo-update |
生成第三方庫的幫助文檔
如果你想讓 CococaPods 幫你生成第三方庫的幫助文檔，並集成到 Xcode 中，那麼用 brew 安裝 appledoc 即可：
brew install appledoc |
關於 appledoc，我在另一篇博客 《使用 Objective-C 的文檔生成工具:appledoc》 中有專門介紹。它最大的優點是可以將幫助文檔集成到 Xcode 中，這樣你在敲代碼的時候，按住 opt 鍵單擊類名或方法名，就可以顯示出相應的幫助文檔。
原理
大概研究了一下 CocoaPods 的原理，它是將所有的依賴庫都放到另一個名爲 Pods 項目中，然後讓主項目依賴 Pods 項目，這樣，源碼管理工作都從主項目移到了 Pods 項目中。發現的一些技術細節有：
- Pods 項目最終會編譯成一個名爲 libPods.a 的文件，主項目只需要依賴這個 .a 文件即可。
- 對於資源文件，CocoaPods 提供了一個名爲 Pods-resources.sh 的 bash 腳本，該腳本在每次項目編譯的時候都會執行，將第三方庫的各種資源文件複製到目標目錄中。
- CocoaPods 通過一個名爲 Pods.xcconfig 的文件來在編譯時設置所有的依賴和參數。
