這篇文章主要是轉載唐巧的,文章底部也有大神寫的原文連接,其中在有些地方根據自己的使用稍微修改了一點點,當然,不是說大神唐巧寫的不對,是在自己使用習慣而已。
CocoaPods 簡介
每種語言發展到一個階段,就會出現相應的依賴管理工具,例如 Java 語言的 Maven,nodejs 的 npm。隨著 iOS 開發者的增多,業界也出現了為 iOS 程序提供依賴管理的工具,它的名字叫做:CocoaPods。
CocoaPods項目的源碼 在 Github 上管理。該項目開始于 2011 年 8 月 12 日,經過多年發展,現在已經成為 iOS 開發事實上的依賴管理標準工具。開發 iOS 項目不可避免地要使用第三方開源庫,CocoaPods 的出現使得我們可以節省設置和更新第三方開源庫的時間。
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 https://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 左右。所以第一次更新時非常慢,筆者就更新了將近 1 個小時才完成。
一個叫 akinliu 的朋友在 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 上的鏡像。
使用 CocoaPods
首先 cd
到你的工程路徑
執行 pod init
命令。這時候在工程路徑下會生成一個 名為Podfile
的文件,打開文件(可以用Xcode打開),就像下面
# Uncomment this line to define a global platform for your project
platform :ios, '8.0' // 這里前面的注釋符號 # 去掉
# Uncomment this line if you're using Swift
# use_frameworks!
target '你的工程名字' do
// 在這里,添加你要使用的第三方庫 ,例如:
pod 'SDWebImage'
pod 'AFNetworking'
end
保存文件,然后執行如下命令:
pod install // 也可以使用 pod install --no-repo-update 原因下面有介紹
等待完成,現在,你的所有第三方庫都已經下載完成并且設置好了編譯參數和依賴,你只需要記住如下 2 點即可:
- 1.使用 CocoaPods 生成的
.xcworkspace
文件來打開工程,而不是以前的.xcodeproj
文件。 - 2.每次更改了 Podfile 文件,你需要重新執行一次
pod update // 也可以使用 pod update --no-repo-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.
為自己的項目創建 podspec 文件
我們可以為自己的開源項目創建podspec
文件,首先通過如下命令初始化一個podspec
文件:
pod spec create your_pod_spec_name
該命令執行之后,CocoaPods 會生成一個名為 your_pod_spec_name.podspec
的文件,然后我們修改其中的相關內容即可。具體步驟可以參考這兩篇博文中的相關內容:
《如何編寫一個 CocoaPods 的 spec 文件》
《Cocoapods 入門》。
使用私有的 pods
我們可以直接指定某一個依賴的podspec,這樣就可以使用公司內部的私有庫。該方案有利于使企業內部的公共項目支持 CocoaPods。如下是一個示例:
pod 'MyCommon', :podspec => 'https://yuantiku.com/common/myCommon.podspec'
不更新 podspec
CocoaPods 在執行pod install
和 pod update
時,會默認先更新一次 podspec
索引。使用--no-repo-update
參數可以禁止其做索引更新操作。如下所示:
pod install --no-repo-update
pod update --no-repo-update
生成第三方庫的幫助文檔
如果你想讓 CococaPods 幫你生成第三方庫的幫助文檔,并集成到 Xcode 中,那么用 brew
安裝appledoc
即可:
brew install appledoc
關于 appledoc,唐巧在另一篇博客 《使用 Objective-C 的文檔生成工具:appledoc》 中有專門介紹。它最大的優點是可以將幫助文檔集成到 Xcode 中,這樣你在敲代碼的時候,按住 opt 鍵單擊類名或方法名,就可以顯示出相應的幫助文檔。