通过cocoapod创建组件
很多时候我们会把项目中通用的功能模块组件化,通过Cocoapods进行管理。本文将一步一步的记录自己创建组件的过程。
创建组件
1、创建远程索引库
我们没创建一个组建就会带有一个后缀为.podspec的索引文件。我们可以创建一个远程索引库来保存他们,这样其他人可以通过它来进行使用你的组件。按照下图创建远程索引库(ZZFSpecs)并拿到远程索引库的地址(https://github.com/ZZFComponent/ZZFSpecs.git):
2、创建本地仓库
本地索引仓库相关知识
创建之前,我们想简单介绍一下本地索引库相关东西,如果以前没有创建过本地索引仓库,本地索引仓库应该只有默认的master,所有的本地索引仓库都会存放在下面目录下,你可以去这里查看:
~/.cocoapods/repos
当然你也可以打开命令行输入一下命令查看:
pod repo
也可以通过一下命令删除本地索引库
pod repo remove 《本地索引库名称
//举例
pod repo remove ZZFSpecs
创建本地索引仓库
好了,说了那么多,下面进入整体,创建索引库,创建本地索引库也是很简单的,只需要下面一行命令搞定:
pod repo add <本地索引库的名字> <远程索引库的地址>
//举例
pod repo add ZZFSpecs https://github.com/ZZFComponent/ZZFSpecs.git
执行完命令之后可以通过上面介绍的本地索引仓库查看命令查看本地索引仓库是否创建成功。
3、创建远程组件代码库(ZZFShareKit)
远程组件代码库的创建方式基本上和创建远程索引库一样,创建后获取到ZZFShareKit组件代码库的地址(https://github.com/ZZFComponent/ZZFShareKit.git),该库存储ZZFShareKit组件的代码。
[图片上传失败...(image-1610b-1520489978409)]
4、创建ZZFShareKit组件本地代码库
首先通过pod lib create命令从cocoapods的模版中初始化自己的本地组件代码库。
pod lib create 《组件名》
pod lib create ZZFShareKit
执行完上面代码后,会出现下面的提示信息
自己根据自己的需求做出选择,完成后cocoapods会自动为我们创建本地组件代码库,并且帮我们打开项目,接下来就需要把我们需要组件话的代码加入进来。如下图所示将自己的代码放入到组件ZZFShareKit/Classes/文件夹下,如下图
进入到代码库下面的Example目录下面执行
pod install
,把刚才拖入到classes、文件的文件pod进来。
如果组件库里需要图片资源,则需要首先进入组件的索引文件ZZFShareKit.podspec,将图片的引入打开,默认是不打开的。默认的代码如下:
# s.resource_bundles = {
# 'ZZFShareKit' => ['ZZFShareKit/Assets/*.png']
# }
将前面的注释去掉
s.resource_bundles = {
'ZZFShareKit' => ['ZZFShareKit/Assets/*.png']
}
接下来将自己的图片放入到ZZFShareKit/Assets文件夹下。
[图片上传失败...(image-87d053-1520489978409)]
引入后同样进入到Example目录下面执行pod install
然后进入到xcode,在‘Pods’ Project下面Development Pods/ZZFShareKit文件夹下就可以看到自己引入的代码和图片了,如下图:
<div align=center>
然后编译组件看是否能够通过,并且在demo项目中可以写一些代码看看组件能不能正常使用。
接下来就需要修改索引文件ZZFShareKit.podspec了,首先固定要修改的有
- 版本号(version)
- 组件的见到描述(summary)和详细说明(description)
- 修改主页(homepage)和远程代码库地址(source)
- 添加组件中的依赖库(比方说你的组件中需要用到AFNetworking)
其他的诸如:development_target,frameworks等根据自己情况修改。
更改成功后编译运行,如果没问题就可以把组件提交到远程并打tag,
**打tag的时候要注意,tag要和上面更改ZZFShareKit.podspec时的tag一致**
**打tag的时候要注意,tag要和上面更改ZZFShareKit.podspec时的tag一致**
接下来就是把组件代码库提交到远程
- git add .
- git commit -m "组件初始化"
- git remote add origin 远程代码仓库地址
- git push origin master
- git tag 版本号 (注:这里的版本号必须和podspec里写的版本号一致)
- git push --tags
5、将组件的索引文件提交到远程索引库
首先我们要验证索引文件的格式是否正确,是否符合cocoapods的要求,验证命令:
pod spec lint 《组件索引文件》 --verbose --allow-warnings
//举例
pod spec lint 《ZZFShareKit.podspec》 --verbose --allow-warnings //注:--allow-warnings是为了让组件编译过程中有warning照样能够通过。
验证通过后我们就可以将我们组件的索引文件上传到远程索引库里,命令:
pod repo push <本地索引库> <索引文件名> --verbose --allow-warnings
//举例
pod repo push ZZFSpecs ZZFShareKit.podspec --verbose --allow-warnings
这样就把索引文件上传到远程索引库和本地索引库,自己可以去这两个地方看下是否能够找到。
以上就是组件化的全部过程,接下来就是如何使用自己创建的组件了。
组件使用
使用自己的组件
创建一个应用ZZFShareKitDemo,在项目文件夹创建Podfile,并且输入一下代码
source 'https://github.com/ZZFComponent/ZZFSpecs.git'
use_frameworks!
target 'ZZFShareKitDemo' do
pod 'ZZFShareKit'
end
注:
- source:指定索引文件地址,如果不指定,则自动引用cocoapods的索引文件库:https://github.com/CocoaPods/Specs.git,因为我们的组件还没有提交到cocoapods,所以索引库必须指定。下面会讲解怎么将自己的组件上传到cocoapods
- use_frameworks!:这个字段是说组件会被编译成framework使用,否则将会被编译成library(.a)使用
将自己的组件上传到cocoapods
想把自己的组件上传到cocoapods,首先需要有一个cocoapods账号,通过一下命令注册:
pod trunk register 《邮箱地址》 《用户名》 --description='描述信息'
然后根据命令行输出可以看出自己是否注册成功,如果成功的话会提示让你去邮箱里确认进行激活。
注册成功后,可以通过一下命令查看自己的信息:
pod trunk me
上传到cocoapods之前还是先需要验证索引文件的是否符合要求,和上面将索引文件提交到远程库一样,使用命令pod spec lint 《ZZFShareKit.podspec》 --verbose --allow-warnings
验证通过之后,就可以真正的将索引文件提交到cocoapods使用命令
pod trunk push 《索引文件路径》 --allow-warnings
//举例
pod trunk push ZZFShareKit.podspec --allow-warnings
上传到cocoapods中的组件可以通过以下命令删除
pod trunk delete 《组件名》《组件版本号》
上传到cocoapods后,我们使用组件的时候就不需要在Podfile中通过source指定索引文件来使用组件了,只需要简单的pod 《组件名》就可以了,如pod ZZFShareKit