背景介绍
公司某项目工程过于庞大,好几个项目组并行开发,本人涉及到该项目里面的某一块需求。为了方便解耦、并行开发、提高效率等等原因,架构师整了一套看似非常牛逼的架构(类似于蘑菇街、天猫的组件化及各种url跳转),让我把负责的相关代码关联到项目组内部的CocoaPod私有库,最后由主工程在podfile里以Pod "模块名"
的方式,将我的代码整合到主工程中。
关于CocoaPod私有库
概念
CocoaPod,大家都用过,比如Pod 'AFNetWorking'
。平时大家用地最多的是公有库,开发者制作好一个模块上传到CocoaPod官方的一个公共管理库里面,然后其他开发者就可以获取到这个模块。私有库,顾名思义,不公开的。项目组有个私有库,里面放了一些模块,便于项目组成员间的使用。
制作私有库
私有库,一般项目组开发的组长已经建立好了,用的服务器链接一般也会是公司内部的地址。我们需要做的是制作一个pod模块添加到这个私有库中。这里,我们还是从零开始,走完整个流程。
首先,需要一个服务器,存放我们这个私有库。这里我们在coding.net里申请。
仓库取名:MyPodsRepo
仓库地址:https://git.coding.net/pizhulovecode/MyPodsRepo.git
在终端里执行如下指令:
pod repo add MyPodsRepo https://git.coding.net/pizhulovecode/MyPodsRepo.git
这个时候,在本地也已经生成了私有库,通过如下指令查看文件目录:
cd ~/.cocoapods/repos
ls
我们可以看到:两个文件夹:master 和 MyPodsRepo 。master是Cocoapods官方的公有库,我们从一开始安装上Cocoapods的时候就有了。我们还可以进入到master文件夹里看看里面装的都是些什么东西,而现在MyPodsRepo文件夹里是空的。
制作Pod模块
说明
前面我们说了,要把自己制作的pod模块添加到这个私有库中。其实真正存在私有库中的是一个xxx.podspec
或者xxx.podspec.json
文件。spec(说明书、细则),也就是一个描述文件。通过这个描述文件,我们在执行pod install
的时候,CocoaPod会将我们的模块里的代码从存放代码的远程服务器里下载到工程中。所以,我们还需要一个存放pod模块代码的仓库。
在本地制作一个pod模块
我们先在本地制作一个pod模块,然后将模块中的代码上传到仓库里(注意:不是前面提到的私有仓库,也就是说我们总共需要两个仓库,一个用来存放spec文件,一个用来存放具体的模块代码)
至于如何制作pod模块,CocoaPod官方已经给我们制作好了一个模版,只需要将自己的代码拷贝到相关目录下,同时修改下spec文件。具体操作:
在终端下执行指令:
pod lib create 模块名(如AFNetWorking之类的)
这里我们取模块名:MyFirstPod
执行:pod lib create MyFirstPod
这时就会从远处clone一份工程模板到我们本地,同时需要你回答输入几个问题:
1. What is your email? -- xxx.xx@xx
2. What language do you want to use?? [ Swift / ObjC ] --- ObjC
3. Would you like to include a demo application with your library? [ Yes / No ] --- Yes
4. Which testing frameworks will you use? [ Specta / Kiwi / None ] ---None
5. Would you like to do view based testing? [ Yes / No ] --No
6. What is your class prefix? -- 类的自定义前缀
之后,本地就多了一个MyFirstPod的文件夹,打开文件夹,我们来看下里面的目录结构:
代码的存放位置
我们自己的代码只需要放到红色框所在的目录下,ReplaceMe,对,就是让你删除它,用自己的代码替换进去。我们这里放入一个文件夹和两个文件:
编辑podspec文件
pod的描述文件,通过编辑后,我们让CocoaPods知道:我们的代码的远程仓库在哪里、当前pod的版本号是多少……之类的问题。
我们看到原本的source:
s.source = { :git => 'https://github.com/****/MyFirstPod.git', :tag => s.version.to_s }
我们现在要对source地址进行修改,将我们远程仓库的地址替换进去。
在这里,我们去github上申请一个公开的仓库https://github.com/PizhuLoveCode/MyFirstPodSourceCode.git
,也可以去coding或者其他网站,这里就是举个例子而已。然后替换podspec中的source。
s.source = { :git => 'https://github.com/PizhuLoveCode/MyFirstPodSourceCode.git'}
, :tag => s.version.to_s 这部分先去除
代码上传到远程仓库
在上传代码前,需要验证下podspec这个文件编辑是否正确。
在终端里执行:
pod lib lint --allow-warnings
注意:如果spec文件中有s.dependency 私有库xx,那么需要写成:
pod lib lint --sources=http://github.com/CocoaPods/Specs.git,http://xxxx(私有地址) --allow-warnings --verbose --use-libraries
成功后就能看到:MyFirstPod passed validation.
然后执行如下指令将代码上传到远程:
git remote add origin https://github.com/PizhuLoveCode/MyFirstPodSourceCode.git
git push -u origin master
将制作好的spec文件上传到私有库里
pod repo push MyPodsRepo MyFirstPod.podspec --allow-warnings
上传成功后,我们去私有远程库可以看到已经成功上传了MyFirstPod.podspec
文件,同时本地也有一份。
使用pod模块
先查看下我们的模块在库里有没有存在:
pod search MyFirstPod
-> MyFirstPod (0.1.0)
A short description of MyFirstPod.
pod 'MyFirstPod', '~> 0.1.0'
- Homepage: https://github.com/PizhuLovecode
- Source: https://github.com/PizhuLoveCode/MyFirstPodSourceCode.git
- Versions: 0.1.0 [MyPodsRepo repo]
这样我们就可以在工程中使用这个pod模块了,我们新建一个xcode工程MainPro,进入目录执行
pod init
在Podfile里编辑:
source 'http://github.com/CocoaPods/Specs.git'
source 'https://git.coding.net/pizhulovecode/MyPodsRepo.git'
#use_frameworks!
target 'MainPro' do
pod 'MyFirstPod'
end
执行:
pod install
最后,我们在pods可以看到MyFirstPod文件夹,里面就是我们的代码。
最后
整个过程有一些坑,特别是对一个不熟悉git的开发者会更加难办,欢迎通过QQ:564226844与我取得交流。
下面是一些参考文章:
- 如何创建私有 CocoaPods 仓库
- 使用Cocoapods创建私有podspec