iOS-抽取私有Pod库

引言

最近对组件化相关的知识比较感兴趣,翻看了好多大神的博客,算是对组件化有个大概的了解了。所谓的组件化,一方面是抽取私有Pod库,其实就是把我们的项目分成多个模块,例如基类模块、工具类模块、登陆模块、首页模块等等,然后把他们抽取成一个个私有Pod库,像平时利用cocopods导入三方库那样导入我们的这些私有库;另一个方面就是关于模块之间的通信问题,常常采用路由跳转。本文的主要目的是前者。

一. 公有Pod库的本质

公有Pod库大家应该都比较熟悉,项目中经常使用的三方库,如AFNetworking,Masonry,SDWebImage等都属于公有Pod库,任何一个开发者都可以把其导入自己的项目工程中进行使用。与之相对应的就是私有Pod库,它只能被有权限的人使用。其实公有和私有的区别不大,就是谁来管理.podspecs文件的问题,下面就说一下大家比较熟悉的公有Pod库的本质

  • 远程索引库:存在一个公共的远程索引库,包含所有三方框架的.podspec文件,在.podspecs文件中包括了框架名,框架源码地址,用户名,描述等信息。
  • 本地索引库:在安装pod,执行pod setup的时候,会将公共的远程索引库copy一份到本地,也即是公共的本地索引库。(可以查看此目录:/Users/xx/.cocoapods/repos, xx替换成你的电脑名,下同)
  • 检索文件: 公共的本地索引库会另外生成一个检索文件,以键值对的形式,方便以后查找。( 可以查看此目录:/Users/xx/Library/Caches/CocoaPods)
  • 导入三方库:执行pod install的时候,先去检索文件中查找,找到之后,在公共的本地索引库拿到框架源码地址进行导入。

二. 创建私有Pod库

上面已经提到了,公有Pod库是任何一个开发者都可以导入使用的,并且是能看到源码的,这显然不是我们想要的。我们的pod库应该是只能内部人员才能导入使用,所以我们应该把一个个模块抽取成私有的Pod库。
公有和私有Pod库的主要区别就是远程索引库不同,我们需要创建一个私有的远程索引库,用来管理私有库的.podspec文件,其他方面大同小异。
下面以Base模块为例,将其抽取成私有Pod库。

1.创建私有的远程索引库

(1) 在gitlab上创建一个私有的仓库QDFoundationSpec,克隆地址是:http://git.prod.qiaodata.lan/liumingming/QDFoundationSpec.git, QDFoundationSpec就作为上面提到的私有的远程索引库。

(2) 终端执行下面命令,将私有的远程索引库copy到本地。

pod repo add QDFoundationSpec http://git.prod.qiaodata.lan/liumingming/QDFoundationSpec.git

执行完毕后,在目录:/Users/xx/.cocoapods/repos 下会多出来一个QDFoundationSpec文件夹,至此私有的索引库部分就完成了。

2.创建私有Pod组件库

(1) 打开终端,进入到桌面目录下,执行下面命令来创建一个名为QDFoundation的Pod库空模板。

pod lib create QDFoundation

依次输入下图信息进行基础配置:
基础配置

配置完毕之后,Pod库空模板就创建成功了,系统会自动此模板。

(2) 在gitlab上创建远程仓库QDFoundation,克隆地址是:http://git.prod.qiaodata.lan/liumingming/QDFoundation.git,在终端QDFoundation目录下执行下面命令,关联本地仓库到远程仓库。

git remote add origin http://git.prod.qiaodata.lan/liumingming/QDFoundation.git

(3) 将原项目中需要封装的Base模块,复制到 QDFoundation/QDFoundation/Classes中,顺便删除ReplaceMe文件

(4) 终端进入 QDFoundation/Example 文件夹,执行 pod install

(5) 退回到上层目录

上面搞定之后,接着就是修改QDFoundation.podspec文件,如下图
修改spec

修改完成之后,将本地代码推送到远程仓库,设置tag并推送到远端(注意:tag要和上图中s.version版本一样),然后终端执行下面命令,来校验我们的 QDFoundation.podspec 文件

pod spec lint

等待片刻,终端出现 QDFoundation.podspec passed validation,则说明 QDFoundation.podspec 文件通过校验。

3. 将QDFoundation.podspec文件加入私有的远程索引库QDFoundationSpec

上面已经验证过 QDFoundation.podspec 文件没问题,接着就是要把 QDFoundation.podspec 文件添加到私有的索引库(也就是第一步中得到的索引库 QDFoundationSpec),在终端执行下面命令:

pod repo push QDFoundationSpec QDFoundation.podspec

上面命令对 QDFoundation.podspec 文件做了两个操作:一个是将其推送到私有的远程索引库,可以去 gitlab 的 QDFoundationSpec仓库中查看;另一个是将其copy到私有的本地索引库,这个可以去目录:/Users/xx/.cocoapods/repos/QDFoundationSpec 下查看到。
至此,Base模块抽取成私有的Pod库也就完成了,可以在终端执行pod search QDFoundation来查询它,接下来就是在原项目中使用它了。

4. 使用私有Pod库

在原项目的Podfile中,导入私有的Pod库的方式如下图
使用私有Pod库

接着执行 pod install命令进行安装,安装完毕之后,可以看到Pods文件夹中已经有QDFoundation了,然后把原项目中的Base文件夹给删除掉即可。

另外,公司内部其他成员在使用之前需要执行下面命令,将私有的远程索引库copy到本地,然后就可以正常使用了。

pod repo add QDFoundationSpec http://git.prod.qiaodata.lan/liumingming/QDFoundationSpec.git

5. 更新私有库

  • 修改私有库中相应的内容
  • 更新对应的 .spec 文件中的版本号
  • 执行pod lib lint命令本地校验
  • 上传修改内容到git,并打上tag, tag与版本号相同
  • 执行pod repo push QDFoundationSpec QDFoundation.podspec命令
  • 更新之后,公司内部其他成员使用私有库需要执行下面命令
pod repo update QDFoundationSpec

或

pod update

三、文件夹分层

1. 文件显示层级

cocoaPods创建私有库的时候,如果私有库中的文件很多,想做到和项目中的文件夹分层,就需要在podSpec文件里面用到s.subspec 'xxx' do |ss|语句来配置。

先看一个文件层级
文件层级

如图所示,现在我们要把 QDFoundation这个文件夹搭建私有库。

我们一般在用pod lib create QDFoundation创建完项目后,会生成相应的目录,只要把需要做成私有库的文件夹代码文件放到 classes里面就可以了。

首先先不考虑文件分层的写法,这样podspec文件里面是这样的
文件原始分层

在图中可以看出,就是普通的写法,按照图中这么写的话,会导致私有库搭建完成并pod导入后,所有的.h .m .xib .png等文件都在一个文件夹里面,并没有我们本地那样的文件夹Base、Network等文件夹了。

这样的pod私有库虽然在正常的使用中并没有任何问题,但是看起来很乱,这个时候我们就需要进行文件分层了。把UIView类都放在View里面,把Model类都放在Model里面。这里我们基于没有文件分层的基础上进行修改,需要使用到下面的语句

s.subspec ‘View’ do |ss|
ss.source_files = ‘’
end

下面我们参照图一给出的文件层级写相关的 subspec

classes文件夹下面,只有文件夹,并没有其他的.h .m等文件,这个时候,podspec文件里面的source_files就可以不用写了。
文件夹分级

这里需要注意的几个问题:

  • 一个就是如果有 A subspec 需要使用到其他的 B subspec ,就需要在 A subspec 下面添加对 B subspec 的依赖,这个依赖是针对 subspec 的,不需要写本地文件路径。
  • 依赖其他第三方公开pod库的话,可以写在使用到的 subspec 里面,也可以写在总的依赖里。
  • 如果 A subspec 里面有使用到 B subspec 下的文件,B subspec 又引用到 A subspec 下的文件,这样的话,分层实现起来比较困难,解决的思路可以在 classes 下面创建一个.h的头文件,引用各个头文件,并设置 s.souce_files = 'QDFoundation/Classes/UIView.h'

2. 资源文件的使用

pods私有库有时候会用到图片资源或者其他资源,这些资源应该怎么配置和获取使用呢?
在我们使用pod lib creat QDFoundation的时候,会在 Classes 同级目录下面生成一个 Assets 的文件夹,这个文件夹就是用来放资源文件的,如图:
Asset文件目录
将资源文件放到这个里面的时候,接下来要去设置QDFoundation.podspec文件,主要就是将原先下面这段注释的代码接触注释就好了:

资源文件修改

注意

执行pod spec lint时遇到warning, 校验通不过的话,尽量把warning解决了,如果不好解决就使用pod spec lint --allow-warnings
执行pod spec lint时遇到引入第三方库找不到第三方的头文件,可以使用pod spec lint --use-libraries来解决这个问题

总结

在整个过程中,需要到git服务器上创建两个仓库,一个作为索引库,一个作为pod组件库;接着就是创建模板并配置.podspec文件;然后就是让索引库管理.podspec文件,之后就是使用了,如果清楚了这几步,对于抽取私有Pod库应该很得心应手。

参考链接

iOS 组件化之抽取私有Pod库
cocoapods私有库文件分层和资源文件上传

  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值