CocoaPods安装与使用

2021-10-17 04:28:35

CocoaPods 简介

　　它是iOS最常用的第三方库依赖管理工具，且绝大多数优秀的开源框架都支持CocoaPods。

　　CocoaPods项目的源码在 Github 上管理。该项目开始于 2011 年 8 月 12 日，开发 iOS 项目不可避免地要使用第三方开源库，CocoaPods 的出现使得我们可以节省设置和更新第三方开源库的时间。

CocoaPods 的安装

安装

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

$ sudo gem install cocoapods
$ pod setup

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

$ sudo gem update --system

　然而这样执行命令，却会出错，

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

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

然后再执行之前的命令：

$ sudo gem install cocoapods
$ pod setup

　　有一点需要注意，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 左右。所以第一次更新时非常慢。

　　一个叫 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'

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

$ cd "your project home"
$ pod install

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

　　1)使用 CocoaPods 生成的 .xcworkspace 文件来打开工程，而不是以前的 .xcodeproj 文件。

　　2)每次更改了 Podfile 文件，需要重新执行一次pod update命令。

查找第三方库

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

<span class="nv">$ pod search json</span><br>-> AFJSONPRequestOperation (1.0.0)
   AFNetworking Extension for the JSONP format.
   pod 'AFJSONPRequestOperation', '~> 1.0.0'
   - Homepage: https://github.com/acerbetti/AFJSONPRequestOperation
   - Source:   https://github.com/acerbetti/AFJSONPRequestOperation.git
   - Versions: 1.0.0 [master repo]
 
 
-> AFJSONRPCClient (2.1.1)
   A JSON-RPC client build on AFNetworking.
   pod 'AFJSONRPCClient', '~> 2.1.1'
   - Homepage: https://github.com/AFNetworking/AFJSONRPCClient
   - Source:   https://github.com/AFNetworking/AFJSONRPCClient.git
   - Versions: 2.1.1, 2.1.0, 2.0.0, 1.0.0, 0.4.0, 0.3.1, 0.3.0 [master repo]
 
 
-> ARSafeJSON (0.0.7)
   ARSafeJSON is a small library that will strip all occurences of NSNull from a
   JSON of any depth.
   pod 'ARSafeJSON', '~> 0.0.7'
   - Homepage: https://bitbucket.org/antoine_r/arsafejson
   - Source:   https://bitbucket.org/antoine_r/arsafejson.git
   - Versions: 0.0.7, 0.0.3 [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

使用私有的 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

原理

　　CocoaPods 是将所有的依赖库都放到另一个名为 Pods 项目中，然后让主项目依赖 Pods 项目，这样，源码管理工作都从主项目移到了 Pods 项目中。

　　1)Pods 项目最终会编译成一个名为 libPods.a 的文件，主项目只需要依赖这个 .a 文件即可。

　　2)对于资源文件，CocoaPods 提供了一个名为 Pods-resources.sh 的 bash 脚本，该脚本在每次项目编译的时候都会执行，将第三方库的各种资源文件复制到目标目录中。

　　3)CocoaPods 通过一个名为 Pods.xcconfig 的文件来在编译时设置所有的依赖和参数。

码农公寓