如何使用CocoaPods

什么是CocoaPods

CocoaPods是Xcode上的依赖管理工具。官网：https://cocoapods.org/。

如果不使用依赖管理工具，那么当使用第三方库的时候就会苦不堪言。你需要把第三方库的源代码拷贝到工程中，如果这些库本身还有其它framework的依赖关系，那么还需要手动倒入。尤其是将来有更新的时候，更加的麻烦。但是使用了CocoaPods以后，这些工作CocoaPods都可以帮你完成。

如何安装CocoaPods

关于Ruby

CocoaPods是用Ruby来Build的，所以用Ruby的命令就可以进行安装。Mac OSX本身自带Ruby。在terminal里就能完成安装。如果你的gem版本比较低，可以在terminal里输入如下命令行来更新Ruby：

$ sudu gem update --system

需要输入sudu的密码。

gem命令

我们使用Ruby的gem命令，来安装CocoaPods，敲入如下命令行：

$ sudo gem install cocoapods

然后需要输入sudo的密码，接着就开始安装了。

如果你在国内，很可能会遇到下图中的错误：

Could not find a valid gem 'cocoapods' (>=0), here is why: 
Unable to download data from https://rubygems.org/ -Errno: ECONNRESET: Connection reset by peer - SSL_connect
(https://rubygems.org/latest_specs.4.8.gz)

这是因为，Ruby的软件源（rubygems.org）使用的是亚马逊的云服务，而亚马逊的云服务被屏蔽了。所以我们要加个源。在terminal里输入如下命令行：

$ gem sources --add http://rubygems.org/

输入之后，会提示你https的比http更加安全，不用管，再次执行安装命令行进行安装。

当然，如果原来的https源不需要了，也可以remove掉：

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

此外，如果不想使用http://rubygems.org/的源，在国内的淘宝也有相应的源，可以加入淘宝的源：

$ gem sources --add http://ruby.taobao.org/

源添加删除以后，可以查看一下现在的源都有哪些：

$ gem sources -l

相应的源就会一一罗列出来，可以检查一下加的对不对。

在本地建立CocoaPods的Repo

你也可以通过命令行来建立CocoaPods的Repo，在terminal里输入：

$ pod setup

会显示“Setting up CocoaPods master repo”，此时，正在 ~/.cocoapods/路径下建立Repo。可以cd到这个路径下，用命令行du -sh *来查看下载进度。

如果速度比较慢，也许是因为Podspec的索引文件比较大，而Podspec的文件都在github上。国内有个好心人akinliu做了两个镜像，一个在GitCafe上，一个在OSChina上。这两个服务器都在国内，会比较快。可以这样重新设置CocoaPods的镜像：

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文件

首先要建立一个文本文件，起名叫Podfile，不需要任何的后缀。在文件里填写如下：

platform :ios, '8.0'
use_frameworks!

target 'YourApp' do
  pod 'AFNetworking', '~> 2.5'
  pod 'ORStackView', '~> 2.0'
  pod 'SwiftyJSON', '~> 2.1'
end

platform代表CocoaPods应用的平台，这里就是8.0的iOS。YourApp就是你的工程的名字，AFNetworking、ORStackView和SwiftyJSON都是你需要倒入的库。

然后把这个文件copy到YourApp的根目录下。

在terminal里，首先先cd到YourApp的根目录，然后输入：

$ pod install

这样，Podfile文件中所罗列的全部的第三方的库都已经自动设置好了依赖和编译参数，不需要做额外的操作了。

用appledoc生成帮助文档

可以用appledoc，让CocoaPods自动生成第三方库的帮助文档，在Xcode中，当按住option键单击类名或方法名的时候，就可以显示帮助信息。

在terminal中运行下列命令行完成安装：

$ brew install appledoc

如果brew版本过低，可以运行：

$ brew update

来更新。

需要注意的几点问题

但是，需要注意四点：

1. 每次再打开这个工程，不能运行原来的.xcodeproj文件，而是.xcworkspace文件来打开工程。可以cd到YourApp的根目录，然后输入：

   $ open YourApp.xcworkspace
   

2. 一旦修改了Podfile文件，就需要重新运行一下pod update命令。

3. install以后，会在工程的根目录下生成一个Podfile.lock的文件，这个不能check in，需要在git的ignore文件中添加一下。因为这个文件会锁定第三方库的依赖版本，即使执行pod install也不会修改其版本，只有执行pod update才可以。所以不check in方便多人协作升级第三份库的依赖版本。

4. 可以不更新podspec。因为每次运行pod install和pod update的时候，默认会先更新一次podspec索引。每次运行着两个命令行时，可以带上不更新索引的参数：

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

查找第三方库

只需要在terminal里输入：

$ pod search JSON

就会罗列出全部符合条件的第三方开源库。JSON为你要找的关键字。

使用私有的pod

我们可以安装私有的pod，在terminal里输入：

$ pod 'MyPod', :podspec => 'https://yourPodAddress/myPod.podspec'

如何创建一个Pod

$ pod spec create Peanut
$ edit Peanut.podspec
$ pod spec lint Peanut.podspec

创建了一个Peanut.podspec的文件，然后修改其内容。

原理

CocoaPods首先创建了一个名为Pods的工程，然后将全部的依赖库都放在里面。然后Pods工程会生成一个libPods.a的文件，让主工程依赖libPods.a文件。此外，CocoaPods还提供了一个Pods-resources.sh的bash脚本，这个脚本每次工程编译的时候都会运行，把第三方库的各种资源复制到目标目录中。最后，CocoaPods通过Pods.xcconfig文件在编译时设置所有的依赖和参数。

参考文献

1. CocoaPods官网文档 https://cocoapods.org/

2. 《iOS开发进阶》