前言
在iOS項目中使用第三方類庫可以說是非常常見的事,但是要正確地配置他們有時候是非常繁瑣的事情,幸運的是CocoaPods是一個很好的解決方案。
什麼是CocoaPods
CocoaPods是OS X和iOS下的一個第三類庫管理工具,通過CocoaPods工具我們可以爲項目添加被稱爲“Pods”的依賴庫(這些類庫必須是CocoaPods本身所支持的),並且可以輕鬆管理其版本。
Cocoapods意義體現在兩個方面。第一,在引入第三方庫時它可以自動爲我們完成各種各樣的配置,包括配置編譯階段、連接器選項、甚至是ARC環境下的-fno-objc-arc配置等。第二,使用CocoaPods可以很方便地查找新的第三方庫,這些類庫是比較“標準的”,而不是網上隨便找到的,這樣可以讓我們找到真正好用的類庫。
接下來我們將介紹CocoaPods的使用。
CocoaPods的核心組件
CocoaPods是用Ruby寫的,並劃分成了若干個Gem包。
CocoaPods在解析執行過程中最重要的幾個包的路徑分別是:CocoaPods/CocoaPods、 CocoaPods/Core 和 CocoaPods/Xcodeproj。
CocoaPods / CocoaPod:這是面向用戶的組件,每當執行一個pod命令時,這個組件將被激活。它包括了所有實用CocoaPods的功能,並且還能調用其他gem包來執行任務。
CocoaPods / Core:Core gem提供了與CocoaPods相關的文件(主要是podfile和podspecs)的處理。
Podfile:該文件用於配置項目所需要的第三方庫,它可以被高度定製。本文中我們主要在這裏做動作。Podspec:該文件描述了一個庫將怎樣被添加進工程中。.podspec文件可以標識該第三方庫所需要的源碼文件、依賴庫、編譯選項,以及其他第三方庫需要的配置。 CocoaPods / Xcodeproj:這個包負責處理工程文件,它能創建以及修改.xcodeproj文件和.xcworkspace文件。它也可以作爲一個獨立的包使用,當你要編寫修改項目文件的腳本時,可以考慮使用CocoaPods/Xcodeproj。
下載和安裝CocoaPods
上面已經提到,CocoaPods是用Ruby寫的,所以運行需要安裝Ruby環境。Mac中已經自帶Ruby環境,這個不用我們擔心,如果認爲Ruby環境不夠新,我們可以先更新,打開終端,輸入以下命令:
1.
gem
update --system
接下來我們可以安裝CocoaPods了,在安裝前,我們先做點小動作。
由於安裝CocoaPods時我們要訪問cocoapods.org,該網站可能被我們大天朝牆了,這樣下載安裝可能會是龜速,幸好我們可以用淘寶的Ruby鏡像來訪問該網站,方法如下:
1.
$
gem sources --remove https:
//rubygems.org/
2.
$
gem sources -a http:
//ruby.taobao.org/
成功後,使用以下命令查看:
1.
$
gem sources -l
可以看到替換鏡像成功:
1.
***
CURRENT SOURCES ***
2.
3.
http:
//ruby.taobao.org/
接下來是真正的安裝,在終端輸入以下命令:
1.
$
sudo gem install cocoapods
安裝輸出非常長,這裏就不貼出來了。
然後使用setup命令配置CocoaPods(這個命令也可以不運行,但是第一次使用pod命令時這個setup過程也會自動執行)
1.
AppledeMacBook-Pro:~
apple$ pod setup
2.
Setting
up CocoaPods master repo
3.
Setup
completed (read-only access)
這個時間可能比較長,耐心等待下。
使用CocoaPods爲工程配置第三方類庫
首先打開Xcode新建一個工程,假設爲Desktop/CocoaPodsDemo,並且我們要往該工程中導入AFNetworking這個類庫。
AFNetworking在Github中的地址爲:https://github.com/AFNetworking/AFNetworking
這裏也說明了如何使用CocoaPods配置該類庫:
以上說明是我們應該如何書寫Podfile文件。一般非常流行和成熟的類庫都得到了CocoaPods的支持,並且有這個說明。
如何確定CocoaPods是否支持我們想要加入的目標類庫?使用Search命令搜索類庫名:
1.
$
pod search AFNetworking
如果CocoaPods支持,將會輸出搜索到的所有類庫版本和信息,以及在Podfile中配置的寫法,例如:
01.
->
AFNetworking (
2.1
.
0
)
02.
A
delightful iOS and OS X networking framework.
03.
pod
'AFNetworking'
,
'~>
2.1.0'
04.
-
Homepage: https:
//github.com/AFNetworking/AFNetworking
05.
-
Source: https:
//github.com/AFNetworking/AFNetworking.git
06.
-
Versions:
2.1
.
0
,
2.0
.
3
,
2.0
.
2
,
2.0
.
1
,
2.0
.
0
-RC3,
2.0
.
0
-RC2,
2.0
.
0
-RC1,
07.
2.0
.
0
,
1.3
.
3
,
1.3
.
2
,
1.3
.
1
,
1.3
.
0
,
1.2
.
1
,
1.2
.
0
,
1.1
.
0
,
1
.0RC3,
1
.0RC2,
08.
1
.0RC1,
1.0
.
1
,
1.0
,
0.9
.
2
,
0.9
.
1
,
0.9
.
0
,
0.7
.
0
,
0.5
.
1
,
0.10
.
1
,
0.10
.
0
[master
09.
repo]
10.
-
Sub specs:
11.
-
AFNetworking/Serialization (
2.1
.
0
)
12.
-
AFNetworking/Security (
2.1
.
0
)
13.
-
AFNetworking/Reachability (
2.1
.
0
)
14.
-
AFNetworking/NSURLConnection (
2.1
.
0
)
15.
-
AFNetworking/NSURLSession (
2.1
.
0
)
16.
-
AFNetworking/UIKit (
2.1
.
0
)
17.
18.
19.
->
AFNetworking+AutoRetry (
0.0
.
2
)
20.
Auto
Retries
for
AFNetworking
requests
21.
pod
'AFNetworking+AutoRetry'
,
'~>
0.0.2'
22.
-
Homepage: https:
//github.com/shaioz/AFNetworking-AutoRetry
23.
-
Source: https:
//github.com/shaioz/AFNetworking-AutoRetry.git
24.
-
Versions:
0.0
.
2
,
0.0
.
1
[master
repo]
25.
26.
27.
->
AFNetworking-RACExtensions (
0.1
.
2
)
28.
AFNetworking-RACExtensions
is a delightful extension to the AFNetworking
29.
classes
for
iOS
and Mac OS X.
30.
pod
'AFNetworking-RACExtensions'
,
'~>
0.1.2'
31.
-
Homepage: https:
//github.com/CodaFi/AFNetworking-RACExtensions
32.
-
Source: https:
//github.com/CodaFi/AFNetworking-RACExtensions.git
33.
-
Versions:
0.1
.
2
,
0.1
.
1
,
0.0
.
1
[master
repo]
34.
35.
36.
->
AFNetworking-ReactiveCocoa (
0.0
.
2
)
37.
Make
AFNetworking reactive.
38.
pod
'AFNetworking-ReactiveCocoa'
,
'~>
0.0.2'
39.
-
Homepage: https:
//github.com/uasi/AFNetworking-ReactiveCocoa
40.
-
Source: https:
//github.com/uasi/AFNetworking-ReactiveCocoa.git
41.
-
Versions:
0.0
.
2
,
0.0
.
1
[master
repo]
42.
43.
44.
->
AFNetworking-Synchronous (
0.2
.
0
)
45.
Synchronous
requests
for
AFNetworking
46.
pod
'AFNetworking-Synchronous'
,
'~>
0.2.0'
47.
-
Homepage: https:
//github.com/paulmelnikow/AFNetworking-Synchronous
48.
-
Source: https:
//github.com/paulmelnikow/AFNetworking-Synchronous.git
49.
-
Versions:
0.2
.
0
,
0.1
.
0
[master
repo]
先看看普通的工程目錄:
好吧,進入主題,首先在我們的工程目錄下創建Podfile文件,該文件用來控制CocoaPods的下載內容,該文件是沒有後綴的,每個項目只需要一個Podfile文件,如果需要導入多個類庫那麼統一在該文件中書寫下載內容。
創建過程:首先cd到工程目錄,然後創建Podfile並且使用vim編寫:
1.
AppledeMacBook-Pro:~
apple$ cd Desktop/CocoaPodsDemo/
2.
AppledeMacBook-Pro:CocoaPodsDemo
apple$ touch Podfile
01.
platform:ios,
'7.0'
02.
pod
"AFNetworking"
,
"~>2.1"
03.
~
04.
~
05.
~
06.
~
07.
~
08.
~
09.
~
10.
~
11.
~
12.
~
13.
~
14.
~
15.
~
16.
~
17.
~
18.
~
19.
~
20.
~
21.
~
22.
~
23.
~
24.
:wq
在編輯完成後先按esc,再按“:”,輸入wq保存並退出。
Podfile中的兩句文字的意思是,當前AFNetworking支持的iOS最高版本是iOS 7.0, 要下載的AFNetworking版本是2.1。
也可以用文本編輯工具打開該文件進行編輯,命令如下:
1.
open
-e Podfile
這裏我同時爲Demo安裝AFNetworking,JSONKit和MBProgressHUD三個類庫,Podfile文件內容如下:
1.
platform:ios,
'7.0'
2.
pod
'AFNetworking'
,
'~>
2.1.0'
3.
pod
'JSONKit-NoWarning'
,
'~>
1.1'
4.
pod
'MBProgressHUD'
,
'~>
0.8'
在有了Podfile後,輸入以下命令安裝類庫:
1.
$
pod install
安裝完成後,輸出信息如下:
01.
$
pod install
02.
Analyzing
dependencies
03.
Downloading
dependencies
04.
Installing
AFNetworking (
2.1
.
0
)
05.
Installing
JSONKit-NoWarning (
1.1
)
06.
Installing
MBProgressHUD (
0.8
)
07.
Generating
Pods project
08.
Integrating
client project
09.
10.
[!]
From now on use `CocoaPodsDemo.xcworkspace`.
最後一句表面,如果要正確打開工程我們應該打開最新生成的.xcworkspace文件。
可以看到工程目錄發生變化了,三個類庫都安裝上了:
打開Build Phases,可以看到CocoaPods已經自動爲我們完成了所有設置:
之後我們可以在工程中導入AFNetworking、JSONKit和MBProgressHUD的任意頭文件並使用其所有接口了:
1.
#
import
"ViewController.h"
2.
#
import
<afnetworking
afnetworking.h=
""
>
3.
#
import
<jsonkit-nowarning
jsonkit.h=
""
>
4.
#
import
<mbprogresshud
mbprogresshud.h=
""
></mbprogresshud></jsonkit-nowarning></afnetworking>
上面說的內容略多。。。但是總的來說我們就做了兩件事:新建Podfile文件並編寫要導入的類庫信息,打開終端輸入pod install命令安裝,完成。一切都是如此的方便。
Damn, it is awesome.
正確編譯運行一個包含CocoaPods類庫的項目
如果一個項目中已經包含了CocoaPods的配置文件,但是編譯卻出現錯誤,那麼我們僅需要一行命令就可以配置好所有的第三方類庫了:
1.
$
pod update
參考Demo的項目地址:https://github.com/UrbanApps/UAAppReviewManager
打開Demo的UAAppReviewManagerExample目錄,可以發現少了一個xcworkspace文件,另外還有幾個CocoaPods的配置文件在這裏:
打開Podfile文件看看:
01.
target
'UAAppReviewManagerExampleiOS'
do
02.
platform
:ios,
'5.1'
03.
pod
'UAAppReviewManager'
,
:path =>
'..'
04.
end
05.
06.
target
'UAAppReviewManagerExampleMac'
do
07.
platform
:osx,
'10.7'
08.
pod
'UAAppReviewManager'
,
:path =>
'..'
09.
end
platform表示類庫支持的最高版本,該類庫的target包括了iOS和Mac。而path指定了到上級目錄去查找該類庫的安裝信息。
編譯工程,將會出錯,原因是我們沒有將類庫鏈接到工程中:
因此我們要用pod命令進行安裝。cd到Example目錄下執行pod install命令,將會報錯:
1.
$
pod install
2.
Analyzing
dependencies
3.
Fetching
podspec
for
`UAAppReviewManager`
from `..`
4.
[!]
Unable to satisfy the following requirements:
5.
-
`UAAppReviewManager (from `..`)` required by `Podfile`
原因是要添加的類庫已經有最新版本推出,而Podfile文件並沒有更改其下載版本(Podfile文件過期),於是獲取安裝數據失敗。
因此我們要用update命令獲取最新版本的類庫:
01.
$
pod update
02.
Analyzing
dependencies
03.
Fetching
podspec
for
`UAAppReviewManager`
from `..`
04.
Downloading
dependencies
05.
Installing
UAAppReviewManager (
0.2
.
1
)
06.
Generating
Pods project
07.
Integrating
client project
08.
09.
[!]
From now on use `UAAppReviewManagerExample.xcworkspace`.
同樣地我們成功生成了xcworkspace文件:
再編譯運行就沒問題了。
補充
當Cocoapods向項目中增加了一個第三方庫的時候,不僅僅只是添加代碼,由於每個第三方類庫有不同的target,所以每次添加第三方庫時,都會有幾個文件被寫入磁盤,包括Podfile.lock和Manifest.lock文件等。
其中Podfile.lock記錄了需要被安裝的pod的每個已安裝的版本。如果你想知道已安裝的pod是哪個版本,可以查看這個文件。
Manifest.lock是每次運行pod install時創建的Podfile.lock文件的副本