CocoaPods 簡介
它是iOS最常用的第三方庫依賴管理工具行施,且絕大多數(shù)優(yōu)秀的開源框架都支持CocoaPods允坚。
CocoaPods項(xiàng)目的源碼 在 Github 上管理。該項(xiàng)目開始于 2011 年 8 月 12 日蛾号,開發(fā) iOS 項(xiàng)目不可避免地要使用第三方開源庫稠项,CocoaPods 的出現(xiàn)使得我們可以節(jié)省設(shè)置和更新第三方開源庫的時(shí)間。
原理
CocoaPods 是將所有的依賴庫都放到另一個(gè)名為 Pods 項(xiàng)目中须教,然后讓主項(xiàng)目依賴 Pods 項(xiàng)目皿渗,這樣,源碼管理工作都從主項(xiàng)目移到了 Pods 項(xiàng)目中轻腺。
1)Pods 項(xiàng)目最終會(huì)編譯成一個(gè)名為 libPods.a 的文件乐疆,主項(xiàng)目只需要依賴這個(gè) .a 文件即可。
2)對于資源文件贬养,CocoaPods 提供了一個(gè)名為 Pods-resources.sh 的 bash 腳本挤土,該腳本在每次項(xiàng)目編譯的時(shí)候都會(huì)執(zhí)行,將第三方庫的各種資源文件復(fù)制到目標(biāo)目錄中误算。
3)CocoaPods 通過一個(gè)名為 Pods.xcconfig 的文件來在編譯時(shí)設(shè)置所有的依賴和參數(shù)仰美。
CocoaPods 的安裝
安裝
安裝方式異常簡單 , Mac 下都自帶 ruby,使用 ruby 的 gem 命令即可下載安裝:
$ sudo gem install cocoapods
$ pod setup
如果你的 gem 太老儿礼,可能也會(huì)有問題咖杂,可以嘗試用如下命令升級 gem:
$ sudo gem update --system
然而這樣執(zhí)行命令,卻會(huì)出錯(cuò)蚊夫,
這是因?yàn)閞uby 的軟件源 https://rubygems.org 因?yàn)槭褂玫氖莵嗰R遜的云服務(wù)诉字,所以被墻了,需要更新一下 ruby 的源,使用如下代碼將官方的 ruby 源替換成國內(nèi)淘寶的源:
$ gem sources --remove https:
//rubygems.org/
$ gem sources -a https:
//ruby.taobao.org/
$ gem sources -l
然后再執(zhí)行之前的命令:
$ sudo gem install cocoapods
$ pod setup
有一點(diǎn)需要注意壤圃,pod setup在執(zhí)行時(shí)陵霉,會(huì)輸出Setting up CocoaPods master repo,但是會(huì)等待比較久的時(shí)間伍绳。這一步其實(shí)是 Cocoapods 在將它的信息下載到 ~/.cocoapods目錄下踊挠,如果你等太久,可以試著 cd 到那個(gè)目錄冲杀,用du -sh *來查看下載進(jìn)度效床。你也可以使用 cocoapods 的鏡像來提高下載速度。
使用 CocoaPods 的鏡像索引
所有的項(xiàng)目的 Podspec 文件都托管在https://github.com/CocoaPods/Specs 漠趁。第一次執(zhí)行pod setup時(shí)扁凛,CocoaPods 會(huì)將這些podspec索引文件更新到本地的 ~/.cocoapods/
目錄下,這個(gè)索引文件比較大闯传,有 80M 左右。所以第一次更新時(shí)非常慢卤妒。
一個(gè)叫 akinliu 的朋友在 gitcafe 和 oschina 上建立了 CocoaPods 索引庫的鏡像甥绿,因?yàn)?gitcafe 和 oschina 都是國內(nèi)的服務(wù)器,所以在執(zhí)行索引更新操作時(shí)则披,會(huì)快很多共缕。如下操作可以將 CocoaPods 設(shè)置成使用 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
使用時(shí)需要新建一個(gè)名為 Podfile 的文件士复,以如下格式图谷,將依賴的庫名字依次列在文件中即可
platform :ios
pod 'JSONKit', '~> 1.4'
pod 'Reachability', '~> 3.0.0'
然后將編輯好的 Podfile 文件放到項(xiàng)目根目錄中,執(zhí)行如下命令即可:
$ cd
"your project home"
$ pod install
現(xiàn)在阱洪,所有的第三方庫都已經(jīng)下載完成并且設(shè)置好了編譯參數(shù)和依賴便贵,需要記住如下 2 點(diǎn):
1)使用 CocoaPods 生成的 *.xcworkspace 文件來打開工程,而不是以前的 *.xcodeproj 文件冗荸。
2)每次更改了 Podfile 文件承璃,需要重新執(zhí)行一次pod update命令。
查找第三方庫
如果不知道 cocoaPods 管理的庫中蚌本,是否有你想要的庫盔粹,那么可以通過 pod search 命令進(jìn)行查找,以下是用 pod search json 查找到的所有可用的庫:
<span class="nv">$ pod search json</span><br>
-> AFJSONPRequestOperation (1.0.0)
AFNetworking Extension for the JSONP format.
pod 'AFJSONPRequestOperation','~> 1.0.0'
- Homepage: https:
//github.com/acerbetti/AFJSONPRequestOperation
- Source: https:
//github.com/acerbetti/AFJSONPRequestOperation.git
- Versions: 1.0.0 [master repo]
-> AFJSONRPCClient (2.1.1)
A JSON-RPC client build on AFNetworking.
pod 'AFJSONRPCClient','~> 2.1.1'
- Homepage: https:
//github.com/AFNetworking/AFJSONRPCClient
- Source: https:
//github.com/AFNetworking/AFJSONRPCClient.git
- Versions: 2.1.1, 2.1.0, 2.0.0, 1.0.0, 0.4.0, 0.3.1, 0.3.0 [master repo]
-> ARSafeJSON (0.0.7)
ARSafeJSON is a small library that will strip all occurences of NSNull from a JSON of any depth.
pod 'ARSafeJSON', '~> 0.0.7'
- Homepage: https:
//bitbucket.org/antoine_r/arsafejson
- Source: https:
//bitbucket.org/antoine_r/arsafejson.git
- Versions: 0.0.7, 0.0.3 [master repo]
...
//以下省去若干行
關(guān)于 Podfile.lock
當(dāng)執(zhí)行pod install之后程癌,除了 Podfile 外舷嗡,CocoaPods 還會(huì)生成一個(gè)名為Podfile.lock的文件,Podfile.lock 應(yīng)該加入到版本控制里面嵌莉,不應(yīng)該把這個(gè)文件加入到.gitignore中进萄。因?yàn)镻odfile.lock會(huì)鎖定當(dāng)前各依賴庫的版本,之后如果多次執(zhí)行pod install不會(huì)更改版本,要pod update才會(huì)改Podfile.lock了垮斯。這樣多人協(xié)作的時(shí)候郎仆,可以防止第三方庫升級時(shí)造成大家各自的第三方庫版本不一致。
CocoaPods 的這篇 官方文檔 也在What is a Podfile.lock一節(jié)中介紹了Podfile.lock的作用兜蠕,并且指出:
"This file should always be kept under version control."
為自己的項(xiàng)目創(chuàng)建 podspec 文件我們可以為自己的開源項(xiàng)目創(chuàng)建podspec文件扰肌,首先通過如下命令初始化一個(gè)podspec文件:
$ pod spec create your_pod_spec_name
該命令執(zhí)行之后,CocoaPods 會(huì)生成一個(gè)名為your_pod_spec_name.podspec的文件熊杨,然后我們修改其中的相關(guān)內(nèi)容即可曙旭。
具體步驟可以參看:
《如何編寫一個(gè) CocoaPods 的 spec 文件》
《Cocoapods 入門》。
使用私有的 pods
我們可以直接指定某一個(gè)依賴的podspec晶府,這樣就可以使用團(tuán)隊(duì)內(nèi)部的私有庫桂躏。該方案有利于使團(tuán)隊(duì)內(nèi)部的公共項(xiàng)目支持 CocoaPods。如下是一個(gè)示例:
$ pod
'MyCommon'
, :podspec =>
'https://yuantiku.com/common/myCommon.podspec'
不更新 podspec
CocoaPods 在執(zhí)行pod install
和pod update
時(shí)川陆,會(huì)默認(rèn)先更新一次podspec索引剂习。使用--no-repo-update參數(shù)可以禁止其做索引更新操作。如下所示:
$ pod install --no-repo-update
$ pod update --no-repo-update
生成第三方庫的幫助文檔
如果想利用 CococaPods 生成第三方庫的幫助文檔较沪,并集成到 Xcode 中鳞绕,那么用 brew 安裝 appledoc 即可:
$ brew install appledoc
關(guān)于 appledoc,可以參看 《使用 Objective-C 的文檔生成工具:appledoc》 中有專門介紹尸曼。它最大的優(yōu)點(diǎn)是可以將幫助文檔集成到 Xcode 中们何,這樣你在敲代碼的時(shí)候,按住 option 鍵單擊類名或方法名控轿,就可以顯示出相應(yīng)的幫助文檔冤竹。