上一章介绍了
1、教你一步步用CocoaPods创建远程公有库,
应该对远程的公有库的上传和下载步骤有了一个大致的了解了。
背景
随着我们的业务的增多,我们的app数量可能会增加,复用相关的模块代码这个时候就变得更迫切<工具类,网络请求类等>。
私有pod库可以帮助我们,避免重复造轮子,快速的copy出一个app,
原理
对比CocoaPods创建远程公有库我们可以很快的上手用CocoaPods创建远程私有库原理大同小异。
主要相关的区别在图中已经标明。
- 1、D盛放索引列表的远程仓库不再是 CocoaPods的官方的spec列表仓库,而是我们自己的远程私有仓库。
- 2、B公开的代码不是放在公开的git上面的仓库上,而是放在我们自己的私有仓库中
- 3、我们要将我们的代码对应的.podspec文件上传到D我们的远程私有仓库索引列表中。
不要晕,这里有两个私有的远程仓库【A仓库和B仓库】,
【A仓库】成放着我们封装的代码
【B仓库】充当目录的角色,盛放的是对【A仓库】代码的描述文件<版本,依赖,source等等>。
我们要用A的时候,Cocoapods就通过【B】中对A的描述文件,找到【A】,然后根据A的描述文件,下载配置A。
开始
我们需要做的工作包括以下几点
1>、创建一个远程私有仓库,用来扮演私有
pod
目录的索引库,也就是上面说的【B仓库】<首次创建source需要>
2>、创建一个本地的仓库,将自己想要公开的代码集成进去。并且关联到远程仓库<首次创建项目需要>
3>、修改.podSpec
描述文件中的相关的描述信息
4>、将自己的封装的代码打上tag
,修改podspec
中的version
,push
到远程私有仓库中去
5>、将当前本地的.podSpec
文件传到创建的私有远程仓库<用来扮演CocoaPods官方的索引库
>
6>、测试一下,有没有上传到私有远程仓库的索引库中
7>、后期的升级维护
详细步骤如下:
1>、创建一个远程私有仓库,用来扮演私有pod
目录的索引库
1.1、将远程私有库source
下载到本地
找到pod
所有的source
pod repo
进入
cd /Users/用户名/.cocoapods/repos
可以看到这里面包含着pod所有的source不管是私有的还是公有的
将远程source
下载到 repos
中。这样做的目的是,pod
可以通过名字找到远程的source
git clone 远程source地址
2>、创建一个本地的仓库,将自己想要公开的代码搞进去。
2.1、到相关的目录下面创建一个pod模板,终端执行下面的命令:
pod lib create DownLoader
之后他会问你五个问题,
1、选择语言
2、是否需要一个例子工程;
3、选择一个测试框架;
4、是否基于View测试;
5、类的前缀;
这几个问题的具体介绍可以去看官方文档,问完这5个问题他会自动执行pod install命令创建项目并生成依赖。
pod lib create DownLoader
Cloning `https://github.com/CocoaPods/pod-template.git` into `DownLoader`.
Configuring DownLoader template.
------------------------------
To get you started we need to ask a few questions, this should only take a minute.
If this is your first time we recommend running through with the guide:
- http://guides.cocoapods.org/making/using-pod-lib-create.html
( hold cmd and click links to open in a browser. )
What language do you want to use?? [ Swift / ObjC ]
> ObjC
Would you like to include a demo application with your library? [ Yes / No ]
> Yes
Which testing frameworks will you use? [ Specta / Kiwi / None ]
> Specta
Would you like to do view based testing? [ Yes / No ]
> Yes
What is your class prefix?
> ZY
Running pod install on your new library.
Analyzing dependencies
Fetching podspec for `DownLoader` from `../`
Downloading dependencies
生成的项目,自动生成一个仓库,测试Demo集成了CocoaPods,以及创建好了相关的####.podspec描述文件
如果运行失败,很大原因是因为
Example
目录,项目中pod
自动给导入了几个下载不下来的pod
,直接在podfile
文件中给删了再pod install
就可以了
2.2、将创建出来的项目,搞到远端仓库
2.3、将自己要封装的代码放到下面的目录,并且删除ReplaceMe.m
2.4、这个时候我们的自动生成的测试项目中是看不到我们刚刚放到Classes目录下面的东西的。需要执行一下Example下面的Podfile文件。
执行完毕之后打开Example项目
可以在这其中进行相关的调试,来修改我们准备封装的代码。因为
发现对应的是这个路径下的代码
在Example项目中,调试完毕,确认准备封装的代码没有bug,进行下一步。
当前的Example项目就相当于到时候集成者的身份
3>、修改.podSpec描述文件中的相关的描述信息
详情可参考CocoaPods的官网的PodSpec语法.podspec
可以选择使用Xcode
进行打开修改
3.1、这里面主要注意这么几个地方就可以了,相关的配置比较多,直接看注释就好了
Pod::Spec.new do |s|
# 项目的名称
s.name = 'DownLoader'
# 项目的版本号,通过项目git的tag标签进行对应,这里的标签代表的版本,每一次升级版本,这个版本号必须比之前的高,s.version 必须等于当前的最新的tag号
s.version = '0.1.0'
# 项目简单的描述信息
s.summary = '简单的下载器'
# 项目的详细描述信息,注意,这里的文字的长度,一定要比上面的s.summary长,不然会认为格式不合格
s.description = <<-DESC
简单的下载器,支持断点下载
DESC
# 项目的网页主页信息,这里可以直接写自己的远程仓库的主页的地址
s.homepage = 'https://coding.net/u/*******/p/DownLoader'
# 截图
# s.screenshots = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2'
# 开源协议
s.license = { :type => 'MIT', :file => 'LICENSE' }
# 作者信息
s.author = { 'zy_ios@163.com' => 'zy_ios@163.com' }
# 这个比较重要,指的就是git的对应的远程仓库的地址以及版本号,版本号直接获取的是上面的s.version
# 项目地址,这里不支持ssh的地址,验证不通过,只支持HTTP和HTTPS,最好使用HTTPS
s.source = { :git => 'https://git.coding.net/*******/DownLoader.git', :tag => s.version.to_s }
# 多媒体介绍地址
# s.social_media_url = 'https://twitter.com/<TWITTER_USERNAME>'
# 支持的平台及版本
s.ios.deployment_target = '8.0'
# 代码源文件地址,**/*表示Classes目录及其子目录下所有文件,如果有多个目录下则用逗号分开,如果需要在项目中分组显示,这里也要做相应的设置
s.source_files = 'DownLoader/Classes/**/*.{bundle}'
# 私有库暴露给外面的 framework,如果当前包含framework,需要提供资源链接
#s.vendored_frameworks = '**/NIMSDK.framework','**/NIMAVChat.framework','**/NMC.framework'
# s.xcconfig = { "OTHER_LDFLAGS" => "-ObjC", "ENABLE_BITCODE" => "NO" }
# 私有库暴露给外面的 .a,如果当前包含.a,需要提供资源链接
# s.vendored_libraries = 'JRCommonWPush/Classes/**/*.{a}'
# 资源文件地址
s.resource = 'DownLoader/Assets/*.{bundle}'
# 公开头文件地址
# s.public_header_files = 'Pod/Classes/**/*.h'
# 所需的framework,多个用逗号隔开
s.frameworks = 'UIKit', 'MapKit'
# 依赖关系,该项目所依赖的其他,当在加载的时候也会一块把相关的依赖的库加载下来,如果有多个需要填写多个
# 如果依赖私有库,那么在项目的podfile文件中加上私有库的source地址
s.dependency 'AFNetworking', '~> 2.3'
s.dependency 'YYModel'
# 依赖的libraries
s.libraries = 'sqlite3.0','z','c++'
# 是否使用ARC,如果指定具体文件,则具体的问题使用ARC
s.requires_arc = true
end
3.2、如果当前的私有库还依赖别的公有库怎么办?
直接在podspect文件中写上依赖名字和版本就好
s.dependency '公有库的名字', '~> 最低版本号'
s.dependency 'AFNetworking', '~> 2.3'
3.3、如果当前的私有库还依赖别的私有库怎么办?
除了在podspect文件中写上依赖名字和版本,还要在测试项目的podfile文件中写上私有库的source<也就是私有库的目录仓库>。
3.4、修改完毕之后进行检验一下.podspec的格式有木有问题
pod lib lint
通过
具体的错误原因可以根据相关的提示进行修改,但是有的时候没有错误,有的是一堆的警告,如下所示:
换一种检验的方式,忽略所有的警告进行格式的检验
pod lib lint --allow-warnings
如果你的私有pod库依赖了其他的私有pod库,则需要这样验证
--sources是依赖的私有库的目录地址,多个的话用逗号隔开
pod lib lint --sources=git@git.**依赖的私有库source地址1,git@git.**依赖的私有库source地址2 --use-libraries --allow-warnings
4>、将封装的代码打上tag,修改podspec中的version,push到远程私有仓库中去
tag == s.version
5>、将当前本地的.podSpec文件传到创建的私有远程仓库<用来扮演CocoaPods官方的索引库>
5.1、最终一步
进入到.podspec所在的目录
pod repo push CommonBusinessComponentsSpecs DownLoader.podspec --allow-warnings --sources='https://github.com/CocoaPods/Specs.git,git@igit***依赖的私有库source' --skip-import-validation
CommonBusinessComponentsSpecs:远程私有库source名字
DownLoader.podspec:当前要封装的私有pod名称
--allow-warnings:即使有警告也会跳过
sources=:当前私有库依赖的私有库source
--skip-import-validation:跳过是否pod导入的验证
更多的验证方式参考:
https://guides.cocoapods.org/terminal/commands.html#pod_spec_lint
6>、测试一下,有没有上传到私有远程仓库的索引库中
pod search DownLoader
如果查询不到,尝试删除search缓存文件试试
$ sudo rm ~/Library/Caches/CocoaPods/search_index.json
或者
$ rm ~/Library/Caches/CocoaPods/search_index.json
找一个集成了CocoaPods的项目,进行更新操作,失败了
失败的原因是因为,找不到我们的downloader的描述文件的位置。
因为我们没有指定相关的source地址,具体的修改操作见下图
可是这个时候,我们去更新一个AFNetWorking试一下,失败了。
原因是,因为AFNetWorking的位置是CocoaPods的公开spec仓库中的,而我们上面仅仅只是指定下面的pods的来源是我们自己私有的仓库,所以,需要添加上CocoaPods的公开spec仓库的git地址。
PS:Podfile文件上面不指定Source,默认就是CocoaPods的公开spec仓库的git地址
这样配置就好了
source 'git@git.coding.net:WANG19931123/PrivateSpecsGather.git'
source 'https://github.com/CocoaPods/Specs.git'
target 'PrivatePodsDemo' do
# Uncomment the next line if you're using Swift or would like to use dynamic frameworks
# use_frameworks!
# Pods for PrivatePodsDemo
pod 'DownLoader', '~> 0.1.0'
pod 'AFNetworking', '~> 3.1.0'
end
7>、后期的升级维护
7.1、后期先更新自己的本地私有库,更新完毕之后,调试无问题
7.2、编辑对应的.podSpec文件,升级一个version,对应的,给最新的代码添加一个tag。当然了【version == tag】对应。
7.3、推送到盛放私有spec的私有仓库
当然了,你想把你 封装的私有库给其他的小伙伴用,你至少得给别人权限,让别人能够访问你的两个私有库。
扩展:实现CocoaPods的subspec分支功能
扩展:使用CocoaPods集成的远程私有公有库如何使用图片资源
如有失误请各位路过大神即时指点,或有更好的做法,也请指点一二。在下不甚感激。