CocoaPods is a dependency manager for Swift and Objective-C Cocoa projects. It has over ten thousand libraries and can help you scale your projects elegantly
以上是CocoaPods官網(wǎng)對CocoaPods給出的介紹。從這可以看出CocoaPods是一個依賴管理的Swift和Objective-C的C?ocoa項目容达。
CocoaPods項目的源碼 在 Github 上管理贝室。該項目開始于 2011 年 8 月 12 日丧失,經(jīng)過多年發(fā)展借帘,現(xiàn)在已經(jīng)成為 iOS 開發(fā)事實上的依賴管理標準工具倘要。開發(fā) iOS 項目不可避免地要使用第三方開源庫赶舆,CocoaPods 的出現(xiàn)使得我們可以節(jié)省設(shè)置和更新第三方開源庫的時間踪栋。
CocoaPods的安裝和使用
安裝方式異常簡單 , Mac 下都自帶 ruby敛腌,使用 ruby 的 gem 命令即可下載安裝:
$ sudo gem install cocoapods$ pod setup
如果你的 gem 太老卧土,可能也會有問題,可以嘗試用如下命令升級 gem:
$ sudo gem update --system
另外像樊,ruby 的軟件源 https://rubygems.org 因為使用的是亞馬遜的云服務(wù)尤莺,所以被墻了,需要更新一下 ruby 的源生棍,使用如下代碼將官方的 ruby 源替換成國內(nèi)淘寶的源:
gem sources --remove https://rubygems.org/gem sources -a https://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/目錄下,這個索引文件比較大霸琴。所以第一次更新時非常慢椒振。
一個叫 akinliu 的朋友在 gitcafe 和 oschina 上建立了 CocoaPods 索引庫的鏡像,因為 gitcafe 和 oschina 都是國內(nèi)的服務(wù)器梧乘,所以在執(zhí)行索引更新操作時杠人,會快很多。如下操作可以將 CocoaPods 設(shè)置成使用 gitcafe 鏡像:
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 的文件嗡善,以如下格式,將依賴的庫名字依次列在文件中即可
platform :ios
pod 'JSONKit', '~> 1.4'
pod 'Reachability', '~> 3.0.0'
pod 'ASIHTTPRequest'
pod 'RegexKitLite'
然后你將編輯好的 Podfile 文件放到你的項目根目錄中学歧,執(zhí)行如下命令即可:
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 查找到的所有可用的庫:
$ 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)于 Podfile.lock
當你執(zhí)行pod install
之后洒缀,除了 Podfile 外,CocoaPods 還會生成一個名為Podfile.lock
的文件欺冀,Podfile.lock 應(yīng)該加入到版本控制里面树绩,不應(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文件:
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空厌。如下是一個示例:
pod 'MyCommon', :podspec => 'https://yuantiku.com/common/myCommon.podspec'
不更新 podspec CocoaPods 在執(zhí)行pod install和pod update時庐船,會默認先更新一次podspec索引。使用--no-repo-update參數(shù)可以禁止其做索引更新操作嘲更。如下所示:
pod install --no-repo-updatepod update --no-repo-update
生成第三方庫的幫助文檔如果你想讓 CococaPods 幫你生成第三方庫的幫助文檔筐钟,并集成到 Xcode 中,那么用 brew 安裝 appledoc 即可:
brew install appledoc
關(guān)于 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ù)彻舰。