1.安装ruby环境,添加淘宝ruby镜像
localhost:~ wangze$ gem sources -l
*** CURRENT SOURCES ***
https://ruby.taobao.org/
localhost:~ wangze$ gem sources -a https://ruby.taobao.org/
source https://ruby.taobao.org/ already present in the cache
localhost:~ wangze$ gem sources -l
*** CURRENT SOURCES ***
https://ruby.taobao.org/
localhost:~ wangze$ sudo gem uninstall cocoapods
Password:
---------------------------
$ gem sources --remove https://rubygems.org/
//等有反应之后再敲入以下命令
$ gem sources -a http://ruby.taobao.org/
2.查看是否设置成功:
$ gem sources -l
3.然后安装cocoapods:
(
上面所有的命令完成之时,在小编的终端上是这个的样子:
Figure 1
这时候,你再次在终端中运行:
$ sudo gem install cocoapods
)
我们先创建这个神奇的PodFile。在终端中进入(cd命令)你项目所在目录,然后在当前目录下,利用vim创建Podfile,运行:
$ vim Podfile
然后在Podfile文件中输入以下文字:
platform :ios, '7.0'
pod "AFNetworking", "~> 2.0"
注意,这段文字不是小编凭空生成的,可以在AFNetworking的github页面找到。这两句文字的意思是,当前AFNetworking支持的iOS最高版本是iOS 7.0, 要下载的AFNetworking版本是2.0。
然后保存退出。vim环境下,保存退出命令是:
:wq
这时候,你会发现你的项目目录中,出现一个名字为Podfile的文件,而且文件内容就是你刚刚输入的内容。注意,Podfile文件应该和你的工程文件.xcodeproj在同一个目录下。
这时候,你就可以利用CocoPods下载AFNetworking类库了。还是在终端中的当前项目目录下,运行以下命令:
$ pod install
因为是在你的项目中导入AFNetworking,这就是为什么这个命令需要你进入你的项目所在目录中运行。
运行上述命令之后,小编的终端出现以下信息:
EricmatoMacBook-Pro:CocoaPodsDemo ericwang$ pod install Analyzing dependencies Downloading dependencies Installing AFNetworking (2.0.2) Generating Pods project Integrating client project [!] From now on use `CocoaPodsDemo.xcworkspace`. --------------20150413------------------
CocoaPods简介
每种语言发展到一个阶段,就会出现相应的依赖管理工具,例如Java语言的Maven,nodejs的npm。随着iOS开发者的增多,业界也出现了为iOS程序提供依赖管理的工具,它的名字叫做:CocoaPods。
CocoaPods项目的源码在Github上管理。该项目开始于2011年8月12日,经过多年发展,现在已经成为iOS开发事实上的依赖管理标准工具。开发iOS项目不可避免地要使用第三方开源库,CocoaPods的出现使得我们可以节省设置和更新第三方开源库的时间。
在我开发猿题库客户端时,其使用了24个第三方开源库。在没有使用CocoaPods以前,我需要:
- 把这些第三方开源库的源代码文件复制到项目中,或者设置成git的submodule。
- 对于这些开源库通常需要依赖系统的一些framework,我需要手工地将这些framework一一增加到项目依赖中,比如通常情况下,一个网络库就需要增加以下framework: CFNetwork, SystemConfiguration, MobileCoreServices, CoreGraphics, zlib。
- 对于某些开源库,我还需要设置
-licucore
或者-fno-objc-arc
等编译参数- 管理这些依赖包的更新。
这些体力活虽然简单,但毫无技术含量并且浪费时间。在使用CocoaPods之后,我只需要将用到的第三方开源库放到一个名为Podfile的文件中,然后执行
pod install
。CocoaPods就会自动将这些第三方开源库的源码下载下来,并且为我的工程设置好相应的系统依赖和编译参数。CocoaPods的安装和使用介绍
安装
安装方式异常简单, Mac下都自带ruby,使用ruby的gem命令即可下载安装:
1 2$ sudo gem install cocoapods $ pod setup
如果你的gem太老,可能也会有问题,可以尝试用如下命令升级gem:
1
sudo gem update --system
另外,ruby的软件源rubygems.org因为使用的亚马逊的云服务,所以被墙了,需要更新一下ruby的源,如下代码将官方的ruby源替换成国内淘宝的源:
1 2 3gem 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的镜像索引
一节的内容来提高下载速度。使用CocoaPods的镜像索引
所有的项目的Podspec文件都托管在
https://github.com/CocoaPods/Specs
。第一次执行pod setup
时,CocoaPods会将这些podspec
索引文件更新到本地的~/.cocoapods/
目录下,这个索引文件比较大,有80M左右。所以第一次更新时非常慢,笔者就更新了将近1个小时才完成。一个叫akinliu的朋友在gitcafe和oschina上建立了CocoaPods索引库的镜像,因为gitcafe和oschina都是国内的服务器,所以在执行索引更新操作时,会快很多。如下操作可以将CocoaPods设置成使用gitcafe镜像:
1 2 3pod 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的文件,以如下格式,将依赖的库名字依次列在文件中即可
1 2 3 4 5platform :ios pod 'JSONKit', '~> 1.4' pod 'Reachability', '~> 3.0.0' pod 'ASIHTTPRequest' pod 'RegexKitLite'
然后你将编辑好的Podfile文件放到你的项目根目录中,执行如下命令即可:
1 2cd "your project home" pod install
现在,你的所有第三方库都已经下载完成并且设置好了编译参数和依赖,你只需要记住如下2点即可:
- 使用CocoaPods生成的 .xcworkspace 文件来打开工程,而不是以前的 .xcodeproj 文件。
- 每次更改了Podfile文件,你需要重新执行一次
pod update
命令。查找第三方库
你如果不知道cocoaPods管理的库中,是否有你想要的库,那么你可以通过pod search命令进行查找,以下是我用pod search json查找到的所有可用的库:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16$ 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 2pod 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的文件来在编译时设置所有的依赖和参数
-------------------------
二、使用CocoaPods
打开终端,使用cd命令定位到需要使用CocoaPods的项目根路径。如:
先考虑项目中需要引用哪些库,然后在通过search命令来查找库的信息,如需要加入JSONKit,那可以如下写法:
1cd
/Users/username/Documents/Projects/Demo
命令执行后会得到如下结果:
1pod search JSONKit
其中的pod 'JSONKit', '~> 1.5pre'是待会要写入到Podfile中的信息。如果已经知道这些信息,那可以直接省略此步。直接进行下面的步骤。
123456-> JSONKit (1.5pre)
A Very High Performance Objective-C JSON Library.
pod
'JSONKit'
,
'~> 1.5pre'
- Homepage: https:
//github
.com
/johnezang/JSONKit
- Source: https:
//github
.com
/johnezang/JSONKit
.git
- Versions: 1.5pre, 1.4 [master repo]
得到必要的库信息后,现在需要在项目中建立Podfile文件。通过下面的命令:
然后编辑Podfile文件,命令如下:
1touch
Podfile
在弹出的编辑界面中输入下面内容:
1open
-e Podfile
然后调用下面命令来进行初始化:
123platform :ios
pod
'JSONKit'
,
'~> 1.5pre'
运行完毕后,原本的项目目录会多出一些文件。如图:
1pod
install