轉(zhuǎn)自唐巧
用CocoaPods做iOS程序的依賴管理
MAY 25TH, 2014
文檔更新說明
2012-12-02 v1.0 初稿
2014-01-08 v1.1 增加設(shè)置ruby淘寶源相關(guān)內(nèi)容
2014-05-25 v2.0 增加國內(nèi)spec鏡像、使用私有pod氯析、podfile.lock疼进、創(chuàng)建spec文件等內(nèi)容
CocoaPods簡介
每種語言發(fā)展到一個階段坷虑，就會出現(xiàn)相應(yīng)的依賴管理工具报辱，例如Java語言的Maven瑞眼，nodejs的npm吗铐。隨著iOS開發(fā)者的增多息楔，業(yè)界也出現(xiàn)了為iOS程序提供依賴管理的工具妒峦，它的名字叫做：CocoaPods重斑。
CocoaPods項目的源碼在Github上管理。該項目開始于2011年8月12日肯骇，經(jīng)過多年發(fā)展窥浪，現(xiàn)在已經(jīng)成為iOS開發(fā)事實上的依賴管理標準工具。開發(fā)iOS項目不可避免地要使用第三方開源庫笛丙，CocoaPods的出現(xiàn)使得我們可以節(jié)省設(shè)置和更新第三方開源庫的時間漾脂。
在我開發(fā)猿題庫客戶端時，其使用了24個第三方開源庫胚鸯。在沒有使用CocoaPods以前骨稿，我需要:
把這些第三方開源庫的源代碼文件復(fù)制到項目中，或者設(shè)置成git的submodule。
對于這些開源庫通常需要依賴系統(tǒng)的一些framework坦冠，我需要手工地將這些framework一一增加到項目依賴中镜豹，比如通常情況下，一個網(wǎng)絡(luò)庫就需要增加以下framework: CFNetwork, SystemConfiguration, MobileCoreServices, CoreGraphics, zlib蓝牲。
對于某些開源庫趟脂，我還需要設(shè)置-licucore
或者 -fno-objc-arc
等編譯參數(shù)
管理這些依賴包的更新。
這些體力活雖然簡單例衍，但毫無技術(shù)含量并且浪費時間昔期。在使用CocoaPods之后，我只需要將用到的第三方開源庫放到一個名為Podfile的文件中佛玄，然后執(zhí)行pod install
硼一。CocoaPods就會自動將這些第三方開源庫的源碼下載下來，并且為我的工程設(shè)置好相應(yīng)的系統(tǒng)依賴和編譯參數(shù)梦抢。
CocoaPods的安裝和使用介紹
安裝
安裝方式異常簡單, Mac下都自帶ruby般贼，使用ruby的gem命令即可下載安裝：
12
$ sudo gem install cocoapods$ pod setup
如果你的gem太老，可能也會有問題奥吩，可以嘗試用如下命令升級gem:
1
sudo gem update --system
另外哼蛆，ruby的軟件源rubygems.org因為使用的亞馬遜的云服務(wù)，所以被墻了霞赫，需要更新一下ruby的源腮介，如下代碼將官方的ruby源替換成國內(nèi)淘寶的源：
123
gem sources --remove https://rubygems.org/gem sources -a http://ruby.taobao.org/gem sources -l
還有一點需要注意，pod setup
在執(zhí)行時端衰，會輸出Setting up CocoaPods master repo
叠洗，但是會等待比較久的時間。這步其實是Cocoapods在將它的信息下載到 ~/.cocoapods
目錄下旅东，如果你等太久灭抑，可以試著cd到那個目錄，用du -sh *
來查看下載進度抵代。你也可以參考本文接下來的使用cocoapods的鏡像索引
一節(jié)的內(nèi)容來提高下載速度腾节。
使用CocoaPods的鏡像索引
所有的項目的Podspec文件都托管在https://github.com/CocoaPods/Specs
。第一次執(zhí)行pod setup
時主守，CocoaPods會將這些podspec
索引文件更新到本地的 ~/.cocoapods/
目錄下禀倔，這個索引文件比較大，有80M左右参淫。所以第一次更新時非常慢救湖，筆者就更新了將近1個小時才完成。
一個叫akinliu的朋友在gitcafe和oschina上建立了CocoaPods索引庫的鏡像涎才，因為gitcafe和oschina都是國內(nèi)的服務(wù)器鞋既，所以在執(zhí)行索引更新操作時力九，會快很多。如下操作可以將CocoaPods設(shè)置成使用gitcafe鏡像：
123
pod repo remove masterpod repo add master https://gitcafe.com/akuandev/Specs.gitpod repo update
將以上代碼中的 https://gitcafe.com/akuandev/Specs.git
替換成 http://git.oschina.net/akuandev/Specs.git
即可使用oschina上的鏡像邑闺。
使用CocoaPods
使用時需要新建一個名為Podfile的文件跌前，以如下格式，將依賴的庫名字依次列在文件中即可
12345
platform :iospod 'JSONKit', '~> 1.4'pod 'Reachability', '~> 3.0.0'pod 'ASIHTTPRequest'pod 'RegexKitLite'
然后你將編輯好的Podfile文件放到你的項目根目錄中陡舅，執(zhí)行如下命令即可：
12
cd "your project home"pod install
現(xiàn)在抵乓，你的所有第三方庫都已經(jīng)下載完成并且設(shè)置好了編譯參數(shù)和依賴，你只需要記住如下2點即可：
使用CocoaPods生成的 *.xcworkspace 文件來打開工程靶衍，而不是以前的 *.xcodeproj 文件灾炭。
每次更改了Podfile文件，你需要重新執(zhí)行一次pod update
命令颅眶。
查找第三方庫
你如果不知道cocoaPods管理的庫中蜈出，是否有你想要的庫，那么你可以通過pod search命令進行查找涛酗，以下是我用pod search json查找到的所有可用的庫：
12345678910111213141516
$ 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]// ...以下省略若干行
關(guān)于.gitignore
當你執(zhí)行pod install
之后铡原，除了Podfile外，CocoaPods還會生成一個名為Podfile.lock
的文件商叹，你不應(yīng)該把這個文件加入到.gitignore
中燕刻。因為Podfile.lock
會鎖定當前各依賴庫的版本，之后如果多次執(zhí)行pod install
不會更改版本沈自，要pod update
才會改Podfile.lock
了酌儒。這樣多人協(xié)作的時候辜妓，可以防止第三方庫升級時造成大家各自的第三方庫版本不一致枯途。
CocoaPods的這篇官方文檔也在What is a Podfile.lock
一節(jié)中介紹了Podfile.lock
的作用，并且指出：
This file should always be kept under version control.
為自己的項目創(chuàng)建podspec文件
我們可以為自己的開源項目創(chuàng)建podspec
文件籍滴，首先通過如下命令初始化一個podspec
文件：
1
pod spec create your_pod_spec_name
該命令執(zhí)行之后酪夷，CocoaPods會生成一個名為your_pod_spec_name.podspec
的文件，然后我們修改其中的相關(guān)內(nèi)容即可孽惰。
具體步驟可以參考這兩篇博文中的相關(guān)內(nèi)容：《如何編寫一個CocoaPods的spec文件》 和《Cocoapods 入門》晚岭。
使用私有的pods
我們可以直接指定某一個依賴的podspec
，這樣就可以使用公司內(nèi)部的私有庫勋功。該方案有利于使企業(yè)內(nèi)部的公共項目支持CocoaPods坦报。如下是一個示例：
1
pod 'MyCommon', :podspec => 'https://yuantiku.com/common/myCommon.podspec'
不更新podspec
CocoaPods在執(zhí)行pod install
和pod update
時，會默認先更新一次podspec
索引狂鞋。使用--no-repo-update
參數(shù)可以禁止其做索引更新操作片择。如下所示：
12
pod install --no-repo-updatepod update --no-repo-update
生成第三方庫的幫助文檔
如果你想讓CococaPods幫你生成第三方庫的幫助文檔，并集成到Xcode中骚揍，那么用brew安裝appledoc即可：
1
brew install appledoc
關(guān)于appledoc字管，我在另一篇博客《使用Objective-C的文檔生成工具:appledoc》中有專門介紹啰挪。它最大的優(yōu)點是可以將幫助文檔集成到Xcode中，這樣你在敲代碼的時候嘲叔，按住opt鍵單擊類名或方法名亡呵，就可以顯示出相應(yīng)的幫助文檔。
原理
大概研究了一下CocoaPods的原理硫戈，它是將所有的依賴庫都放到另一個名為Pods項目中锰什，然后讓主項目依賴Pods項目，這樣丁逝，源碼管理工作都從主項目移到了Pods項目中歇由。發(fā)現(xiàn)的一些技術(shù)細節(jié)有：
Pods項目最終會編譯成一個名為libPods.a的文件，主項目只需要依賴這個.a文件即可果港。
對于資源文件沦泌，CocoaPods提供了一個名為Pods-resources.sh的bash腳本，該腳本在每次項目編譯的時候都會執(zhí)行辛掠，將第三方庫的各種資源文件復(fù)制到目標目錄中谢谦。
CocoaPods通過一個名為Pods.xcconfig的文件來在編譯時設(shè)置所有的依賴和參數(shù)。
愿大家玩得開心～
Posted by 唐巧 May 25th, 2014
iOS
