CocoaPods ：为iOS程序提供依赖管理的工具

CocoaPods的安装和使用介绍

安装

 注：要使用CocoaPods，那就要下载安装它，而下载安装CocoaPods需要Ruby环境

1、Ruby环境搭建

Mac  OS本身自带Ruby，但还是检查更新一下保险，因为我第一次安装在没有更新Ruby的情况下就失败了。

a 查看下当前ruby版本：打开终端输入 ruby -v（确实安装了，不过用这个版本接下来工作失败了，所以更新下ruby，因为ruby的软件源rubygems.org因为使用的亚马逊的云服务，所以被墙了，需要更新一下ruby的源，如下代码将官方的ruby源替换成国内淘宝的源：）

终端输入如下命令（ruby的软件源rubygems.org因为使用的亚马逊的云服务，所以被墙了，需要更新一下ruby的源，如下代码将官方的ruby源替换成国内淘宝的源：）

gem sources --remove https://rubygems.org/ 
gem sources -a http://ruby.taobao.org/ 
gem sources -l  （用来检查使用替换镜像位置成功）

只有在终端中出现下面文字才表明你上面的命令是成功的：

*** CURRENT SOURCES ***
http://ruby.taobao.org/

   1>终端输入：sudo gem install cocoapods    (需要输入管理员密码)

 2>  验证cocoapods是否安装成功

 pod

如何使用CocoaPods？

好了，安装好CocoPods之后，接下来就是使用它。所幸，使用CocoPods和安装它一样简单，也是通过一两行命令就可以搞定。

小编在这里用两种使用场景来具体说明如何使用CocoaPods。

场景1：利用CocoaPods，在项目中导入AFNetworking类库

AFNetworking类库在GitHub地址是：https://github.com/AFNetworking/AFNetworking

1 /为了确定AFNetworking是否支持CocoaPods，可以用CocoaPods的搜索功能验证一下。在终端中输入：

$ pod search AFNetworking

2/ 如果支持所以我们可以利用CocoaPods将AFNetworking导入你的项目中。

首先，我们需要在我们的项目中加入CocoaPods的支持。你可以跟随小编的步骤，先利用Xcode创建一个名字CocoaPodsDemo的项目，用于以下的教程。创建好之后，在继续下一步之前，小编先截图，看看项目没有支持CocoaPods时的项目Xcode目录结构：

上图等一下要跟项目支持CocoaPods之后的项目Xcode目录结构做对比。

你看到这里也许会问，CocoaPods为什么能下载AFNetworking呢，而不是下载其他类库呢？这个问题的答案是，有个文件来控制CocoaPods该下载什么。这个文件就叫做“Podfile”（注意，一定得是这个文件名，而且没有后缀）。你创建一个Podfile文件，然后在里面添加你需要下载的类库，也就是告诉CocoaPods，“某某和某某和某某某，快到碗里来！”。每个项目只需要一个Podfile文件。

好吧，废话少说，我们先创建这个神奇的PodFile。在终端中进入（cd命令）你项目所在目录，然后在当前目录下，利用vim创建Podfile，运行：

$ vim Podfile

然后在Podfile文件中输入以下文字：

platform :ios, ‘7.0‘
pod "AFNetworking", "~> 2.0"

注意，这段文字不是小编凭空生成的，可以在AFNetworking的github页面找到。这两句文字的意思是，当前AFNetworking支持的iOS最高版本是iOS 7.0, 要下载的AFNetworking版本是2.0。

然后保存退出。vim环境下，保存退出命令是：

:wq

这时候，你会发现你的项目目录中，出现一个名字为Podfile的文件，而且文件内容就是你刚刚输入的内容。注意，Podfile文件应该和你的工程文件.xcodeproj在同一个目录下。

这时候，你就可以利用CocoPods下载AFNetworking类库了。还是在终端中的当前项目目录下，运行以下命令：

$ pod install

因为是在你的项目中导入AFNetworking，这就是为什么这个命令需要你进入你的项目所在目录中运行。

运行上述命令之后，小编的终端出现以下信息：

EricmatoMacBook-Pro:CocoaPodsDemo ericwang$ pod install
Analyzing dependencies
Downloading dependencies
Installing AFNetworking (2.0.2)
Generating Pods project
Integrating client project
[!] From now on use `CocoaPodsDemo.xcworkspace`.

注意最后一句话，意思是：以后打开项目就用 CocoaPodsDemo.xcworkspace 打开，而不是之前的.xcodeproj文件。

你也许会郁闷，为什么会出现.xcodeproj文件呢。这正是你刚刚运行$ pod install命令产生的新文件。除了这个文件，你会发现还多了另外一个文件“Podfile.lock”和一个文件夹“Pods”。 点击 CocoaPodsDemo.xcworkspace 打开之后工程之后，项目Xcode目录结构如下图：

你会惊喜地发现，AFNetwoking已经成功导入项目了（红框部分）！

现在，你就可以开始使用AFNetworking.h啦。可以稍微测试一下，在你的项目任意代码文件中输入：

#import <AFNetworking.h>
或者
#import "AFNetworking.h"

然后编译，看看是否出错。如果你严格按照小编上述的步骤来，是不可能出错的啦。

至此，CocoPods的第一个应用场景讲述完毕。别看小编写了这么多，其实过程是十分简单的。总结一下就是：

1. 先在项目中创建Podfile，Podfile的内容是你想导入的类库。一般类库的原作者会告诉你导入该类库应该如何写Podfile；
2. 运行命令：`$ pod install.

下面，小编继续讲述第二种使用场景。

场景2：如何正确编译运行一个包含CocoPods类库的项目

你也许曾经遇到过（特别是新手iOS开发者）这种情况，好不容易在GitHub上找到一份代码符合自己想需求，兴冲冲下载下来，一编译，傻眼了，发现有各种各样错误。一看，原来是缺失了各种其他第三方类库。这时候莫慌，你再仔细一看，会发现你下载的代码包含了Podfile。没错，这意味着你可以用CocoaPods很方便下载所需要的类库。

下面，小编以代码 UAAppReviewManager 为例来说明如何正确编译运行一个包含CocoPods类库的项目。

UAAppReviewManager是一个能够让你方便地将提醒用户评分的功能加入你的应用中。当你去UAAppReviewManager的GitHub地址下载这份代码之后，打开Example工程（UAAppReviewManagerExample），编译，你会发现Xcode报告一大堆错误，基本都是说你编译的这份代码找不到某某头文件，这就意味着你要成功编译UAAppReviewManager的Example代码，必须先导入一些第三方类库。同时你会发现在UAAppReviewManagerExample文件夹下面有三个跟CocosPods相关的文件（文件夹）：Podfile，Podfile.lock和Pods，如下图：

用

这时候，打开终端，进入UAAppReviewManagerExample所在的目录，也就是和Podfile在同一目录下，和场景1一样，输入以下命令（由于已经有Podfile，所以不需要再创建Podfile）：

$ pod update

过几秒（也许需要十几秒，取决于你的网络状况）之后，终端出现：

Analyzing dependencies
Fetching podspec for `UAAppReviewManager` from `../`
Downloading dependencies
Installing UAAppReviewManager (0.1.6)
Generating Pods project
Integrating client project
[!] From now on use `UAAppReviewManagerExample.xcworkspace`.

这时候，再回到UAAppReviewManagerExample文件夹看一看，会看到多了一个文件UAAppReviewManagerExample.xcworkspace：

根据终端的信息提示，你以后就需用新产生的UAAppReviewManagerExample.xcworkspace来运行这个Example代码了。

打开UAAppReviewManagerExample.xcworkspace，编译运行，成功！如下图：

注意，这里有个小问题，如果刚刚你不是输入$ pod update，而是输入$ pod install，会发现类库导入不成功，并且终端出现下面提示：

[!] Required version (UAAppReviewManager (from `../`)) not found for `UAAppReviewManager`.
Available versions: 0.1.6

这里的意思大概是Podfile文件过期，类库有升级，但是Podfile没有更改。$ pod install只会按照Podfile的要求来请求类库，如果类库版本号有变化，那么将获取失败。但是 $ pod update会更新所有的类库，获取最新版本的类库。而且你会发现，如果用了 $ pod update，再用 $ pod install 就成功了。

那你也许会问，什么时候用 $ pod install，什么时候用 $ pod update 呢，我又不知道类库有没有新版本。好吧，那你每次直接用 $ pod update 算了。或者先用 $ pod install，如果不行，再用 $ pod update。

好了，小编就啰嗦到这里吧。上述都只是CocoaPods的最基本用法。要继续研究CocoaPods其他高级用法，请点击这里CocoaPods Wiki。

3、如何使用CocoaPods？

a  新建一个项目，名字PodTest

b  终端中，cd到项目总目录（注意：包含PodTest文件夹、PodTest.xcodeproj、PodTestTest的那个总目录）

[objc] view plaincopyprint?

1. cd /Users/lucky/Desktop/PodTest   

接着上一步，终端输入 vim Podfile

键盘输入 i，进入编辑模式，输入

platform :ios, ‘7.0‘ 
pod ‘MBProgressHUD‘, ‘~> 0.8‘

这段内容来自于github的SDWebImage，一般你需要添加什么样的第三方库，第三方库说明文档中会有pods怎么添加的介绍,如：

输入完成，退出insert模式,按Esc，并且输入“ ：”号进入vim命令模式，然后在冒号后边输入wq

注意：键盘输入 ：后，才能输入wq。回车后发现PodTest项目总目录中多一个Podfile文件

激动人心的时刻到了：确定终端cd到项目总目录，然后输入 pod install（会安装Podfile里面记录的第三方库）。

 取决于网速的环境，安装时间可能会比较久. 注意最后一句话，from now on use ‘podsTest.xcworkspace’,

查看项目根目录：

注意：

多了几个东西，Pods文件夹存放你下载的第三方库.以后打开工程不再是使用xcodeproj,而是使用xcworkspace…因为你打开workspace工作空间，你发现里面包含两个xcodeproj工程文件。一个是本身的工程，一个是Pods管理第三方库的工程。

 d>  正确编译运行一个包含cocoapods类库的第三方库（就是你要用的第三方库又包含依赖其它的第三方库采用cocoapods管理）

进入项目所在目录，输入命令:$pod update  （将文件中的所有第三方库更新到最新版本）

这里就不再举例子了，掌握前面的，这个也就会了。

小结：Podfile文件控制cocoapods该下载什么，文件名一定叫做Podfile且没有后缀。

        每次都优先使用pod update 命令

补充：

1、CocoaPods的基本安装及使用都详细的说明了，但还有一些补充，当需要同时导入多个第三方时候怎么办 ？

这就需要修改Podfile了，就是用vim编辑的那个保存在项目根目录中的文件，修改完了Podfile文件，需要重新执行一次pod install命令。

例如：

platform :ios

pod ‘JSONKit‘,       ‘~> 1.4‘

pod ‘AFNetworking‘,  ‘~> 2.0‘

终端输入命令：pod search UI

疯了了，我怎么查找这么大众的关键字，好多库～～

然后重新编辑Podfile文件，按照之前的步骤，把更多的库都导入项目！

 安装方式异常简单, Mac下都自带ruby，使用ruby的gem命令即可下载安装：

1
            2
            

$ sudo gem install cocoapods
            $ pod setup
            

如果你的gem太老，可能也会有问题，可以尝试用如下命令升级gem:

1
            

sudo gem update --system
            

另外，ruby的软件源rubygems.org因为使用的亚马逊的云服务，所以被墙了，需要更新一下ruby的源，如下代码将官方的ruby源替换成国内淘宝的源：

1
            2
            3
            

gem sources --remove https://rubygems.org/
            gem sources -a http://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镜像：

1
            2
            3
            

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的文件，以如下格式，将依赖的库名字依次列在文件中即可

1
            2
            3
            4
            5
            

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

然后你将编辑好的Podfile文件放到你的项目根目录中，执行如下命令即可：

1
            2
            

cd "your project home"
            pod install
            

现在，你的所有第三方库都已经下载完成并且设置好了编译参数和依赖，你只需要记住如下2点即可：

1. 使用CocoaPods生成的 .xcworkspace 文件来打开工程，而不是以前的 .xcodeproj 文件。
2. 每次更改了Podfile文件，你需要重新执行一次pod update命令。

查找第三方库

你如果不知道cocoaPods管理的库中，是否有你想要的库，那么你可以通过pod search命令进行查找，以下是我用pod search json查找到的所有可用的库：

1
            2
            3
            4
            5
            6
            7
            8
            9
            10
            11
            12
            13
            14
            15
            16
            

$ 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]
            
            // ...以下省略若干行
            

关于.gitignore

当你执行pod install之后，除了Podfile外，CocoaPods还会生成一个名为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文件：

1
            

pod spec create your_pod_spec_name
            

该命令执行之后，CocoaPods会生成一个名为your_pod_spec_name.podspec的文件，然后我们修改其中的相关内容即可。

具体步骤可以参考这两篇博文中的相关内容：《如何编写一个CocoaPods的spec文件》 和《Cocoapods 入门》。

使用私有的pods

我们可以直接指定某一个依赖的podspec，这样就可以使用公司内部的私有库。该方案有利于使企业内部的公共项目支持CocoaPods。如下是一个示例：

1
            

pod ‘MyCommon‘, :podspec => ‘https://yuantiku.com/common/myCommon.podspec‘
            

不更新podspec

CocoaPods在执行pod install和pod update时，会默认先更新一次podspec索引。使用--no-repo-update参数可以禁止其做索引更新操作。如下所示：

1
            2
            

pod install --no-repo-update
            pod update --no-repo-update
            

生成第三方库的帮助文档

如果你想让CococaPods帮你生成第三方库的帮助文档，并集成到Xcode中，那么用brew安装appledoc即可：

1
            

brew install appledoc
            

关于appledoc，我在另一篇博客《使用Objective-C的文档生成工具:appledoc》中有专门介绍。它最大的优点是可以将帮助文档集成到Xcode中，这样你在敲代码的时候，按住opt键单击类名或方法名，就可以显示出相应的帮助文档。

原理

大概研究了一下CocoaPods的原理，它是将所有的依赖库都放到另一个名为Pods项目中，然后让主项目依赖Pods项目，这样，源码管理工作都从主项目移到了Pods项目中。发现的一些技术细节有：

1. Pods项目最终会编译成一个名为libPods.a的文件，主项目只需要依赖这个.a文件即可。
2. 对于资源文件，CocoaPods提供了一个名为Pods-resources.sh的bash脚本，该脚本在每次项目编译的时候都会执行，将第三方库的各种资源文件复制到目标目录中。
3. CocoaPods通过一个名为Pods.xcconfig的文件来在编译时设置所有的依赖和参数。

愿大家玩得开心～