【轉】用CocoaPods作iOS程序的依賴管理 -- 不錯

時間 2019-11-26

標籤 cocoapods ios 程序依賴管理不錯欄目 iOS 简体版

原文原文鏈接

原文網址：http://blog.devtang.com/2014/05/25/use-cocoapod-to-manage-ios-lib-dependency/html

文檔更新說明

2012-12-02 v1.0 初稿
2014-01-08 v1.1 增長設置 ruby 淘寶源相關內容
2014-05-25 v2.0 增長國內 spec 鏡像、使用私有 pod、podfile.lock、建立 spec 文件等內容
2015-09-03 v2.1 優化排版，調整一些描述方式，使文章更易讀懂。
2015-12-21 v2.2 將淘寶的鏡像修改爲 https 的。

CocoaPods 簡介

每種語言發展到一個階段，就會出現相應的依賴管理工具，例如 Java 語言的 Maven，nodejs 的 npm。隨着 iOS 開發者的增多，業界也出現了爲 iOS 程序提供依賴管理的工具，它的名字叫作：CocoaPods。node

CocoaPods項目的源碼在 Github 上管理。該項目開始於 2011 年 8 月 12 日，通過多年發展，如今已經成爲 iOS 開發事實上的依賴管理標準工具。開發 iOS 項目不可避免地要使用第三方開源庫，CocoaPods 的出現使得咱們能夠節省設置和更新第三方開源庫的時間。ios

我在開發猿題庫客戶端時，使用了 24 個第三方開源庫。在沒有使用 CocoaPods 之前，我須要:git

把這些第三方開源庫的源代碼文件複製到項目中，或者設置成 git 的 submodule。
對於這些開源庫一般須要依賴系統的一些 framework，我須要手工地將這些 framework 分別增長到項目依賴中，好比一般狀況下，一個網絡庫就須要增長如下 framework: CFNetwork, SystemConfiguration, MobileCoreServices, CoreGraphics, zlib。
對於某些開源庫，我還須要設置-licucore或者 -fno-objc-arc等編譯參數
管理這些依賴包的更新。

這些體力活雖然簡單，但毫無技術含量而且浪費時間。在使用 CocoaPods 以後，我只須要將用到的第三方開源庫放到一個名爲 Podfile 的文件中，而後執行pod install。
CocoaPods 就會自動將這些第三方開源庫的源碼下載下來，而且爲個人工程設置好相應的系統依賴和編譯參數。github

CocoaPods 的安裝和使用介紹

安裝

安裝方式異常簡單 , Mac 下都自帶 ruby，使用 ruby 的 gem 命令便可下載安裝：npm

$ sudo gem install cocoapods
$ pod setup

若是你的 gem 太老，可能也會有問題，能夠嘗試用以下命令升級 gem:json

sudo gem update --system

另外，ruby 的軟件源 https://rubygems.org 由於使用的是亞馬遜的雲服務，因此被牆了，須要更新一下 ruby 的源，使用以下代碼將官方的 ruby 源替換成國內淘寶的源：xcode

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 的鏡像索引一節的內容來提升下載速度。ruby

使用 CocoaPods 的鏡像索引

全部的項目的 Podspec 文件都託管在https://github.com/CocoaPods/Specs。第一次執行pod setup時，CocoaPods 會將這些podspec索引文件更新到本地的 ~/.cocoapods/目錄下，這個索引文件比較大，有 80M 左右。因此第一次更新時很是慢，筆者就更新了將近 1 個小時才完成。bash

一個叫 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

使用時須要新建一個名爲 Podfile 的文件，以以下格式，將依賴的庫名字依次列在文件中便可

platform :ios
pod 'JSONKit',       '~> 1.4'
pod 'Reachability',  '~> 3.0.0'
pod 'ASIHTTPRequest'
pod 'RegexKitLite'

而後你將編輯好的 Podfile 文件放到你的項目根目錄中，執行以下命令便可：

cd "your project home"
pod install

如今，你的全部第三方庫都已經下載完成而且設置好了編譯參數和依賴，你只須要記住以下 2 點便可：

使用 CocoaPods 生成的 .xcworkspace 文件來打開工程，而不是之前的 .xcodeproj 文件。
每次更改了 Podfile 文件，你須要從新執行一次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]

// ... 如下省略若干行

關於 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的文件，而後咱們修改其中的相關內容便可。

具體步驟能夠參考這兩篇博文中的相關內容：

使用私有的 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 鍵單擊類名或方法名，就能夠顯示出相應的幫助文檔。

原理

大概研究了一下 CocoaPods 的原理，它是將全部的依賴庫都放到另外一個名爲 Pods 項目中，而後讓主項目依賴 Pods 項目，這樣，源碼管理工做都從主項目移到了 Pods 項目中。發現的一些技術細節有：

Pods 項目最終會編譯成一個名爲 libPods.a 的文件，主項目只須要依賴這個 .a 文件便可。
對於資源文件，CocoaPods 提供了一個名爲 Pods-resources.sh 的 bash 腳本，該腳本在每次項目編譯的時候都會執行，將第三方庫的各類資源文件複製到目標目錄中。
CocoaPods 經過一個名爲 Pods.xcconfig 的文件來在編譯時設置全部的依賴和參數。

願你們玩得開心～