iOS 第三方框架 - CocoaPods的Podfile语法参考

podfile

podfile文件详细描述了一个或多个工程中targets的依赖关系。podfile会默认创建一个隐式的目标链接到工程中用户的第一个target，名称为“default”。

一个podfile可以非常简单:

pod 'afnetworking', '~> 1.0'

也可以配置的复杂一点,如下:

source 'https://github.com/cocoapods/specs.git'

platform :ios, '6.0'
inhibit_all_warnings!

xcodeproj 'myproject'

pod 'objectivesugar', '~> 0.5'

target :test do
  pod 'ocmock', '~> 2.0.1'
end

post_install do |installer|
  installer.pods_project.targets.each do |target|
    puts #{target.name}
  end
end

dependencies（依赖项）

podfile描述用于各个用户targe中的依赖项

pod 是声明指定依赖的方法 podspec 提供了一个简单的api用于创建podspecs target 允许你在工程中限定依赖项只在你指定的targets中生效

pod

指定工程的一个依赖

一个依赖项通过pod名和可选的版本号来声明

当你开始一个项目的时候你可能只需要一个最新版本的依赖，那么你就可以忽略版本号了，这样写：

pod 'ssziparchive'

以后你可能想指定一个pod的固定版本的时候，可以写上具体的版本号来指定：

pod 'objection', '0.9'

对版本号的操作除了指定与不指定，你还可以做其他操作：

>0.1 高于0.1的任何版本
>=0.1 版本0.1和任何更高版本
<0.1 低于0.1的任何版本
<=0.1 版本0.1和任何较低的版本
?>0.1.2 版本 0.1.2的版本到0.2 ，不包括0.2。这个基于你指定的版本号的最后一个部分。这个例子等效于>= 0.1.2并且 <0.2.0，并且始终是你指定范围内的最新版本

版本控制列表可用做更细的版本管理

最后，你可以使用标示 :head来指定版本. 这就意味着工程会使用指定spec下该pod的最新可以用版本，不过会强制下载’bleeding edge’高风险版本(head).务必小心使用，因为spec可能导致不兼容

pod 'objection', :head

build configurations（编译配置）

重要提示:

下面的语法是暂时的，将来很可能会更改，恕不另行通知。因为大家都在要求这个功能，所以我们发布了这个功能。你可以使用它，但你可能需要改变你的podfile去使用未来版本的cocoapods。不管怎么样，一个简单清晰的升级路径会提供给你

默认情况下， 依赖项会被安装在所有target的build configuration中。为了调试或者处于其他原因，依赖项只能在给定的build configuration中被启用

pod 'ponydebugger', :configurations => ['release', 'app store']

当然你也可以弄白名单只指定一个build configurations

当然你也可以只指定一个build configurations

subspecs

当你用一个名字装pod的时候，它将安装所有定义在podspec里面的默认subspec

你可以这样指定:

pod 'querykit/attribute'

也可以指定一个集合，像下面这样:

pod 'querykit', :subspecs => ['attribute', 'queryset']

当然依赖也可以从其他源来获取

using the files from a local path (使用本地文件)

如果你想用一个自己开发的本地的pod，你可以用path选项

pod 'afnetworking', :path => '~/documents/afnetworking'

使用这个选项后，cocoapods会将给定的文件夹认为是pod的源，并且在工程中直接引用这些文件。这就意味着你编辑的部分可以保留在cocoapods安装中

被引用的文件夹可以来自你喜爱的scm，甚至当前仓库的一个git子模块

注意：pod的podspec文件也应该被放在这个文件夹当中

from a podspec in the root of a library repository (引用仓库根目录的podspec)

有的时候你可能想要使用一个最新的开发版本，或者某一个二次开发版本。如果是这样，你可以在pod声明中特别标明

使用仓库中的master分支:

pod 'afnetworking', :git => 'https://github.com/gowalla/afnetworking.git'

使用仓库的其他分支:

pod 'afnetworking', :git => 'https://github.com/gowalla/afnetworking.git', :branch => 'dev'

使用仓库的某个tag:

pod 'afnetworking', :git => 'https://github.com/gowalla/afnetworking.git', :tag => '0.7.0'

或者指定一个提交记录:

pod 'afnetworking', :git => 'https://github.com/gowalla/afnetworking.git', :commit => '082f8319af'

需要特别注意的是，虽然这样将会满足任何在pod中的依赖项通过其他pods
但是podspec必须存在于仓库的根目录中，如果根目录中没有存在这个podspec文件，你将不得不使用下面提到的几种方式之一

from a podspec outside a spec repository, for a library without podspec（在一个不带podsepec的库里引用外部的spec）

如果一个podspec能够从外部的仓库源的获取，设想一下，也通过http来获取podspec:

pod 'jsonkit', :podspec => 'https://example.com/jsonkit.podspec'

podspec

使用一个在给定podspec中声明的pod的依赖项。如果如果没有参数被传递，那么在podfile根部的第一个podspec会被使用。它将会被库所在的工程所使用

注意:这个不会包含哪些来自于podspec的资源而仅仅是来自于cocoapods基础架构

例子:

podspec
podspec :name => 'quickdialog'
podspec :path => '/documents/prettykit/prettykit.podspec'

target

在target块里面定义依赖项，如果对应的target不想添加依赖可以用:exclusive => true参数

podfile文件将会创建一个全局的target名叫:default，default将会生成一个libpod.a文件。这个target将会与用户工程中的第一个target绑定起来如果没有指定特殊的link_with属性的话

例子：

定义一个target:

target :zipapp do
  pod 'ssziparchive'
end

定义一个独有的target:

target :zipapp do
  pod 'ssziparchive'
  target :test, :exclusive => true do
    pod 'jsonkit'
  end
end

target configuration (目标项配置)

这些设置用来控制cocoapods生成project

开头platform用来说明项目的工作平台，xcodeproj允许你指定需要链接的工程

platform

指定了静态库应该被编译在哪个平台

cocoapods提供一个默认的部署目标如果你自己没有指定的话。目前的默认设置是ios4.3、os x10.6、tvos 9.0、watchos 2.0

如果部署目标要求ios版本小于4.3，armv6架构将会被添加到archs中

例子：
指定平台

platform :ios, 
platform :ios

xcodeproj

指定包含引用pod库的target的xcode工程会被链接到

如果没有显示的project被指定，那么会默认使用target的父target指定的project作为目标。如果如果没有任何一个target指定目标，那么就会使用和podefile在同一目录下的project。同样也能够指定是否这些设置在release或者debug模式下生效。为了做到这一点，你必须指定一个名字和:release/:debuge关联起来

例子:
指定用户工程

# look for target to link with in an xcode project called
# `myproject.xcodeproj`.
xcodeproj 'myproject'

target :test do
  # this pods library links with a target in another project.
  xcodeproj 'testproject'
end

用自定义的编译配置

xcodeproj 'testproject', 'mac app store' => :release, 'test' => :debug

link_with

指定用户project里面中面的target链接到pod库

如果没有显示的指定target，那么就会链接到工程中的第一个target。所以如果你只需要链接第一个target，那么你不需要使用link_with

例子:

链接用户工程里面的一个target

link_with 'myapp'

链接多个target

link_with 'myapp', 'myotherapp'

inhibit_all_warnings!

屏蔽cocoapods库里面的所有警告

这个特性也能在子target里面定义

如果你想屏蔽某pod里面的警告也是可以的:

pod 'ssziparchive', :inhibit_warnings => true

use_frameworks!

可以用framework的pod替代静态库的

这个特性可以通过定义子target来继承

workspace（工作区）

这部分内容列举了配置workspace的选项和设置全局配置

workspace

指定应该包含所有projects的xcode workspace.

如果没有显示指定workspace并且在podfile所在目录只有一个project，那么project的名称会被用作于workspace的名称

例子：
指定一个workspace

workspace 'myworkspace'

generate_bridge_support!

指定后从所有已经安装的pod的头文件中会生成一个bridgesupport元数据文档

一些脚本语言例如macruby,nu,jscocoa能够利用这些作为桥接类型、函数等等

set_arc_compatibility_flag!

指定后-fobjc-arc flag会被添加到other_ld_flags中

这个是用来解决编译non-arc项目出现的一个的bug（详见 #142）。本来这些事情都是有xcode4.3.2中的libtool自动完成的，不过看来现在flag -fobjc-arc 已经不被支持了。所以必须显示的指定使用这个方法

这个方法在cocoapods 1.0中也许会被废弃

sources

podfile检索了所有sources(repos)中的specs

sources是全局的，不存储在每个target定义里面

source

指定specs的位置

使用这个方法指定sources。sources的顺序是有关系的的。cocoapods将使用pod第一次出现的source中的最高版本（后续的source中哪怕出现了更高的版本，也不予考虑）

cocoapods 官方source是隐式的需要的，一旦你指定了其他source 你就需要也把官方的指定上

例子:

指定artsy库然后带上官方的

cocoapods master repository

source 'https://github.com/artsy/specs.git'
source 'https://github.com/cocoapods/specs.git'

hooks（钩子）

podfile提供了钩子用来在安装时被调用

钩子是全局的，不存储在每个target定义里面

plugin

指定的插件应该使用在安装过程中

使用此方法来指定一个插件，应该在安装过程中使用，同时，应传递给插件调用时的选项

例子:

指定用slather 和 cocoapods-keys插件

plugin 'cocoapods-keys', :keyring => 'eidolon'
plugin 'slather'

pre_install

这个钩子允许你在pods被下载后但是还未安装前对pods做一些改变

它接受pod::installer作为唯一参数

例子:

定义pre_install钩子

pre_install do |installer|
  # do something fancy!
end

post_install

这个钩子允许你在生成的xcode project写入硬盘或者其他你想执行的操作前做最后的改动

它接受pod::installer作为唯一参数

例子:

给所有target自定义编译配置

post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      config.build_settings['gcc_enable_objc_gc'] = 'supported'
    end
  end
end