Cocoapods,让iOS开发更简单(二):创建私有库
如果你对pods还不是很了解,建议先阅读一下同系列的上篇文章《Cocoapods,让iOS开发更简单(一):走近Cocoapods》,先对pods有一个较为清晰全面的认识。如果你已经具备了一定的了解,并试图创建自己的私有库或者内部使用的内部库,那么本篇文章能有效与你进行沟通交流。话不多说,我们还是即刻出发吧!
如何创建私有库
要创建私有Pod,首先我们需要两个私有仓库,code repo放私有Pod源码,spec repo放私有Pod的说明书(类似公有Pod的CocoaPods/Specs)。
repo简介
- code repository:代码仓库,我们把项目代码上传到这个仓库。
- spec repository:配置仓库,所有的配置按照包名、版本号分门别类的存放在这个仓库。这个仓库只用来存放.Podspec文件,不存放代码。
步骤
- 如果之前已经有私有spec repo,无需再建。如果没有,需要新建。创建一个私有的Spec Repo,添加其到本地
pod repo add [Private Repo Name] [your_privateSpecs.git]
如果执行成功,之后便可以通过pod repo list命令查看本地Spec仓库列表,正常情况下会有一个公有的CocoaPods官方的master repo 和你的 privateSpecs repo,并可以看到它们在本地的存放路径(其实在~/.cocoapods/repos目录下)。
repoList.png
-
在想要创建的目录文件夹下,创建Pod私有库
pod lib create TestPodlib
目录结构如下:
├── Example #demo APP
│ ├── TestPodlib
│ ├── TestPodlib.xcodeproj
│ ├── TestPodlib.xcworkspace
│ ├── Podfile #demo APP 的依赖描述文件
│ ├── Pods #demo APP 的依赖文件
│ └── Tests
├── TestPodlib #库目录
│ ├── Assets #资源文件
│ └── Classes #类文件
├── TestPodlib.podspec #podspec文件
└── _Pods.xcodeproj -> Example/Pods/Pods.xcodeproj
主要有两部分组成:
* TestPodlib: 组件源码
* Example:Demo 工程,会依赖 TestPodlib 库到此 demo 工程,方便调试
pod lib会从 github 下载模版工程,创建完成会自动打开 Example 下的TestPodlib.xcworkspace,在 pod 的工程下有一个Development Pods目录,pod 把我们的源码做为 Demo 工程的一个 pod 库,这跟实际使用是一样的了,只不过我们要改源码。
-
gitlab新建仓库;
-
将本地代码上传到gitlab
- 首先进入刚才创建的仓库,即要上传代码的目录
cd TestPodlib
- 执行git命令,此命令会在当前目录下创建一个.git文件夹
git init
- 将本地的仓库关联到gitlab上
git remote add origin https://github.corp.XXXX.com/ios/TestPodlib.git
- 将项目的所有文件添加到仓库中
//这个命令会把当前路径下的所有文件,添加到待上传的文件列表中。如果想添加某个特定的文件,只需把.换成特定的文件名即可.
git add .
- 将add的文件commit到仓库
git commit -m "注释语句"
- 上传代码到gitlab远程仓库
git push -u origin master
- 如果不小心将git远程地址配错了,再次配置提示错误:fatal: 远程 origin 已经存在。此时只需要将远程配置删除,重新添加即可:
git remote rm origin
git remote add origin https://github.corp.XXXX.com/ios/TestPodlib.git
git push -u origin master
- 如果远程仓库已经有提交或者改动,本地仓库没有更新远程仓库的内容,需要将远程代码库与本地代码库同步一下
git pull origin master
但是可能会出现“fatal:拒绝合并无关历史。”的错误 ,需要用
git pull origin master --allow-unrelated-histories
- 修改podspec文件的内容
除了采用pod 自动从 github 下载pod模版工程的方法,同样也可以基于原有的项目工程文件建立pod库。
操作方式:
在私有Pod代码所在文件夹下执行pod spec create your_podName,则就会在该目录下创建一个your_podName.podspec说明书文件,之后便可以编辑这个说明书文件了。
- 进入podfile目录,pod install检测demo的有效性
pod库的开发过程中,向Pod文件夹中添加库文件和资源,然后进入podfile文件所在的目录下执行pod install命令,pod组件已经在Pods子工程下Development Pods/目录中了,然后编辑demo工程,测试组件。新建的pod库没有在Pods目录下是因为本地测试的缘故。
- 提交源代码并打tag,检测podspec文件的有效性
pod spec lint TestPodlib.podspec --allow-warnings
git tag -m "first release" 0.0.1
git push --tags #推送tag到远端仓库
因为podspec文件中获取Git版本控制的项目需要tag号,所以我们要打上一个tag。
注意
:这里tag必须跟podspec文件中的tag保持一致,因为CocoaPods是通过podspec文件中的tag去找源文件的,如果tag对应不起来就会验证失败。
-
验证podspec文件有效性
有两种验证方式:
- 本地验证:pod lib lint your_podName.podspec
- 联网验证:pod spec lint your_podName.podspec
pod lib lint //pod lib lint 如果有警告,会导致无法通过,需要添加--allow-warnings,允许警告 //如果使用了c函数或静态库,需要添加--use-libraries //如果同时依赖了公有库和私有库,你必须指定源才行,因为默认只会去公有源中查找对应的依赖,需要添加库的源--sources='https://xxxx'
验证通过后,代表这个podspec文件是合格的。
-
向Spec Repo提交podspec(提交说明书文件到私有说明书库)
pod repo push specRepo TestPodlib.podspec
#前面是本地Repo名字 后面是podspec名字
#同样的加上上面验证时使用到的可选参数
- 私有组件库制作完成后,可以使用pod search命令验证一下。