使用CocoaPods來作iOS程序的包依賴管理

前言

每種語言發展到一個階段，就會出現相應的依賴管理工具, 或者是中央代碼倉庫。好比

• Java: maven，Ivy
• Ruby: gems
• Python: pip, easy_install
• Nodejs: npm

隨着iOS開發者的增多，業界也出現了爲iOS程序提供依賴管理的工具，這個工具叫：CocoaPods。

CocoaPods簡介

CocoaPods是一個負責管理iOS項目中第三方開源代碼的工具。CocoaPods項目的源碼在Github上管理。該項目開始於2011年8月12日，通過一年多的發展，如今已經超過1000次提交，而且持續保持活躍更新。開發iOS項目不可避免地要使用第三方開源庫，CocoaPods的出現使得咱們能夠節省設置和更新第三方開源庫的時間。

拿我以前開發的粉筆網iPhone客戶端爲例，其使用了14個第三方開源庫。在沒有使用CocoaPods之前，我須要：

1. 把這些第三方開源庫的相關文件複製到項目中，或者設置成git的submodule，而後這些開源庫一般須要依賴系統的一些framework，我須要手工地將這些framework一一增長到項目依賴中，好比ASI網絡庫就須要增長如下framework: CFNetwork, SystemConfiguration, MobileCoreServices, CoreGraphics and zlib。
2. 對於RegexKitLite這個正則表達式庫，我還須要設置-licucore的編譯參數
3. 手工管理這些依賴包的更新。

這些體力活雖然簡單，但毫無技術含量而且浪費時間。在使用CocoaPods以後，我只須要將用到的第三方開源庫放到一個名爲Podfile的文件中，而後執行pod install。CocoaPods就會自動將這些第三方開源庫的源碼下載下來，而且爲個人工程設置好相應的系統依賴和編譯參數。

CocoaPods的安裝和使用介紹

安裝

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

1 2	$ sudo gem install cocoapods $ pod setup

上面第二行執行時，會輸出Setting up CocoaPods master repo，可是會等待比較久的時間。這步實際上是Cocoapods在將它的信息下載到 ~/.cocoapods目錄下，若是你等過久，能夠試着cd到那個目錄，用du -sh *來查看下載進度。

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

1	sudo gem update --system

另外，ruby的軟件源rubygems.org由於使用的亞馬遜的雲服務，因此被牆了，須要更新一下ruby的源：

1 2 3

gem sources --remove https://rubygems.org/ gem sources -a http://ruby.taobao.org/ gem sources -l

使用

使用時須要新建一個名爲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 install命令。

查找第三方庫

你若是不知道cocoaPods管理的庫中，是否有你想要的庫，那麼你能夠經過pod search命令進行查找，如下是我用pod search json查找到的全部可用的庫：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

$ 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] -> MTJSONDictionary (0.0.4) An NSDictionary category for when you're working with it converting to/from JSON. DEPRECATED, use MTJSONUtils instead. - Homepage: https://github.com/mysterioustrousers/MTJSONDictionary.git - Source: https://github.com/mysterioustrousers/MTJSONDictionary.git - Versions: 0.0.4, 0.0.3, 0.0.2 [master repo] -> MTJSONUtils (0.1.0) An NSObject category for working with JSON. - Homepage: https://github.com/mysterioustrousers/MTJSONUtils.git - Source: https://github.com/mysterioustrousers/MTJSONUtils.git - Versions: 0.1.0, 0.0.1 [master repo] -> SBJson (3.1.1) This library implements strict JSON parsing and generation in Objective-C. - Homepage: http://stig.github.com/json-framework/ - Source: https://github.com/stig/json-framework.git - Versions: 3.1.1, 3.1, 3.0.4, 2.2.3 [master repo] -> TouchJSON (1.0) TouchJSON is an Objective-C based parser and generator for JSON encoded data. - Homepage: https://github.com/TouchCode/TouchJSON - Source: https://github.com/TouchCode/TouchJSON.git - Versions: 1.0 [master repo]

關於.gitignore

當你執行pod install以後，除了Podfile外，cocoapods還會生成一個名爲Podfile.lock的文件，你不該該把這個文件加入到.gitignore中。由於Podfile.lock會鎖定當前各依賴庫的版本，以後若是屢次執行pod install 不會更改版本，要pod update纔會改Podfile.lock了。這樣多人協做的時候，能夠防止第三方庫升級把程序搞掛。

生成第三方庫的幫助文檔

若是你想讓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的文件來在編譯時設置全部的依賴和參數。

Have fun!

Posted by 唐巧 Dec 2nd, 2012  iOS

 

 

轉載地址：http://blog.devtang.com/blog/2012/12/02/use-cocoapod-to-manage-ios-lib-dependency/