01-唐巧之cocoapods

用CocoaPods作iOS程序的依賴管理

 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就會自動將這些第三方開源庫的源碼下載下來，而且爲個人工程設置好相應的系統依賴和編譯參數。

CocoaPods的安裝和使用介紹

安裝

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

1 2	$ sudo gem install cocoapods $ pod setup

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

1	sudo gem update --system

另外，ruby的軟件源rubygems.org由於使用的亞馬遜的雲服務，因此被牆了，須要更新一下ruby的源，以下代碼將官方的ruby源替換成國內淘寶的源：

1 2 3

gem sources --remove https://rubygems.org/ gem sources -a http://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] // ...如下省略若干行

關於.gitignore

當你執行pod install以後，除了Podfile外，CocoaPods還會生成一個名爲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的文件，而後咱們修改其中的相關內容便可。

具體步驟能夠參考這兩篇博文中的相關內容：《如何編寫一個CocoaPods的spec文件》 和《Cocoapods 入門》。

使用私有的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的文件來在編譯時設置全部的依賴和參數。

願你們玩得開心～