本文由wx0317投稿
一、前言
凡是做iOS开发的,应该没人不知道CocoaPods吧,它大大提高了我们的工作效率,可以很方便就获取到我们需要的第三方类库,节省了很多时间。相信大家对使用Pods库已经非常熟悉,不过今天我们主要讲讲如何在项目中制作和使用私有Pods库。
二、什么是Private Spec Repo
在介绍Private Spec Repo之前,先简单做一下铺垫。
我们平时用的最多的命令:pod install,有时候会很慢,我们往往喜欢在后面加个参数,变成:pod install --no-repo-update,意思是不需要更新repo库,这里的repo库指的是CocoaPods官方索引库( https://github.com/CocoaPods/Specs.git ),这个库记录了所有被CocoaPods官方收录的第三方类库,我们在使用CocoaPods时,会自动clone这个库到本地(~/.cocoapods/repos/master),以后每次pod install时会检查本地repo库需不需要更新,如果不需要,便会在本地repo库中获取第三方库的信息,进行配置,而这个库很大,更新需要很久,所以我们一般喜欢加上一句--no-repo-update。
现在知道了repo的作用,那我们就顺藤而下,讲一讲Private Spec Repo。CocoaPods最核心的功能是类库管理,我们平时用的最多的是管理公共类库,说到这你也许已经猜到了,对,它也支持管理非公开的类库。现在大点的iOS项目,代码行数千千万,很多业务模块或者工具类都是相对独立的,可以以独立类库的方式集成进项目中,但是因为种种原因,这些代码不能公开放到GitHub上,只能放在公司服务器上,这时候就需要Private Spec Repo上场了。简而言之它是一个私有的repo库,功能和官方的repo库一样,唯一的区别是它放在自己公司的服务器上,只有本公司的人可以访问,它维护着公司内部私有类库的索引。
三、CocoaPods项目实践
说了这么多,估计不少同学还是一脸懵逼,实践出真知,下面我们来真格的。
最近公司的App要重构,除了本身的金融业务,以后可能还会接入其他品类业务,为了便于今后的业务扩展,必须要把根基打牢。
CocoaPods是个好东西,非常适合我们的项目,所以我们项目的框架结构为“主App+{第三方类库}+{各私有库}”的形式,主App不提供任何业务功能,只负责整合第三方类库和各私有库。第三方类库集成很简单,直接在Podfile文件中搞定,例如pod 'ProtocolBuffers', '1.9.11',私有库相对而言麻烦一点,从制作到使用主要有以下几个步骤:
1、创建Private Spec Repo
首先在公司服务器上创建一个仓库 然后将服务器中的仓库与本地pod repo关联: # pod repo add [Private Repo Name] [GitHub HTTPS clone URL] pod repo add WXPrivateRepo http://公司服务器地址/wxprivaterepo.git 备注:此处WXPrivateRepo名可以随便取,只是取在你本地的一个命名,作为与远端相关联的一个名称。
2、创建私有模块项目,并创建podspec文件
创建一个包含私有代码的项目 在该项目目录下,运行以下命令创建podspec文件 pod spec create WXTestPod 备注:由于此步骤会创建一个完整的配置文件,里面包含许多用不到的配置信息和注释,可进行删除精简。
3、配置验证podspec文件
创建成功后,会在根目录下产生一个.podspec文件,按提示中,填入相应信息后,输入以下命令,进行验证: pod lib lint 若成功会提示passed validation.否则按错误提示进行改正,这一步需要耐心,仔细查看报错信息 备注:验证podspec有两种方式,一种是pod lib lint,验证本地代码,一种是pod spec lint,会根据podspec文件配置,拉取相应的服务器代码进行验证 备注:若该私有库依赖了其他私有库,需要加参数--sources='http://公司服务器地址/wxprivaterepo.git,https://github.com/CocoaPods/Specs',否则无法验证通过
4、本地测试
创建一个新的项目,在这个项目的Podfile文件中直接指定刚才创建编辑好的podspec文件,看是否可用。 在Podfile中我们可以这样编辑,有两种方式 pod 'WXTestPod', :path => ‘/Users/test/wxtestpod/' #指定路径 pod 'WXTestPod', :podspec => '/Users/test/wxtestpod/WXTestPod.podspec' #指定podspec文件 然后执行pod install命令安装依赖,在项目工程中,可以看到pod库安装在Development Pods/WXTestPod中。在项目中编写代码,测试库文件无误后就可以开始下一步了,提交podspec到Spec Repo中。
5、将私有库提交到本地Spec Repo中
将私有库打上tag 向私有Spec Repo提交podspec pod repo push WXPrivateRepo WXTestPod.podspec #前面是本地Repo名字 后面是podspec名字 备注:成功之后这个组件库就添加到我们的私有Spec Repo中了,可以进入到~/.cocoapods/repos/WXPrivateRepo目录下查看,再去看我们的Spec Repo远端仓库,也有了一次提交,这个podspec也已经被Push上去了。
6、使用私有项目
在Podfile文件中需要添加私有Spec Repo的source source 'http://公司服务器地址/wxprivaterepo.git' source 'https://github.com/CocoaPods/Specs.git' pod 'WXTestPod','0.0.9' 备注:私有库和公有库的源都需要添加,否则只能搜到其中的一个代码。
四、版本管理
在App的版本管理方面继承CocoaPods的设计理念,使用tag方式记录版本号。各个私有库由各业务开发人员进行维护,及时更新tag。主App的Podfile中维护各个私有库的版本号,主App在发包时也要打上tag,便于今后复盘问题。
五、持续集成
对高效的团队而言,打包服务器必不可少,我们使用了Jenkins+Fastlane组合套件。
Jenkins的配置很容易上手,请自行百度。
Fastlane是一套工具集合,提供了很丰富强大的功能,我们仅仅使用了它打包生成ipa的功能。
注意:当私有库更新版本号时,主App应该引用最新的私有库代码,这时候就需要及时通知主App更新Podfile,为此我们提供了两种反向更新方式:
提供一个脚本,私有库开发人员更新tag之后,手动执行该脚本,发起http请求,将tag和podname传参给Jenkins服务器,Jenkins执行Fastlane打包流程,若打包成功,自动更新Podfile中的该私有库tag,并提交代码。
在Private Spec Repo的git仓库中添加hook,当有新的tag提交时,触发hook执行一个POST请求,截取该请求,调用Jenkins服务器打包的URL,若打包成功则更新Podfile,这种方式完全自动化,不需要开发人员操心。
两种方式,各有利弊,适合自己才是最好。
最后附上流程图: