Cocoapods简介和使用不在多说,如果对CocoaPods不熟悉,建议先阅读CocoaPods的安装与使用这篇文章。
一、 创建公有pod库
1. 使用以下命令创建目录结构和相关模版文件。
pod lib create name
注:name为你想创建文件名。
输入上面命令后,终端会询问你以下问题:
What platform do you want to use?? [ iOS / macOS ],选择iOS,直接回车默认选择第一个。
What language do you want to use?? [ Swift / ObjC ],选择Swift。CocoaPods会把你的库设置为framework。
Would you like to include a demo application with your library? [ Yes / No ],选择Yes。如果你想要包含一个示例工程,或计划在app中测试你的库,这里需要选择Yes,以便模板文件为你的库创建Xcode工程。也就是如果你计划为pod添加截图,这里需要选择Yes。
Which testing frameworks will you use? [ Quick / None ],选择Quick。提交库到CocoaPods前应当进行测试。CocoaPods推荐使用其附带的测试framework,而非Apple的XCTest。在Objective-C中,可以选择Specta/Expecta或Kiwi,其区别如下:
- Specta/Expecta:通过不同podspecs的模块化方法。
- Kiwi:是对Stubs/Mocks/Expections的一种一体化方法。
CocoaPods已经在MyLib-Tests.pch文件中添加了所有必要的包含和设置,因此不必将它们包含在每个文件中。
Would you like to do view based testing? [ Yes / No ],选择Yes。根据你建立的仓库,你可能会发现基于快照的测试是验证视图不同部分不同操作的最佳方法,这里建议使用FBSnapShotTestCase。如果你使用的是Specta/Expecta,那么其会包含一个pod来改进语法。
What is your class prefix?如果你选择的语言是ObjC,其最后会要求提供类前缀。
注:从图中能看到,demo使用的pod库已经install,包括我们自己创建的。
设置完毕后,Xcode会打开新创建的工程,以便你在刚创建的pod上工作。其Project Navigator目录如下:
注:这里我们可以看到,当前文件已经是git库,gitignore、license和readme文件都要存在,你在创建自己代码仓库时可以不再创建这些文件;你也可以创建,上传代码前先同步远程仓库到本地,这里会存在冲突。
查看下面两张图片,对项目目录进行简单说明:
1对应的位置为pod库替身,即2位置处的替身,2位置对应项目中红框位置,1、2两个位置其实在项目中就是一个位置不同的显示。Example文件(以下简称demo文件)内部为测试使用的demo文件,我们可以修改我们的pod库代码,添加需要实现的功能,之后在Example内部去测试。修改代码可以完全在项目demo文件中对应位置修改。
注:上面我们已经说过,demo使用的pod库包括我们创建的都已经install,当你修改完对应的代码,你需要在demo文件目录下,输入'pod install'或者'pod update'。
2. 修改.podspec文件
在上面的项目目录中,我们能够发现KCocoaTest.podsepc文件,这个文件就是pod库的识别文件,.podspec文件内容如下:
Pod::Spec.new do |s|
# 私有pod名称
s.name = "MBKit"
# 当前版本号
s.version = "0.0.2"
# 项目描述
s.summary = " just a summary"
# 项目简介
s.description = <<-DESC
just a description
DESC
# 仓库首页地址
s.homepage = "http://git.oschina.net/YuriZhang"
# license
s.license = { :type => "MIT", :file => "LICENSE" }
# 作者信息
s.author = { "Author" => "Email" }
# 平台版本
s.ios.deployment_target = '9.0'
# 仓库源
s.source = { :git => "https://git.oschina.net/YuriZhang/mbkitspace.git", :tag => "#{s.version}" }
# 代码源文件地址,**/*表示Classes目录及其子
s.source_files = 'KCocoaTest/Classes/**/*'
s.exclude_files = "Classes/Exclude"
必要的属性
- name
- version
- summary
- description
- homepage
- license
- author
- source
这里你需要修改你的summary、descriotion、homepage、source,把git地址改为你的git仓库地址。
下面你就可以在demo文件中修改代码,修改完成的代码要放在source_files对应目录下面,应为我们在使用pod库拉去代码时,拉取得就是这个文件目录下的代码文件。
3. 检查podspec文件
在KCocoaTest文件根目录下(即最外围KCocoaTest文件目录下),使用pod lib lint命令可以验证.podspec文件是否符合规范。
如果存在错误,对应的位置就行改正即可,例如:
在命令行输入以下命令:
$ cd ~/Desktop/BlinkLabel
$ pod lib lint BlinkLabel.podspec
输出如下:
-> BlinkLabel (0.1.0)
- WARN | summary: The summary is not meaningful.
- WARN | url: The URL (https://github.com/pro648/BlinkLabel) is not reachable.
- WARN | [iOS] swift: The validator used Swift 3.2 by default because no Swift version was specified. To specify a Swift version during validation, add the `swift_version` attribute in your podspec. Note that usage of the `--swift-version` parameter or a `.swift-version` file is now deprecated.
[!] BlinkLabel did not pass validation, due to 3 warnings (but you can use `--allow-warnings` to ignore them).
You can use the `--no-clean` option to inspect any issue.
可以看到在.podspec文件中,有三处需要修改:
- 修改summary,以便使其有意义。
- 主页url不可用。
- 验证时没有指明swift版本。
4. 上传代码
代码也已实现,pod lib lint命令也无错误,我们开始上传代码到仓库。
$ git add .
$ git commit -m "Initial Commit"
$ git remote add origin https://github.com/pro648/BlinkLabel.git
$ git push origin master 或git push -u origin master
$ git tag '0.0.2'
$ git push --tags
注:先push代码到远程仓库,在打tag记录当前位置;tag作用是pod通过podsepc文件中的version字段查找到仓库对应的tag记录,拉去对应位置的代码,所以这里的tag值一定与podspec文件的version值保持一致。
上传完成,我们可以使用pod spec lint
命令验证源代码与.podspec文件配置是否正确。
pod lib lint命令与pod spec lint区别如下:
- pod lib lint:只在本地lint你的pod,确保用于创建pod配置信息正确,但其不足以验证pod,只有pod spec lint可以验证pod。
- pod spec lint:会在本地和远程验证pod。如代码托管在GitHub,其会进行lint。如果pod spec lint没有返回错误,就可以推送pod到CocoaPods。
5. 推送pod到Cocoapods
现在,你的本地计算机上运行了功能完备的pod,你还可以将其提交到公开的Specs仓库,以便他人使用。
Specs是托管在GitHub上的公共仓库,其索引了所有公开pod。你的源代码并不一定要托管在GitHub。例如,将源代码托管在码云。
提交pod到Specs仓库步骤如下:
- 为最近一次提交添加标签。
- 使用
pod spec lint
命令验证源代码与.podspec文件配置是否正确。 - 使用
pod trunk push
命令提交spec到Specs仓库。
进行以上操作前,要确保对BlinkLabel的本地更改已添加到git,并推送到了远程仓库。
上面我们已经完成1、2部,只需要在操作第三步即可。
到这里,我们的pod公有库已经完成,上传Cocoapods库需要审核,这个时间不太确定,审核完成,我们就可以通过pod search *
查看我们上传的库了,也可以在别的 项目中使用。
6. 私有库的创建
代码仓库和上面的一样不变,只是我们不在推送pod到Cocoapods,而是将我们的podspec文件保存到对应spec的git仓库中(这里有两个git库,一个代码库,一个spec库)。
//备注这里仓库名字和git上名字保持一致(不一致好像最后会找不到私库,如下:iOS 为仓库名字)
pod repo add KSpecs https://gitlab.rokid-inc.com/kingbo/KSpecs.git
//执行上传到私有仓库,在第2步中,我们已经关联了 `iOS` 这个仓库的地址,所以这里push之后会直接push到我们的git仓库之中
pod repo push KSpecs KCocoaTest.podspec
这样我们就创建好了私有库。
7. 使用私有库
在项目的podfile文件中我们应该输入一下内容:
source 'https://github.com/CocoaPods/Specs.git' #别的库可能需要公有库索引
source 'https://gitlab.rokid-inc.com/kingbo/KSpecs.git' #记得在工程中添加自己的私有仓库索引target 'RokidToolsKitTest_Example' do
pod 'KCocoaTest', '~> 0.0.2'
pod 'SVProgressHUD', '~> 2.2.5'
target 'RokidToolsKitTest_Tests' do
inherit! :search_paths
end