CocoaPods的安装使用和常见问题

一、什么是CocoaPods

CocoaPods是iOS项目的依赖管理工具，该项目源码在Github上管理。开发iOS项目不可避免地要使用第三方开源库，CocoaPods的出现使得我们可以节省设置和第三方开源库的时间。
在使用CocoaPods之前，开发项目需要用到第三方开源库的时候，我们需要
1.把开源库的源代码复制到项目中
2.添加一些依赖框架和动态库
3.设置-ObjC，-fno-objc-arc等参数
4.管理他们的更新
在使用CocoaPods后，我们只需要把用到的开源库放到一个名为Podfile的文件中，然后执行pod install.Cocoapods就会自动将这些第三方开源库的源码下载下来，并且为我们的工程设置好响应的系统依赖和编译参数。

二、CocoaPods的原理

CocoaPods的原理是将所有的依赖库都放到另一个名为Pods的项目中，然后让主项目依赖Pods项目，这样，源码管理工作都从主项目移到了Pods项目中。Pods项目最终会编译成一个名为libPods.a的文件，主项目只需要依赖这个.a文件即可。

三、CocoaPods的安装

CocoaPods可以方便地通过Mac自带的RubyGems安装。
打开Terminal，然后键入以下命令：
$ sudo gem install cocoapods

执行完这句如果报告以下错误：
ERROR: Could not find a valid gem 'cocoapods' (>= 0), here is why:
Unable to download data from https://rubygems.org/ - Errno::ETIMEDOUT: Operation timed out - connect(2) (https://rubygems.org/latest_specs.4.8.gz)
ERROR: Possible alternatives: cocoapods

这是因为ruby的软件源rubygems.org因为使用亚马逊的云服务，被我天朝屏蔽了，需要更新一下ruby的源，过程如下：
$ gem sources -l (查看当前ruby的源)
$ gem sources --remove https://rubygems.org/
$ gem sources -a https://ruby.taobao.org/
$ gem sources -l

如果gem太老，可以尝试用如下命令升级gem
$ sudo gem update --system
升级成功后会提示: RubyGems system software updated

然后重新执行安装下载命令
$ sudo gem install cocoapods
这时候应该没什么问题了

接下来进行安装，执行：
$ pod setup

Terminal会停留在 Setting up CocoaPods master repo 这个状态一段时间,是因为要进行下载安装,而且目录比较大,需要耐心等待一下.如果想加快速度,可使用cocoapods的镜像索引.（文章末尾附使用镜像索引的方法）
安装成功后,你会看到:

01.png

四、Cocoapods的使用

进入工程所在的目录（工程根目录）
执行命令 touch Podfile
这句是说新建一个名为Podfile的文件（不能写成别的名字，也可以自己在工程根目录里面直接新建）

然后对改文件进行编辑，执行命令 open -e Podfile
第一次执行这个命令,会有一个空白文件打开，可以先放在一边，
Podfile文件的格式应该如下：
platform :ios, '7.0'
pod 'AMap2DMap', '~> 2.5.0'
pod 'AFNetworking', '~> 2.5.3'
pod 'SDWebImage', '~> 3.7.2'

需要注意的几点：platform那一行，ios三个字母都要小写，而且与前面的冒号之间不能有间隔，后面的版本号也可以不写，但是有些开源库对版本是有要求的，比如要在6.0以上才能运行，遇到这样的开源库就需要写上版本号。

platform下面就是Cocoapods需要集成的开源库，根据你的需要确定集成那些库。

举个例子：
我要集成AFNetworking这个库类，需要在Cocoapods里面先搜索是否有需要的库，可以在Terminal中输入：
pod search AFNetworking
回车之后就可以看到和你搜索的关键字相关的一些库类，如图：

02.png

其中第一个就是我们需要的，把pod ‘AFNetworking’， ‘~>2.5.3’
那一行复制到我们的Podfile文件中，保存修改。
然后在Terminal中执行 ：
pod install

这样，AFNetworking就已经下载完成并且设置好了编译参数和依赖，以后使用的时候切记如下两点：
1.从此以后需要使用Cocoapods生成的 .xcworkspace文件来打开工程，而不是使用以前的.xcodeproj文件
2.每次更改了Podfile文件，都需要重新执行一次pod update命令

ps:当执行pod install之后，除了Podfile，还会生成一个名为Podfile.lock的文件，它会锁定当前各依赖库的版本，之后即使多次执行pod install也不会更改版本，只有执行pod update才会改变Podfile.lock.在多人协作的时候，这样可以防止第三方库升级时候造成大家各自的第三方库版本不一致。所以在提交版本的时候不能把它落下，也不要添加到.gitignore中.

五、常见问题

1.
[!] Invalid Podfile file: undefined local variable or method `en_US' for #. Updating CocoaPods might fix the issue.

原因：单引号格式，可能是手动输入导致
解决办法：系统偏好设置-键盘-文本-将“使用智能引号和破折号”一项取消勾选-再将podfile里面的单（双）引号修改一下

2.ArgumentError - invalid byte sequence in US-ASCII
原因：字符集错误
解决办法：
使用locale命令查看当前的字符集，如果都是zh，需要执行以下命令：
export LC_ALL=en_US.UTF-8
export LANG=en_US.UTF-8
然后再使用locale命令查看，已经改过来了

1. [!] The YMTea [Debug] target overrides the OTHER_LDFLAGS build setting defined in `Pods/Target Support Files/Pods/Pods.debug.xcconfig'. This can lead to problems with the CocoaPods installation
   • Use the $(inherited) flag, or
   • Remove the build settings from the target.

[!] The YMTea [Release] target overrides the OTHER_LDFLAGS build setting defined in `Pods/Target Support Files/Pods/Pods.release.xcconfig'. This can lead to problems with the CocoaPods installation

- Use the `$(inherited)` flag, or
- Remove the build settings from the target.

原因：我是在已有项目中集成Cocoapods的时候遇到这个问题，原因是项目 Target 中做了一些设置，CocoaPods 也做了默认的设置，如果两个设置结果不一致，就会造成问题。
解决方法：我想要使用 CocoaPods 中的设置，分别在我的项目中定义PODS_ROOT 和 Other Linker Flags的地方（build settings），把他们的值用$(inherited)替换掉，进入终端，执行 pod update
警告没了，回到 Xcode，build通过。
网上还流行另外一种简单粗暴的方法:点击项目文件 project.xcodeproj，右键显示包内容，用文本编辑器打开project.pbxproj，删除OTHER_LDFLAGS的地方，保存(这种我没试过)

4.
[!] Oh no, an error occurred.

It appears to have originated from your Podfile at line 2.

Search for existing GitHub issues similar to yours:
https://github.com/CocoaPods/CocoaPods/search?q=%2FUsers%2Fxiao6%2FMusic%2FGI06%E5%AE%9E%E8%AE%AD%E8%8A%B8%E8%8C%97%E8%8C%B6%E5%8F%B6%2FYMTea%2FPodfile%3A2%3A+syntax+error%2C+unexpected+%27%3A%27%2C+expecting+end-of-input%0Aplatform+%3A+ios%2C+%277.0%27%0A++++++++++%5E&type=Issues

If none exists, create a ticket, with the template displayed above, on:
https://github.com/CocoaPods/CocoaPods/issues/new

Be sure to first read the contributing guide for details on how to properly submit a ticket:
https://github.com/CocoaPods/CocoaPods/blob/master/CONTRIBUTING.md

Don't forget to anonymize any private data!

原因：这个问题比较蛋疼，弄了好久，仔细看发现就是因为Podfile文件里面 platform 那一行 冒号和ios之间多了一个空格。。。。其实这个错误在报错的时候ruby已经给出了，只是一开始没有好好看：

03.png

附：如何使用CocoaPods的镜像索引:

所有项目的Podspec文件都托管在https://github.com/CocoaPods/Specs,
第一次执行pod setup时,CocoaPods会将这些podspec索引文件更新到本地的~/.cocoapods目录下,
这个索引文件比较大,所以第一次更新时非常慢.
友好人士在国内的服务器建立了Cocoapods索引库的镜像,
所以执行索引跟新操作时候会快很多.具体操作方法如下:
$ pod repo remove master
$ pod repo add master https://gitcafe.com/akuandev/Specs.git
$ pod repo update
这是使用gitcafe上的镜像,将以上代码中的 https://gitcafe.com/akuandev/Specs.git 
替换成 http://git.oschina.net/akuandev/Specs.git 即可使用oschina上的镜像。

Cocoapods安装步骤

1、升级Ruby环境

终端输入：$gem update --system

此时会出现

ERROR:  While executing gem ... (Gem::FilePermissionError)

    You don‘t have write permissions for the /Library/Ruby/Gems/2.0.0 directory.

zijingMacBook-Pro:~ shiyunlei$ sudo gem update —system

这个是因为你没有权限去更新Ruby

这个时候你可以在终端使用：$sudo gem update —system来进行升级

这个时候表示Ruby升级完成。

2、安装CocoaPods时我们要访问cocoapods.org，该网站可能被我们大天朝墙了，这样下载安装可能会是龟速，幸好我们可以用淘宝的Ruby镜像来访问该网站，方法如下：

1、gem sources --removehttps://rubygems.org/

2、gem sources -ahttp://ruby.taobao.org/

可以使用下面的命令(红色部分)查看是否更换镜像成功（如下图所示）：
$ gem sources -l

3、安装Cocoapods，在终端输入命令

$sudo gem install cocoapods

这个时候会提示你输入密码，注：在终端输入密码不会有提示，光标也不会移动，一定要注意

开始安装，如下图：PS:这个过程可能花费时间比较长

安装成功如下：

4、使用search命令搜索类库名： 

$pod search AFNetworking

如果CocoaPods支持，将会输出搜索到的所有类库版本和信息，以及在Podfile中配置的写法，终端返回信息如下：

-> AFNetworking (2.3.1)

   A delightful iOS and OS X networking framework.

  pod ‘AFNetworking‘, ‘~> 2.3.1’（这个语句是需要在编辑Podfile的时候输入的命令，即是如何安装下载相关类库的指令）

   - Homepage: https://github.com/AFNetworking/AFNetworking

   - Source:   https://github.com/AFNetworking/AFNetworking.git

   - Versions: 2.3.1, 2.3.0, 2.2.4, 2.2.3, 2.2.2, 2.2.1, 2.2.0, 2.1.0,

   2.0.3, 2.0.2, 2.0.1, 2.0.0, 2.0.0-RC3, 2.0.0-RC2, 2.0.0-RC1, 1.3.4, 1.3.3,

   1.3.2, 1.3.1, 1.3.0, 1.2.1, 1.2.0, 1.1.0, 1.0.1, 1.0, 1.0RC3, 1.0RC2, 1.0RC1,

   0.10.1, 0.10.0, 0.9.2, 0.9.1, 0.9.0, 0.7.0, 0.5.1 [master repo]

   - Sub specs:   - AFNetworking/Serialization (2.3.1)   -

   AFNetworking/Security (2.3.1)   - AFNetworking/Reachability (2.3.1)   -

   AFNetworking/NSURLConnection (2.3.1)   - AFNetworking/NSURLSession (2.3.1)

   - AFNetworking/UIKit (2.3.1)

-> AFNetworking+AutoRetry (0.0.5)

   Auto Retries for AFNetworking requests

   pod ‘AFNetworking+AutoRetry‘, ‘~> 0.0.5‘

   - Homepage: https://github.com/shaioz/AFNetworking-AutoRetry

   - Source:   https://github.com/shaioz/AFNetworking-AutoRetry.git

   - Versions: 0.0.5, 0.0.4, 0.0.3, 0.0.2, 0.0.1 [master repo]

5、需要在工程中创建一个Podfile文件，

使用命令：

$cd /Users/shiyunlei/Desktop/CocoapodsSample(进入工程目录，cd后面的是工程的路径)

$ touch Podfile（创建Podfile文件）

然后使用vim编辑Podfile文件，使用命令：

$ vim Podfile
进入如下界面

然后紧接着按键盘上的“i”键，变成如下状态，这个时候可以对Podfile文件进行编辑：

$platform:ios, ‘7.0‘

$ pod ‘AFNetworking‘, ‘~> 2.3.1‘

在编辑完成后按“esc”，

在按“:”,这个时候输入wq,点击回车，保存并退出。

这个时候打开Podfile文件就会看到里面添加了刚才在终端输入的一行语句，如下图

然后在终端输入命令安装相应的第三方类库

$pod install

因为这个过程需要下载相应的类库，所以时间和网速有关。

安装成功之后截图如下：

这个时候会看到之后打开工程都需要从类型为工程名.xcworkspace文件打开。