每種語言發展到一定階段,都會誕生相應的依賴管理工具,比如Java的Maven、Node.js的npm。隨著iOS開發者隊伍日益壯大,業界也出現了專為iOS程序提供依賴管理的利器,它叫CocoaPods。
CocoaPods的源碼托管在Github上。它的意義體現在兩方面:其一,引入第三方庫總免不了各種繁瑣配置,對Objective-C初學者來說,項目配置堪稱艱巨任務,稍不留神就會在編譯階段和鏈接器選項中引入人為錯誤,而CocoaPods能自動完成這些配置,把開發者從中解救出來;其二,它讓查找新的第三方庫變得輕鬆,幫你找到真正好用的庫,縮短開發週期、提升代碼質量。
接下來,我們就從pod安裝的過程入手,一步步揭開CocoaPods背後的技術面紗。
CocoaPods用Ruby實現,使用前得先具備Ruby環境。所幸OS X系統默認已能運行Ruby,因此只需執行以下命令即可。
Gem是管理Ruby庫和程序的標準包,它透過Ruby Gem源(如 https://rubygems.org)來查找、安裝、升級與卸載軟件包。
先移除原有源(服務器在國外,速度較慢):
$ gem sources --remove https://rubygems.org/
等系統有反應後,再添加國內的Ruby China官方源:
$ gem source -a https://gems.ruby-china.org
驗證是否替換成功:
$ gem sources -l
Gem版本過低同樣可能導致安裝失敗,解決之道自然是升級:
$ sudo gem update --system
OS X 10.11以前:
$ sudo gem install cocoapods
10.11以後(蘋果升級了安全策略):
$ sudo gem install -n /usr/local/bin cocoapods
所有項目的Podspec文件都托管在 https://github.com/CocoaPods/Specs。首次執行pod setup時,CocoaPods會把這些podspec索引更新到本地的 ~/.cocoapods/ 目錄,這份索引相當龐大(約80M),所以第一次更新會非常慢。
有開發者在gitcafe和oschina上建立了CocoaPods索引庫的鏡像,由於都是國內服務器,更新索引時會快很多。以下操作可把CocoaPods設置為使用gitcafe鏡像:
1. 移除原有服務器:
$ pod repo remove master
2. 添加境內服務器(建議用第一個):
$ pod repo add master https://gitcafe.com/akuandev/Specs.git
$ pod repo add master https://git.oschina.net/akuandev/Specs.git
3. 查看是否添加成功:
$ pod repo
使用時需在項目根目錄新建一個名為Podfile的文件,把依賴的庫名依次列在其中。先進入工程目錄:
$ cd /Users/xiao/Desktop/CocoaPodsDemo
創建Podfile:
$ touch Podfile
假設我們想導入AFNetworking,可進入 https://cocoapods.org 搜索AFNetworking,把相應配置寫進Podfile。
$ cd /Users/xiao/Desktop/CocoaPodsDemo
$ pod install
執行成功後,會發現工程目錄多出CocoaPodsTest.xcworkspace、Podfile.lock文件和Pods目錄。再看命令打印的最後一行:From now on use CocoaPodsDemo.xcworkspace——它提示我們,從此以後要改用.xcworkspace文件來開發。
只需在Podfile中添加相應的第三方庫信息,再執行:
$ pod update
之後使用CocoaPods若遇到莫名其妙的問題,可依次執行:
$ sudo gem update --system $ sudo gem install cocoapods $ pod setup
pod install提速:每次執行pod install和pod update時,CocoaPods都會默認更新一次spec倉庫,這是個頗耗時的操作。在確認spec版本庫無需更新時,給命令加上 --no-repo-update 參數即可跳過更新,明顯提速:
$ pod install --verbose --no-repo-update
$ pod update --verbose --no-repo-update
Podfile中第三方庫版本號的各種寫法:
pod 'AFNetworking' //不顯式指定版本,表示每次獲取最新版
pod 'AFNetworking', '2.0' //只使用2.0版本
pod 'AFNetworking', '>=2.0' //使用大於或等於2.0的版本
pod 'AFNetworking', '<2.0' //使用小於2.0的版本
pod 'AFNetworking', '<=2.0' //使用小於或等於2.0的版本
pod 'AFNetworking', '~>0.1.2' //使用大於等於0.1.2但小於0.2的版本
pod 'AFNetworking', '~>0.1' //使用大於等於0.1但小於1.0的版本
pod 'AFNetworking', '~>0' //高於0的版本,效果等同不寫,都表示用最新版
CocoaPods用Ruby編寫,並拆分為若干Gem包。解析執行過程中最重要的幾個包分別是:CocoaPods/CocoaPods、CocoaPods/Core和CocoaPods/Xcodeproj。
這是面向用戶的組件,每當你執行一個pod命令,它就會被激活。它囊括了所有使用CocoaPods的功能,並能呼叫其他gem包來完成任務。
Core gem負責處理與CocoaPods相關的文件(主要是Podfile和podspecs)。
Podfile用於配置項目所需的第三方庫,可被高度定製。想深入了解,可查閱Podfile指南(https://guides.cocoapods.org/syntax/podfile.html)。
.podspec文件描述了一個庫將如何被添加進工程,可標識該庫所需的源碼文件、依賴庫、編譯選項,以及其他第三方庫所需的配置。
這個包負責處理與工程文件直接相關的事務,能創建並修改.xcodeproj和.xcworkspace文件。它也可作為獨立包使用——當你要編寫修改項目文件的腳本時,不妨考慮它。
CocoaPods採用語義化版本命名約定來解決版本依賴。由於衝突解決系統建立在「非重大更改的補丁版本」之間,處理依賴關係便容易得多。舉個例子:兩個毫不相干的第三方庫同時依賴CocoaLumberjack,一個要求2.3.1,另一個要求2.3.3,解析器會自動選用較新的2.3.3,因為它與2.3.1向後兼容。
但這招並非總管用。許多第三方庫並不支持這一約定,讓解決方案變得複雜。總有一些衝突需要手工處理:如果一個庫依賴CocoaLumberjack 1.2.5,另一個依賴2.3.1,最後就只能由使用者親自決定該用哪個版本了。
CocoaPods執行的下一步是加載源代碼。每個.podspec文件都包含源代碼索引,通常指向某個Git地址或git tag,並以commit SHA的形式存儲在 ~/Library/Caches/CocoaPods 中,而這些路徑下的文件創建則由Core包負責。源代碼會依Podfile、.podspec和緩存文件的信息,下載到相應的第三方庫路徑。
每次pod install執行後若檢測到改動,Pods.xcodeproj文件便會被Xcodeproj gem更新。若該文件不存在,就以默認配置生成;若已存在,則沿用現有配置。
當CocoaPods往項目中添加一個第三方庫時,絕不只是「添加代碼」這麼簡單。由於每個庫有不同的target,每次添加時只有幾個文件被加入。每個源代碼都需要:一個含編譯選項的.xcconfig文件、一個同時包含編譯設置與CocoaPods默認配置的私有.xcconfig文件、編譯必需的prefix.pch文件,以及另一個編譯必需的dummy.m文件。
當每個pod的target都完成上述步驟後,整個Pods的Target便會被創建,它會添加相同的文件外加另外幾個。若源代碼中包含資源bundle,向app target添加bundle的方式會寫入Pods-Resources.sh;還有一個名為Pods-environment.h的文件,內含許多檢查組件是否來自pod的宏定義。最後會生成兩個確認文件:一個.plist文件,以及一個供用戶查閱許可信息的markdown文件。
直到現在,許多已完成的過程用的都是內存中的對象。為让这些結果能被重複使用,我們需要把記錄寫入文件,於是Pods.xcodeproj以及另外兩個關鍵文件——Podfile.lock和Manifest.lock都會被寫入磁盤。
Podfile.lock:這是CocoaPods創建的最重要的文件之一,記錄了每個已安裝pod的具體版本。想知道某個pod裝的是哪個版本,看它就行。建議將其納入版本控制,有助於團隊保持一致。
Manifest.lock:這是每次執行pod install時生成的Podfile.lock副本。如果你見過「沙盒文件和Podfile.lock不同步」的錯誤,那正是因為兩者內容不一致。由於Pods所在目錄並不總在版本控制之下,這樣可確保開發者在運行app前先更新pods,否則app可能崩潰,或在不易察覺處編譯失敗。
xcproj:如果你已按建議安裝了xcproj,它會把Pods.xcodeproj轉換成舊有的ASCII格式plist文件。這麼做的理由是:Xcode所依賴和使用的plist格式在很久以前就已不被其他軟件支持。若沒有xcproj,你的Pods.xcodeproj會以XML格式的plist存儲,用Xcode打開時會被改寫,從而引發大量文件衝突。