CocoaPods安裝和使用(包括建立私有庫)
CocoaPods安裝和使用
1. CocoaPods簡介
每種語言發展到一個階段,就會出現相應的依賴管理工具,例如 Java 語言的 Maven,nodejs 的 npm。隨著 iOS 開發者的增多,業界也出現了為 iOS 程式提供依賴管理的工具,它的名字叫做:CocoaPods。 CocoaPods 專案的原始碼 在 Github 上管理。該專案開始於 2011 年 8 月 12 日,經過多年發展,現在已經成為 iOS 開發事實上的依賴管理標準工具。開發 iOS 專案不可避免地要使用第三方開源庫,CocoaPods 的出現使得我們可以節省設定和更新第三方開源庫的時間。
在沒有使用 CocoaPods 以前,我需要: 把這些第三方開源庫 的原始碼檔案複製到專案中,或者設定成 git 的 submodule。 對於這些開源庫通常需要依賴系統的一些 framework,我需要手工地將這些 framework 分別增加到專案依賴中,比如通常情況下,一個網路庫就需要增加以下 framework: CFNetwork, SystemConfiguration, MobileCoreServices, CoreGraphics, zlib。 對於某些開源庫,我還需要設定-licucore或者 -fno-objc-arc等編譯引數 管理這些依賴包的更新。 這些體力活雖然簡單,但毫無技術含量並且浪費時間。在使用 CocoaPods 之後,我只需要將用到的第三方開源庫放到一個名為 Podfile 的檔案中,然後執行pod install。 CocoaPods 就會自動將這些第三方開源庫的原始碼下載下來,並且為我的工程設定好相應的系統依賴和編譯引數。
2. CocoaPods 的安裝和使用介紹
安裝:
安裝方式異常簡單 , Mac 下都自帶 ruby,使用 ruby 的 gem 命令即可下載安裝:
$ sudo gem install cocoapods
$ pod setup
如果你的 gem 太老,可能也會有問題,可以嘗試用如下命令升級 gem:
sudo gem update --system
另外,ruby 的軟體源[ https://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 左右。所以第一次更新時非常慢。
有人在 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 上的映象。
2.1 使用 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]
// ... 以下省略若干行
關於 Podfile.lock
當 你執行pod install之後,除了 Podfile 外,CocoaPods 還會生成一個名為Podfile.lock的檔案,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.
2.2 不更新 podspec
pod install --no-repo-update
pod update --no-repo-update
3. 建立私有倉庫
3.1 建立程式碼倉庫
將自己寫的程式碼推送到git伺服器。如果程式碼可以開源的話,可以用github來託管。參考[個推cocoapods]。
3.2 給穩定的程式碼打上版本tag,一般以版本號作為tag名
git tag -a ‘1.4.1’ -m ‘version 1.4.1’
將tag推送到git伺服器
git push --tags
3.3 建立spec檔案
pod spec create https://github.com/GetuiLaboratory/getui-sdk-ios-cocoapods.git
會在當前目錄建立.podspec檔案,建立的檔案是個完整的配置模板,根據字面意思以及註釋,大體上都能弄明白。不清楚的地方可以[參考],github上也有很多開原始碼可以參考。
3.4 驗證spec檔案有效性
pod spec lint .podspec
3.5 建立spec repository(spec 倉庫)
├─Specs
├──getui-sdk-ios-cocoapods/
├── 1.4.1
└── getui-sdk-ios-cocoapods.podspec
這裡的版本號要和程式碼倉庫裡的tag一一對應 [參考]
3.6 新增私有repo到CocoaPods中
pod repo add GetuiLaboratory https://github.com/GetuiLaboratory/Specs.git
3.7 驗證私有repo安裝無誤
$ cd ~/.cocoapods/repos/REPO_NAME
$ pod repo lint .
後面如果還要往REPO_NAME裡新增新包,只需執行下面命令:
pod repo push REPO_NAME SPEC_NAME.podspec
如要刪除私有repo:
pod repo remove [name]
3.8 新增包到工程的Podfile中如下:
source 'https://github.com/GetuiLaboratory/Specs.git'
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, "7.0"
pod 'Reachability'
pod 'getui-sdk-ios-cocoapods'
3.9 執行
到工程目錄下執行
pod update