【转】用CocoaPods作iOS程序的依赖管理 -- 不错

时间 2019-11-26

标签 cocoapods ios 程序依赖管理不错栏目 iOS 繁體版

原文原文链接

原文网址：http://blog.devtang.com/2014/05/25/use-cocoapod-to-manage-ios-lib-dependency/html

文档更新说明

2012-12-02 v1.0 初稿
2014-01-08 v1.1 增长设置 ruby 淘宝源相关内容
2014-05-25 v2.0 增长国内 spec 镜像、使用私有 pod、podfile.lock、建立 spec 文件等内容
2015-09-03 v2.1 优化排版，调整一些描述方式，使文章更易读懂。
2015-12-21 v2.2 将淘宝的镜像修改为 https 的。

CocoaPods 简介

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

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

我在开发猿题库客户端时，使用了 24 个第三方开源库。在没有使用 CocoaPods 之前，我须要:git

把这些第三方开源库的源代码文件复制到项目中，或者设置成 git 的 submodule。
对于这些开源库一般须要依赖系统的一些 framework，我须要手工地将这些 framework 分别增长到项目依赖中，好比一般状况下，一个网络库就须要增长如下 framework: CFNetwork, SystemConfiguration, MobileCoreServices, CoreGraphics, zlib。
对于某些开源库，我还须要设置-licucore或者 -fno-objc-arc等编译参数
管理这些依赖包的更新。

这些体力活虽然简单，但毫无技术含量而且浪费时间。在使用 CocoaPods 以后，我只须要将用到的第三方开源库放到一个名为 Podfile 的文件中，而后执行pod install。
CocoaPods 就会自动将这些第三方开源库的源码下载下来，而且为个人工程设置好相应的系统依赖和编译参数。github

CocoaPods 的安装和使用介绍

安装

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

$ sudo gem install cocoapods
$ pod setup

若是你的 gem 太老，可能也会有问题，能够尝试用以下命令升级 gem:json

sudo gem update --system

另外，ruby 的软件源 https://rubygems.org 由于使用的是亚马逊的云服务，因此被墙了，须要更新一下 ruby 的源，使用以下代码将官方的 ruby 源替换成国内淘宝的源：xcode

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

还有一点须要注意，pod setup在执行时，会输出Setting up CocoaPods master repo，可是会等待比较久的时间。这步实际上是 Cocoapods 在将它的信息下载到 ~/.cocoapods目录下，若是你等过久，能够试着 cd 到那个目录，用du -sh *来查看下载进度。你也能够参考本文接下来的使用 cocoapods 的镜像索引一节的内容来提升下载速度。ruby

使用 CocoaPods 的镜像索引

全部的项目的 Podspec 文件都托管在https://github.com/CocoaPods/Specs。第一次执行pod setup时，CocoaPods 会将这些podspec索引文件更新到本地的 ~/.cocoapods/目录下，这个索引文件比较大，有 80M 左右。因此第一次更新时很是慢，笔者就更新了将近 1 个小时才完成。bash

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

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

cd "your project home"
pod install

如今，你的全部第三方库都已经下载完成而且设置好了编译参数和依赖，你只须要记住以下 2 点便可：

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

查找第三方库

你若是不知道 cocoaPods 管理的库中，是否有你想要的库，那么你能够经过 pod search 命令进行查找，如下是我用 pod search json 查找到的全部可用的库：

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

pod spec create your_pod_spec_name

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

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

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

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

原理

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

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

愿你们玩得开心～