使用CocoaPods（一）為專案配置第三方類庫

未知原稿人, 筆者2016/5/20大幅修改.
更新:
2016.05.20 大量修改
2018.05.23 ruby環境改為使用https://gems.ruby-china.org/ <最新更新>

前言
在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環境不夠新，我們可以先更新.
開啟終端，輸入以下命令：

gem update –system

接下來我們可以安裝CocoaPods了，在安裝前，我們先做點小動作。
由於安裝CocoaPods時我們要訪問cocoapods.org，該網站可能被我們大天朝牆了，這樣下載安裝可能會是龜速，幸好我們可以用淘寶的Ruby映象來訪問該網站，方法如下：（其中$後面的才是要輸入的東西！！！）

$ gem sources --remove https://rubygems.org/  

$ gem sources -a https://ruby.taobao.org/  

最近貌似淘寶的也不管用了, 改用ruby-china的網站

$ gem sources -a https:
 
//gems.ruby-china.org/  

成功後，使用以下命令檢視：

$ gem sources -l  

可以看到替換映象成功：

1.      *** CURRENT SOURCES ***  
2.        
3.      https://gems.ruby-china.org/   

接下來是真正的安裝，在終端輸入以下命令：

sudo gem install cocoapods  

安裝輸出非常長, 如果安裝過程出現錯誤提示:

    ERROR:  While executing gem ... (Errno::EPERM)
        Operation not permitted - /usr/bin/fuzzy_match

就在終端中輸入:

sudo gem install -n /usr/local/bin cocoapods

回車, 即可解決問題, 之後會出現一長串的資訊, 資訊最後有一行提示:

    17 gems installed

然後輸入:

pod setup

回車, 會提示:

Setting up CocoaPods master repo

然後使用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命令搜尋類庫名：

    $ pod search afnetworking  (注意深入小寫的字元)

如果CocoaPods支援，將會輸出搜尋到的所有類庫版本和資訊，以及在Podfile中配置的寫法，例如：

1.  -> AFNetworking (2.1.0)  
2.     A delightful iOS and OS X networking framework.  
3.     pod 'AFNetworking', '~> 2.1.0'  
4.     - Homepage: https://github.com/AFNetworking/AFNetworking  
5.     - Source:   https://github.com/AFNetworking/AFNetworking.git  
6.     - 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,  
7.     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,  
8.     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  
9.     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檔案，如果需要匯入多個類庫那麼統一在該檔案中書寫下載內容。
建立過程：
1>首先cd到工程目錄(command+n在新的終端中輸入cd空格然後直接拖工程資料夾到終端中即可得到工程目錄);
2>然後建立Podfile
$ touch Podfile
並且使用vim編寫: <在終端輸入vim Podfile>然後回車，然後在出現的vim編輯器裡面點選字母i(即insert的意思),就可以進行編輯。

1.  platform:ios, '9.2'  
2.  pod "AFNetworking", "~>3.1"  
3.  ~                                                                                 
4.  ~                                                                                 
5.                  
6.  ~                                                                                 
7.  ~                                                                                 
8.  :wq  

注意: 由於我的安裝過程出現了

    ERROR:  While executing gem ... (Errno::EPERM)
            Operation not permitted - /usr/bin/fuzzy_match

因此在Podfile中的設定跟以上有些不同:

platform :ios, ‘9.2’
use_frameworks!

target 'UISenior-0520CocoaPods' do
  pod 'AFNetworking', '~> 3.1.0’
  pod 'JSONKit-NoWarning', '~> 1.2'
end

在編輯完成後先按esc，再按“:”，輸入wq儲存並退出。

:wq

Podfile中的兩句文字的意思是, 當前AFNetworking支援的iOS最高版本是iOS 9.2, 要下載的AFNetworking版本是3.1。

PS: 也可以用文字編輯工具開啟該檔案進行編輯, 終端命令如下：

1.  open -e Podfile  

這裡我同時為Demo安裝AFNetworking，JSONKit兩個類庫，Podfile檔案內容如下：

platform :ios, ‘9.2’
use_frameworks!

target 'UISenior-0520CocoaPods' do
  pod 'AFNetworking', '~> 3.1.0’
  pod 'JSONKit-NoWarning', '~> 1.2'
end

在有了Podfile後，在終端中輸入以下命令安裝類庫：

1.  $ pod install  

安裝完成後，輸出資訊如下：

1.  $ pod install  
2.  Analyzing dependencies  
3.  Downloading dependencies  
4.  Installing AFNetworking (3.1.0)  
5.  Installing JSONKit-NoWarning (1.2)  
6.  Generating Pods project  
7.  Integrating client project  
8.    
9.  [!] From now on use `CocoaPodsDemo.xcworkspace`.  

最後一句表明，如果要正確開啟工程我們應該開啟最新生成的.xcworkspace檔案。

可以看到工程目錄發生變化了, 兩個類庫都安裝上了：

開啟Build Phases，可以看到CocoaPods已經自動為我們完成了所有設定：

之後我們可以在工程中匯入AFNetworking、JSONKit的任意標頭檔案並使用其所有介面了：

1.  #import "ViewController.h"  
2.  #import "AFNetworking.h"  
3.  #import "JSONKit.h"  

上面說的內容略多! 但是總的來說我們就做了兩件事：新建Podfile檔案並編寫要匯入的類庫資訊，開啟終端輸入pod install命令安裝，完成。一切都是如此的方便。

Damn, it is so awesome.

正確編譯執行一個包含CocoaPods類庫的專案
如果一個專案中已經包含了CocoaPods的配置檔案，但是編譯卻出現錯誤，那麼我們僅需要一行命令就可以配置好所有的第三方類庫了：

1.  $ pod update  

參考Demo的專案地址：https://github.com/UrbanApps/UAAppReviewManager

開啟Demo的UAAppReviewManagerExample目錄，可以發現少了一個xcworkspace檔案，另外還有幾個CocoaPods的配置檔案在這裡：

開啟Podfile檔案看看：

1.  target 'UAAppReviewManagerExampleiOS' do  
2.    platform :ios, '5.1'  
3.    pod 'UAAppReviewManager', :path => '..'  
4.  end  
5.    
6.  target 'UAAppReviewManagerExampleMac' do  
7.    platform :osx, '10.7'  
8.    pod 'UAAppReviewManager', :path => '..'  
9.  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命令獲取最新版本的類庫：

1.  $ pod update  
2.  Analyzing dependencies  
3.  Fetching podspec for `UAAppReviewManager` from `..`  
4.  Downloading dependencies  
5.  Installing UAAppReviewManager (0.2.1)  
6.  Generating Pods project  
7.  Integrating client project  
8.    
9.  [!] From now on use `UAAppReviewManagerExample.xcworkspace`.  

同樣地我們成功生成了xcworkspace檔案：

再編譯執行就沒問題了。

補充
當Cocoapods向專案中增加了一個第三方庫的時候，不僅僅只是新增程式碼，由於每個第三方類庫有不同的target，所以每次新增第三方庫時，都會有幾個檔案被寫入磁碟，包括Podfile.lock和Manifest.lock檔案等。
其中Podfile.lock記錄了需要被安裝的pod的每個已安裝的版本。如果你想知道已安裝的pod是哪個版本，可以檢視這個檔案。
Manifest.lock是每次執行pod install時建立的Podfile.lock檔案的副本。