01-唐巧之cocoapods

时间 2020-06-19

标签 cocoapods 繁體版

原文原文链接

用CocoaPods作iOS程序的依赖管理

CocoaPods简介

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

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

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

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

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

CocoaPods的安装和使用介绍

安装

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

1 2	$ sudo gem install cocoapods $ pod setup

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

1	sudo gem update --system

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

1
2
3

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

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

使用CocoaPods的镜像索引

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

一个叫akinliu的朋友在gitcafe和oschina上创建了CocoaPods索引库的镜像，由于gitcafe和oschina都是国内的服务器，因此在执行索引更新操做时，会快不少。以下操做能够将CocoaPods设置成使用gitcafe镜像：bash

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

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

platform :ios
pod 'JSONKit',       '~> 1.4'
pod 'Reachability',  '~> 3.0.0'
pod 'ASIHTTPRequest'
pod 'RegexKitLite'

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

1 2	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]

// ...如下省略若干行

关于.gitignore

当你执行pod install以后，除了Podfile外，CocoaPods还会生成一个名为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的文件，而后咱们修改其中的相关内容便可。

具体步骤能够参考这两篇博文中的相关内容：《如何编写一个CocoaPods的spec文件》和《Cocoapods 入门》。

使用私有的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的文件来在编译时设置全部的依赖和参数。

愿你们玩得开心～