是非常好用的一个iOS
依赖管理工具,使用它可以方便的管理和更新项目中所使用到的第三方库,以及将自己的项目中的公共组件交由它去管理。Cocoapods
的介绍及优点本文就不在赘述,我开始使用Cocoapods
还是在两年前,那个时候它刚刚出现,网上的资料还非常的少,就连他们自己的HomePage
都十分的简单,我就着手尝试着使用了一下,用它管理起第三方库确实是十分的方便顺手。后来它有了更强大的功能就是自己创建podspec
,更可以设置私有的库。
春节回来上班,一天的工作结束之后,需要充实下自己,正好项目中有一些公共组件需要从庞大的项目体系中剥离出来,而且年前项目终于从SVN
迁移到了Git
,真是喜大普奔,大快人心!这样项目使用Cocoapods
就有了条件,正好学习一下创建私有的podspec
并在项目中部署使用,以及pods
的subspec
的创建及使用。
整体先说明一下创建一个私有的podspec
包括如下那么几个步骤:
- 创建并设置一个私有的
Spec Repo
。 - 创建
Pod
的所需要的项目工程文件,并且有可访问的项目版本控制地址。 - 创建
Pod
所对应的podspec
文件。 - 本地测试配置好的
podspec
文件是否可用。 - 向私有的
Spec Repo
中提交podspec
。 - 在个人项目中的
Podfile
中增加刚刚制作的好的Pod
并使用。 - 更新维护
podspec
。
在这一系列的步骤中需要创建两个Git仓库
,分别是第一步和第二步(第二步不一定非要是Git仓库
,只要是可以获取到相关代码文件就可以,也可以是SVN
的,也可以说zip包
,区别就是在podspec
中的source
项填写的内容不同),并且第一步只是在初次创建私有podspec
时才需要,之后在创建其他的只需要从第二步开始就可以。本文只介绍在Git
环境下的操作,其他环境其他方式暂不说明。
创建私有Spec Repo
先来说第一步,什么是Spec Repo
?他是所有的Pods
的一个索引,就是一个容器,所有公开的Pods
都在这个里面,他实际是一个Git仓库
在GitHub
上,但是当你使用了Cocoapods
后他会被clone
到本地的~/.cocoapods/repos
目录下,可以进入到这个目录看到master
文件夹就是这个官方的Spec Repo
了。这个master
目录的结构是这个样子的
12345 | .├── Specs └── [SPEC_NAME] └── [VERSION] └── [SPEC_NAME].podspec |
因此我们需要创建一个类似于master
的私有Spec Repo
,这里我们可以fork
官方的Repo
,也可以自己创建,个人建议不fork
,因为你只是想添加自己的Pods
,没有必要把现有的公开Pods
都copy
一份。所以创建一个 Git仓库
,这个仓库你可以创建私有的也可以创建公开的,不过既然私有的Spec Repo
,还是创建私有的仓库吧,需要注意的就是如果项目中有其他同事共同开发的话,你还要给他这个Git仓库
的权限。因为GitHub
的私有仓库是收费的,我还不是GitHub
的付费用户,所以我使用了其他Git
服务,我使用的是,当然还有其他的可供选择、以及
创建完成之后在Terminal
中执行如下命令
12 | # pod repo add [Private Repo Name] [GitHub HTTPS clone URL]$ pod repo add WTSpecs https://coding.net/wtlucky/WTSpecs.git |
此时如果成功的话进入到~/.cocoapods/repos
目录下就可以看到WTSpecs
这个目录了。至此第一步创建私有Spec Repo
完成。
PS:如果有其他合作人员共同使用这个私有Spec Repo
的话在他有对应Git仓库
的权限的前提下执行相同的命令添加这个Spec Repo
即可。
创建Pod
项目工程文件
这个第二步没有什么好介绍的,如果是有现有的组件项目,并且在Git
的版本管理下,那么这一步就算完成了,可以直接进行下一步了。
如果你的组件还在你冗余庞大的项目中,需要拆分出来或者需要自己从零开始创建一个组件库,那么我建议你使用Cocoapods
提供的一个工具将第二步与第三步结合起来做。
现在来说一下这个工具,相关的文档介绍是 就拿我创建的podTestLibrary
为例子具体讲一下这里是如何操作的,先cd
到要创建项目的目录然后执行
1 | $ pod lib create podTestLibrary |
之后他会问你四个问题,1.是否需要一个例子工程;2.选择一个测试框架;3.是否基于View测试;4.类的前缀;4个问题的具体介绍可以去看官方文档,我这里选择的是1.yes;2.Specta/Expecta;3.yes;4.PTL。 问完这4个问题他会自动执行pod install
命令创建项目并生成依赖。
123456 7 8 9 10 11 12 13 14 15 16 17 18 | $ tree PodTestLibrary -L 2PodTestLibrary├── Example #demo APP │ ├── PodTestLibrary │ ├── PodTestLibrary.xcodeproj │ ├── PodTestLibrary.xcworkspace │ ├── Podfile #demo APP 的依赖描述文件 │ ├── Podfile.lock │ ├── Pods #demo APP 的依赖文件 │ └── Tests ├── LICENSE #开源协议 默认MIT ├── Pod #组件的目录 │ ├── Assets #资源文件 │ └── Classes #类文件 ├── PodTestLibrary.podspec #第三步要创建的podspec文件 └── README.md #markdown格式的README 9 directories, 5 files |
以上是项目生成的目录结构及相关介绍。
接下来就是向Pod
文件夹中添加库文件和资源,并配置podspec
文件,我把一个网络模块的共有组件放入Pod/Classes
中,然后进入Example
文件夹执行pod update
命令,再打开项目工程可以看到,刚刚添加的组件已经在Pods
子工程下Development Pods/PodTestLibrary
中了,然后编辑demo工程,测试组件,我并没有使用提供的测试框架进行测试,这里就先不介绍了。
注:这里需要注意的是每当你向Pod
中添加了新的文件或者以后更新了podspec
的版本都需要重新执行一遍pod update
命令。
测试无误后需要将该项目添加并推送到远端仓库,并编辑podspec
文件。
通过Cocoapods
创建出来的目录本身就在本地的Git
管理下,我们需要做的就是给它添加远端仓库,同样去GitHub
或其他的Git
服务提供商那里创建一个私有的仓库,拿到SSH
地址,然后cd
到PodTestLibrary
目录
1234 | $ git add .$ git commit -s -m "Initial Commit of Library" $ git remote add origin git@coding.net:wtlucky/podTestLibrary.git #添加远端仓库 $ git push origin master #提交到远端仓库 |
因为podspec
文件中获取Git
版本控制的项目还需要tag
号,所以我们要打上一个tag
,
12 | $ git tag -m "first release" 0.1.0$ git push --tags #推送tag到远端仓库 |
做完这些就可以开始编辑podspec
文件了,它是一个Ruby
的文件,把编辑器的格式改成Ruby
就能看到语法高亮,下面我贴上我的podspec
文件,并在后面以注释的形式说明每个字段的含义,没有涉及到的字段可以去查阅
123456 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 | Pod::Spec.new do |s| s.name = "PodTestLibrary" #名称 s.version = "0.1.0" #版本号 s.summary = "Just Testing." #简短介绍,下面是详细介绍 s.description = <<-DESC Testing Private Podspec. * Markdown format. * Don't worry about the indent, we strip it! DESC s.homepage = "https://coding.net/u/wtlucky/p/podTestLibrary" #主页,这里要填写可以访问到的地址,不然验证不通过 # s.screenshots = "www.example.com/screenshots_1", "www.example.com/screenshots_2" #截图 s.license = 'MIT' #开源协议 s.author = { "wtlucky" => "wtlucky@foxmail.com" } #作者信息 s.source = { :git => "https://coding.net/wtlucky/podTestLibrary.git", :tag => "0.1.0" } #项目地址,这里不支持ssh的地址,验证不通过,只支持HTTP和HTTPS,最好使用HTTPS # s.social_media_url = 'https://twitter.com/ |
编辑完podspec
文件后,需要验证一下这个文件是否可用,如果有任何WARNING
或者ERROR
都是不可以的,它就不能被添加到Spec Repo
中,不过xcode
的WARNING
是可以存在的,验证需要执行一下命令
1 | $ pod lib lint |
当你看到
123 | -> PodTestLibrary (0.1.0)PodTestLibrary passed validation. |
时,说明验证通过了,不过这只是这个podspec
文件是合格的,不一定说明这个Pod
是可以用的,我们需要在本地做一下验证,这就是第四步的内容了,第四步在具体说明。
创建podspec
文件
如果从第二步过来,已经有了现成的项目,那么就需要给这个项目创建一个podspec
文件,创建它需要执行Cocoapods
的另外一个命令,在这里
1 | $ pod spec create PodTestLibrary git@coding.net:wtlucky/podTestLibrary.git |
执行完之后,就创建了一个podspec
文件,他其中会包含很多内容,可以按照我之前介绍的进行编辑,没用的删掉。编辑完成之后使用验证命令验证一下
1 | $ pod lib lint |
验证无误就可以进入下一步了。
本地测试podspec
文件
我们可以创建一个新的项目,在这个项目的Podfile
文件中直接指定刚才创建编辑好的podspec
文件,看是否可用。 在Podfile
中我们可以这样编辑,有两种方式
1234 | platform :ios, '7.0' pod 'PodTestLibrary', :path => '~/code/Cocoapods/podTest/PodTestLibrary' # 指定路径 pod 'PodTestLibrary', :podspec => '~/code/Cocoapods/podTest/PodTestLibrary/PodTestLibrary.podspec' # 指定podspec文件 |
然后执行pod install
命令安装依赖,打开项目工程,可以看到库文件都被加载到Pods
子项目中了,不过它们并没有在Pods
目录下,而是跟测试项目一样存在于Development Pods/PodTestLibrary
中,这是因为我们是在本地测试,而没有把podspec
文件添加到Spec Repo
中的缘故。
在项目中编写代码,测试库文件无误后就可以开始下一步了,提交podspec
到Spec Repo
中。
向Spec Repo
提交podspec
向Spec Repo
提交podspec
需要完成两点一个是podspec
必须通过验证无误,在一个就是删掉无用的注释(这个不是必须的,为了规范还是删掉吧)。 向我们的私有Spec Repo
提交podspec
只需要一个命令
1 | $ pod repo push WTSpecs PodTestLibrary.podspec #前面是本地Repo名字 后面是podspec名字 |
完成之后这个组件库就添加到我们的私有Spec Repo
中了,可以进入到~/.cocoapods/repos/WTSpecs
目录下查看
123456 | .├── LICENSE├── PodTestLibrary│ └── 0.1.0│ └── PodTestLibrary.podspec └── README.md |
再去看我们的Spec Repo
远端仓库,也有了一次提交,这个podspec
也已经被Push
上去了。
至此,我们的这个组件库就已经制作添加完成了,使用pod search
命令就可以查到我们自己的库了
123456 7 8 | $ pod search PodTestLibrary-> PodTestLibrary (0.1.0) Just Testing. pod 'PodTestLibrary', '~> 0.1.0' - Homepage: https://coding.net/u/wtlucky/p/podTestLibrary - Source: https://coding.net/wtlucky/podTestLibrary.git - Versions: 0.1.0 [WTSpecs repo] |
这里说的是添加到私有的Repo
,如果要添加到Cocoapods
的官方库了,可以使用trunk
工具,具体可以查看
使用制作好的Pod
在完成这一系列步骤之后,我们就可以在正式项目中使用这个私有的Pod
了只需要在项目的Podfile
里增加以下一行代码即可
1 | $ pod 'PodTestLibrary', '~> 0.1.0' |
然后执行pod update
,更新库依赖,然后打卡项目可以看到,我们自己的库文件已经出现在Pods
子项目中的Pods
子目录下了,而不再是Development Pods
。
更新维护podspec
最后再来说一下制作好的podspec
文件后续的更新维护工作,比如如何添加新的版本,如何删除Pod
。
我已经制作好了PodTestLibrary
的0.1.0
版本,现在我对他进行升级工作,这次我添加了更多的模块到PodTestLibrary
之中,包括工具类,底层Model
及UIKit
扩展等,这里又尝试了一下subspec
功能,给PodTestLibrary
创建了多个子分支。
具体做法是先将源文件添加到Pod/Classes
中,然后按照不同的模块对文件目录进行整理,因为我有四个模块,所以在Pod/Classes
下有创建了四个子目录,完成之后继续编辑之前的PodTestLibrary.podspec
,这次增加了subspec
特性
123456 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 | Pod::Spec.new do |s| s.name = "PodTestLibrary" s.version = "1.0.0" s.summary = "Just Testing." s.description = <<-DESC Testing Private Podspec. * Markdown format. * Don't worry about the indent, we strip it! DESC s.homepage = "https://coding.net/u/wtlucky/p/podTestLibrary" # s.screenshots = "www.example.com/screenshots_1", "www.example.com/screenshots_2" s.license = 'MIT' s.author = { "wtlucky" => "wtlucky@foxmail.com" } s.source = { :git => "https://coding.net/wtlucky/podTestLibrary.git", :tag => "1.0.0" } # s.social_media_url = 'https://twitter.com/ |