组件化之路(-)私有库制作
项目更新到一定的阶段,工程越来越大,编译时间越来越长,我们一般会将项目抽取成一个个的组件,组件一般都会使用cocoaPods 来制作成私有库来相互引用,话不多说,第一次的制作,真是一步一个坑,这里做个总结:
制作私有库,一定要创建两个仓库 一个存放私有的
PodSpesc
,另一个仓库存放私有的组件代码。
这个很重要 ,,很重要,, 很重要。。
(一开始不知道,被坑了好久。。)默认的
podSpesc
是放在官方仓库的,我们是私有库,不想被别人使用,所以需要单独创建一个podSpesc
仓库
1, 先创建podSpesc
仓库,因为是私有的,我们一般选择 coding
, 码云
,gitLab
等git仓库。因为私有的免费。。 我们公司选择的是gitLab ,所以这里以GitLab 做示例;
将私有的这个podSpesc 关联到本地,
// 我们先查询当前本地的pod 库,一般会有一个master
这个是cocoaPods
官方的repo
$ pod repo
将我们创建的仓库添加到本地热repo里,
3E86F43E-33C9-446F-A3AC-B726DA0BFA54.png
$ pod repo add QFPodSpec http://xxxxx.com/xxxt/QFPodSpec.git
$ pod repo
QQ20180804-114719@2x.png
可以发现我们本地的repo里多了个QFPodSpec
至此,我们第一步,创建私有的spec仓库算是完成,现在开始创建私有的组件工程。
使用 pod 命令创建一个模板工程。
$ pod lib create 项目名称
在创建的过程中会询问你四个问题,
What platform do you want to use?? [ iOS / macOS ]
iOS
What language do you want to use?? [ Swift / ObjC ]
ObjC
Would you like to include a demo application with your library? [ Yes / No ]
Which testing frameworks will you use? [ Specta / Kiwi / None ]
What is your class prefix?
看自己需求回答。
克隆完成之后,会自动打开工程。
工程结构如下:
QQ20180804-115937@2x.png
我们的项目文件需要放在,Classes
文件夹下;
这里我添加了一些项目中常用的小工具
进入到
Example
文件夹路径下, 执行
$ pod update
执行完毕后打开
QQ20180804-120759@2x.pngExample
工程。编译运行,如果存在错误,需要解决掉。
可以发现我们添加的文件被放在了Development Pods
文件下
确认编译通过后,开始修改工程的,
QQ20180804-121149@2x.png.podspec
文件
podspec
是我们私有库的描述文件,
注意:s.verison
必须要跟我们私有库的tag 保持一致。
s.description
必须要修改
s.source
修改成私有库的地址。
QQ20180804-121737@2x.png由于
podspec
需要填写私有库的地址,这里我们创建一个私有库仓库。
将仓库地址替换掉
s.source
路径,pod 是根据这个地址来索引我们的私有库的。
所有的修改完毕之后,我们将修改提交到代码仓库。
cd 到当前项目路径
// 查看当前文件状态
git status
// 提交修改文件
git add .
git commit -m '修改说明'
// 查看当前远程仓库
git remote // 当前我们还没有添加,所有是空的,
// 添加远程仓库
git remote add origin 仓库地址,//(我们刚创建的QFCommon的仓库地址)
// 推送到远程仓库
git push origin master
// 给我们的修改打上tag
(再说一遍这里的tag 一定要和podspec 里的s.version 保持一致)
git tag -a 0.0.1 -m '0.0.1'
// 推送tag
git push --tags
至此,我们的远程仓库里已经有了工程并且也已经打上了tag。
image.png
下一步 我们就需要将podSpec 上传到我们的私有仓库里。
我们先在本地验证当前的podspec 是否合法
$ pod lib lint QFCommon.podspec --allow-warnings
// --allow-warnings 忽略掉相应的警告,
如果有错误,可以加上,
pod lib lint QFCommon.podspec --allow-warnings --verbose
// --verbose 查看详细分析信息。(这里踩坑无数,待会再说)
// 如果当前的私有库依赖了其他的私有库,需要添加私有库的spec的地址,
pod lib lint QFCommon.podspec --sources=http://xxxx/xxx/myPodSpec.git,https://github.com/CocoaPods/Specs.git --allow-warnings --use-libraries
// 当私有库里引用了第三方的静态库,需要添加 --use-libraries
当看到QFCommon passed validation.
表示验证通过。
验证通过后,我们开始上传到我们的远程仓库(验证通过,不代表上传就一定能过,这里也有坑。。)
// 上传我们的podspec 到私有的仓库
$ pod repo push QFPodSpec QFCommon.podspec --allow-warnings
// 如果依赖了私有库,在上传时,同样需要添加上--sources= 路径
!!!!! 这里一定要分清
QFPodSpec
是我们创建的私有的podspec 仓库名称,QFCommon.podspec
是我们组件的描述文件的podspec. 一定分清 ,分清,分清,, !!!!!!
如果上传成功的话,在远程仓库里就可以看到我们组件对应的podspec了。
image.png
在本地的repo里也能发现我们的spec
image.png
现在执行
pod search QFCommon //应该就可以搜索到我们的组件了,
如果搜索不到,可以删除索引,试试。
m ~/Library/Caches/CocoaPods/search_index.json
走到这里我们算是把私有库制作完成了,因为是私有库,在使用的时候,需要在对应的podfile
添加上私有库对应的,podspec的路径
在制作的过程中遇到的坑
1,
如果你的podspec
文件里包含中文字符,那么在pod lib lint
验证的时候有可能会报utf8
编码错误,所以尽量不要在podspec
里包含中文。
2,在设置子组件时,如果依赖于其他库,需要设置;
其中如果A文件夹下依赖于另一个B文件夹的内容也需要设置相应的 依赖路径,不然在
pod repo push
的时候,有可能会报
xxxx.h' file not found
3, 如果私有库里包含Xib
文件 那么在加载xib
是需要根据bundle
加载。
NSString *className = NSStringFromClass([self class]);
NSBundle *bundle = [NSBundle bundleForClass:self];
NSString *bundleName = bundle.infoDictionary[@"CFBundleName"];
NSString *nibName = [NSString stringWithFormat:@"%@.bundle/%@", bundleName, className];
return [bundle loadNibNamed:nibName owner:nil options:nil].lastObject;
并且 需要在podspec 里描述相应的路径。
s.resource_bundles = {
'QFCommon' => ['QFCommon/Classes/Tools/**/*.xib']
}
另外在使用私有库的时候,因为包含了资源文件,那么就需要将podfile
里面的 use_frameworks!
打开,不然会找不到资源。
Could not load NIB in bundle:
如果包含图片,需要将图片放在,私有库对应的Assets
里面。
并且将路径描述在,
s.resource_bundles
的数组里 (多个路径,可以相应的依次添加)
s.resource_bundles = {
'QFCommon' => ['QFCommon/Classes/Tools/**/*.xib', xxx/xxx/xxx]
}
5, 如果确定已经打上tag,并且在远程仓库上也能找到tag,但是在推送podspec
到远程的时候报:
Remote branch 0.0.1 not found in upstream origin
查看podspec
里s.source
的地址是否和远程仓库的地址一致。