原文地址:用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命令即可下載安裝:
$ sudo gem install cocoapods
$ pod setup
如果你的gem太老,可能也會有問題,可以嘗試用如下命令升級gem:
sudo gem update --system
另外,ruby的軟件源rubygems.org因為使用的亞馬遜的云服務,所以被墻了,需要更新一下ruby的源,如下代碼將官方的ruby源替換成國內淘寶的源:
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鏡像:
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的文件,以如下格式,將依賴的庫名字依次列在文件中即可
platform :ios
pod 'JSONKit',? ? ? '~> 1.4'
pod 'Reachability',? '~> 3.0.0'
pod 'ASIHTTPRequest'
pod 'RegexKitLite'
然后你將編輯好的Podfile文件放到你的項目根目錄中,執行如下命令即可:
cd "your project home"
pod install
現在,你的所有第三方庫都已經下載完成并且設置好了編譯參數和依賴,你只需要記住如下2點即可:
使用CocoaPods生成的 .xcworkspace 文件來打開工程,而不是以前的 .xcodeproj 文件。
每次更改了Podfile文件,你需要重新執行一次pod update命令。
查找第三方庫
你如果不知道cocoaPods管理的庫中,是否有你想要的庫,那么你可以通過pod search命令進行查找,以下是我用pod search json查找到的所有可用的庫:
$ 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文件:
pod spec create your_pod_spec_name
該命令執行之后,CocoaPods會生成一個名為your_pod_spec_name.podspec的文件,然后我們修改其中的相關內容即可。
具體步驟可以參考這兩篇博文中的相關內容:《如何編寫一個CocoaPods的spec文件》 和《Cocoapods 入門》。
使用私有的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的文件來在編譯時設置所有的依賴和參數。
愿大家玩得開心~