添加 pods 到 Xcode 工程
开始之前请先做两件事情:
- 搜索 Specs 仓库或者 cocoapods.org 确认想要安装的库存在;
- 电脑上已经安装 CocoaPods。
安装到现有工程
创建 Podfile 文件,添加依赖:
target 'MyApp' do
pod 'AFNetworking', '~> 3.0'
pod 'FBSDKCoreKit', '~> 4.9'
end
- 在工程目录下执行
pod install
- 打开并编译
MyApp.xcworkspace
创建一个新的工程并集成 CocoaPods
创建一个新的工程并集成 CocoaPods,步骤如下:
- 创建一个普通的 Xcode 工程;
- 打开终端,
cd
到工程目录; - 创建
Podfile
文件,这可以通过执行pod init
来完成; - 打开
Podfile
文件,第一行必须制定使用的平台和版本;
platform :ios, ‘9.0’
- 你需要指定 Xcode 的 target。如果是 iOS App target 就是 工程的名称。通过
target '$TARGET_NAME' do
代表 target 的开始,end
表示结束; - 在 target 的范围内使用
pod '$PODNAME'
添加 pod
target 'MyApp' do
pod 'ObjectiveSugar'
end
- 保存
Podfile
; - 执行
pod install
; - 将工程通过
MyApp.xcworkspace
打开.
集成已经存在的 workspace
集成 CocoaPods 到已经存在的 .workspace
工程,需要在 Podfile
中 ,targe 范围外,添加一行:
workspace 'MyWorkspace'
pod install
和 pod update
使用时机
很多人会疑惑 pod install
和 pod update
应该在什么时候用,经常是在本应该用 pod install
的时候使用了 pod update
。
你可以在这里找到它们详细的说明。
是否应该将 Pods 目录加入版本控制
是否将 Pods 加入版本控制,需要看情况而定。官方建议把 Pods 目录加入版本控制,不要把它加入 .gitignore
,不过最终还是看你自己决定:
加入版本控制的好处
- 仓库克隆完毕,可以立即编译运行,即使没有安装 CocoaPods。不需要执行
pod install
,也不用网络连接。 - pod 对应的库总是可用的,即使 pod 的源码无法获取了。
- 能够保证克隆下来的 pod 库同安装和编译它的人版本一致。
忽略版本控制的好处
- git 仓库会占用的空间少。
- 只要 Pod 源代码还在,总是能够通过
pod install
重新安装原先的版本。 - 可以避免在合并分支的时候出现 Pod 源码版本不一致的冲突。
不管是否将 pods 目录加入版本库, Podfile
和 Podfile.lock
是一定要加入版本控制的。
什么是 Podfile.lock
?
它会在第一次执行 pod install
的时候生成,并且跟踪已经安装的 pod 的版本。例如,假设 Podfile
中有如下依赖:
pod 'RestKit'
执行 pod install
会安装当前最新的版本,并生成 Podfile.lock
文件记录该版本号(比如说:RestKit 0.10.3
)。之后在其它机器上,即使 RestKit
有了新的版本,这个工程目录下执行 pod install
安装的仍旧是 0.10.3 版本。除非修改 Podfile
中指定的版本或者执行 pod update
否者 Podfile.lock
会保证 pods 的版本不变。
这里有一个 Google 介绍它是如何工作的视频 CocoaPods and Lockfiles (Route 85).
背后的实现
在 Xcode 中,可以直接查看 CocoaPods 的ruby 源代码。
- 创建或者更新 workspace。
- 添加你的工程到 workspace。
- 添加 CocoaPods 的静态库到 workspace。
- 添加 App-Pods.framework 到 targets => build phases => link with libraries。
- 添加 CocoaPods 的 Xcode 配置文件到工程。
- 根据 CocoaPods 来修改 app target 配置
- 添加一个 build phase 脚本来将 pods 中的资源文件拷贝到 app bundle 中 ,在 build phase 的最后面添加
Copy Pods Resource
:- Shell: /bin/sh
- ${SRCROOT}/Pods/PodsResources.sh
步骤3中如果工程中原本有静态库就直接跳过。