cocoapods安装及使用

发表于 | 分类于 | 12
字数统计: 2.1k | 阅读时长 ≈ 8

参考文档

参考文档

CocoaPods 简介

每种语言发展到一个阶段，就会出现相应的依赖管理工具，例如 Java 语言的 Maven，nodejs 的 npm。随着 iOS 开发者的增多，业界也出现了为 iOS 程序提供依赖管理的工具，它的名字叫做：CocoaPods。

CocoaPods项目的源码 在 Github 上管理。该项目开始于 2011 年 8 月 12 日，经过多年发展，现在已经成为 iOS 开发事实上的依赖管理标准工具。开发 iOS 项目不可避免地要使用第三方开源库，CocoaPods 的出现使得我们可以节省设置和更新第三方开源库的时间。

CocoaPods 的安装和使用介绍

安装

  1. 升级 gem:
1
sudo gem update --system
  1. 接下来输入系统密码就可以安装了，输入密码时不会显示的，输完回车就行了

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

    1
    2
    gem sources --remove https://rubygems.org/
    gem sources --add https://gems.ruby-china.com/

  2. 接下来查看下源路径是否更换了

1
gem sources -l

如果是以下结果说明正确.

1
2
3
*** CURRENT SOURCES ***

https://gems.ruby-china.com/

  1. 这时候才正式开始安装CocoaPods
    1
    sudo gem install cocoapods

如果出现这个了,指的是你没有权限


输入这个

1
sudo gem install -n /usr/local/bin cocoapods

如果显示这个表示安装成功

  1. 安装本地库

    1
    pod setup

  2. 执行以上命令后就是漫长的等待，当然,网络好的情况下会更快

    1
    2
    3
    4
    5
    6
    Setting up CocoaPods master repo
      $ /usr/bin/git clone https://github.com/CocoaPods/Specs.git master --progress
      Cloning into 'master'...
      remote: Counting objects: 1879515, done.        
      remote: Compressing objects: 100% (321/321), done.        
      Receiving objects:  21% (404525/1879515), 73.70 MiB | 22.00 KiB/

要查看文件下载进度的可以另外打开一个终端窗口(快捷键:选中终端按下Command+N组合键)，输入以下两行命令回车执行

1
2
3
cd ~/.cocoapods

du -sh *

执行du -sh *之后会显示已下载的文件大小，可以多次执行来监看下载进度，如果之前还有文件大小，后来变成0了，可能是网络问题，下载已经中断了,需要结束命令并从新执行 pod setup

  1. 下载安装完成之后可执行下列命令检查是否可用（第一次使用可能要等一会）
    1
    pod search AFNetworking

结果是这样的就妥了(输入q回到终端控制界面)

使用 CocoaPods

使用时需要新建一个名为 Podfile 的文件，以如下格式，将依赖的库名字依次列在文件中即可

1
2
3
4
platform :ios, '7.0'
target 'demo' do
pod 'SDWebImage'，
end

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

1
2
cd "your project home"
pod install

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

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

可能会遇到的问题

  • 当在终端输入,pod search AFNetworking可能会出现这种情况


这是因为之前pod search的时候生成了缓存文件search_index.json

1
rm ~/Library/Caches/CocoaPods/search_index.json

来删除该文件
然后再次输入pod search AFNetworking进行搜索
这时会提示Creating search index for spec repo ‘master’..

  • 当运行pod 命令出现
1
command not found

解决办法:

1
sudo gem install -n /usr/local/bin cocoapods

之后pod命令可以使用了

  • 如果pod update / pod install 卡在：
    1
    Updating local specs repositories

等待即可，或者

可以使用 “pod install –verbose –no-repo-update” 进行下载，原因可能x被墙。

  • 出现如下错误:
    1
    2
    3
    4
    5
    6
    7
    8
    Cloning into 'master'...
    remote: Enumerating objects: 395, done.        
    remote: Counting objects: 100% (395/395), done.        
    remote: Compressing objects: 100% (308/308), done.        
    error: RPC failed; curl 56 LibreSSL SSL_read: SSL_ERROR_SYSCALL, errno 60
    fatal: The remote end hung up unexpectedly
    fatal: early EOF
    fatal: index-pack failed

解决办法:

1
gem install rails

如下:

1
2
3
4
Successfully installed rails-5.0.1
Parsing documentation for rails-5.0.1
Done installing documentation for rails after 0 seconds
1 gem installed

然后继续:

1
pod setup

使用 CocoaPods 的镜像索引

所有的项目的 Podspec 文件都托管在https://github.com/CocoaPods/Specs。第一次执行pod setup时，CocoaPods 会将这些podspec索引文件更新到本地的 ~/.cocoapods/目录下，这个索引文件比较大，有 80M 左右。所以第一次更新时非常慢。

一个叫 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 管理的库中，是否有你想要的库，那么你可以通过 pod search 命令进行查找，以下是我用 pod search json 查找到的所有可用的库：

1
2
3
4
5
6
7
8
9
10
11
12
$ 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文件：

1
pod spec create your_pod_spec_name

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

具体步骤可以参考这两篇博文中的相关内容：

使用私有的 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 项目中。发现的一些技术细节有：

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