前言
做iOS开发3、4年了,看了很多别人的库,也有很多自己的组件,类,在新启一个项目时,不免要拿以前的东西来用,以前一直是保存在自己电脑的,需要用哪个直接copy,很不友好,而且有些东西不太好找,根据项目有不同的变动的话就会有很多的版本出来等等等吧,总之很多原因。基于此呢,就想做自己的私有库,这个东西呢,其实早就知道了,但是人比较懒,一直也没有去搞,前段时间搞了一下,但是遇到一些问题,再加上比较忙就搁下了,这次卷土重来也是遇到很多问题,还好最后成功了,把自己遇到的问题做个记录吧。
先附上一张成功图片
创建私有Spec Repo
先来说第一步,什么是Spec Repo?它是所有的Pods的一个索引,
就是一个容器,所有公开的Pods都在这个里面,它实际是一个Git仓库remote端在GitHub上,但是当你使用了Cocoapods后它会被clone到本地的~/.cocoapods/repos目录下,可以进入到这个目录看到master文件夹就是这个官方的Spec Repo了。这个master目录的结构是这个样子的
├── Specs
└── [SPEC_NAME]
└── [VERSION]
└── [SPEC_NAME].podspec
因此我们需要创建一个类似于master的私有Spec Repo。首先创建一个 Git仓库,这个仓库你可以创建私有的也可以创建公开的,需要注意的就是如果项目中有其他同事共同开发的话,你还要给他这个Git仓库的权限。
1.创建一个 Git仓库
创建完成之后在Terminal中执行如下命令
#pod repo add [Private Repo Name] [GitHub HTTPS clone URL]
$ pod repo add gd_repos https://github.com/dujinxin/JXView-Swift.git
此时如果成功的话进入到~/.cocoapods/repos目录下就可以看到gr_repos这个目录了。至此第一步创建私有Spec Repo完成。
2.创建Pod项目工程文件
如果是有现成的模块组件,并且在Git的版本管理下,可以跳过这一步。如果从零开始,使用Cocoapods进行创建,可以参考https://guides.cocoapods.org/making/using-pod-lib-create.html
我第一次成功是参考别人用以下方式创建(JXView为例):
$ mkdir JXView
$ cd JXView
$ pod lib create JXView
之后终端会出现四个问题:1,选用哪种语言;2.是否需要一个例子工程;3.选择一个测试框架;4.是否基于View测试。
选择完这4个问题,自动执行pod install命令创建项目并生成依赖。向Pod文件夹中添加库文件和资源,并配置podspec文件,把模块的共有组件放入Pod/Classes中,然后进入Example文件夹执行pod update命令,再打开项目工程可以看到,刚刚添加的组件已经在Pods子工程下Development Pods/PodTestLibrary中了,然后编辑demo工程,测试组件,我并没有使用提供的测试框架进行测试,这里就先不介绍了。
$ cd /Users/dujinxin/github/JXView-Swift/Example/
$ pod update
注意:这里需要注意的是每当你向Pod中添加了新的文件或者以后更新了podspec的版本都需要重新执行一遍pod update命令。
测试无误后需要将该项目添加并推送到远端仓库,并编辑podspec文件。通过Cocoapods创建出来的目录本身就在本地的Git管理下,如果我们托管到远端服务器,那么我们需要做的就是给它添加远端仓库,同样去GitHub或其他的Git服务提供商那里创建一个私有的仓库,拿到HTTP地址,然后cd到JXView目录,执行一下步骤:
$ git add .
$ git commit -s -m "Initial Commit of Library"
$ git remote add origin https://github.com/dujinxin/JXView-Swift.git #添加远端仓库
$ git push origin master #提交到远端仓库
注:如果推送远端仓库失败,可以根据提示来操作,对命令行不熟的,可以通过git客户端来操作
因为podspec文件中获取Git版本控制的项目还需要tag号,所以我们要打上一个tag
$ git tag -m "first release" "0.0.1"
$ git tag -m "release JXView with podspec" "v0.0.5"
$ git push --tags #推送tag到远端仓库
3.编辑podspec文件
编辑完podspec文件后,需要验证一下这个文件是否可用
$ pod lib lint
注意:如果有任何WARNING或者ERROR都是不可以的,它就不能被添加到Spec Repo中,Xcode允许警告存在,所以可以通过命令“$ pod lib lint --allow-warnings”屏蔽警告,如果出现Error但是提示信息不足,可以通过命令“$ pod lib lint --verbose”以获取更多错误信息。
如果验证不通过,根据提示修改podspec,直到再次验证通过如下:
podspec更多设置可以参考官方实例http://guides.cocoapods.org/syntax/podspec.html,想了解更多跟项目相关的设置,还可以上GitHub参考知名第三库的podspec
4.向Spec Repo提交podspec
向Spec Repo提交podspec需要完成两点一个是podspec必须通过验证无误,再一个就是删掉无用的注释(这个不是必须的,为了规范还是删掉吧)。
$ pod repo push gd_repos JXView.podspec #前面是本地Repo名字 后面是podspec名字
之前没有发布过pods的,这一步不成功,需要先注册Trunk
CocoaPods 0.33中加入了Trunk服务。CocoaPods Trunk服务的引入,解决了很多类似的问题。CocoaPods作为一个集中式的服务,使得分析和统计平台数据变得十分方便。要想使用Trunk服务,首先你需要注册自己的电脑。这很简单,只要你指明你的邮箱地址(spec文件中的)和名称即可。
$ pod trunk register 123456@qq.com 'zhangsan' --description='macbook air'
后面可以加上 –verbose可选参数,为了便于输出注册过程中的调试信息,然后顺利的话你会收到一份邮件,需要点击验证。验证成功后,我们就可以开始 trunk push 了提交我们的podspec文件。
$ pod trunk push JXView.podspec
pod trunk push 命令会首先验证你本地的podspec文件(是否有错误),之后会上传spec文件到trunk,最后会将你上传的podspec文件转换为需要的json文件,再去看我们的Spec Repo远端仓库,也有了一次提交,这个podspec也已经被Push上去了。至此,我们的这个组件库就已经制作添加完成了。
注意:可以使用以下命令查看自己的注册信息“$ pod trunk me”。当然,如果你的pod是由多人维护的,你也可以添加其他维护者“$ pod trunk add-owner ARAnalytics kyle@cocoapods.org”
5.查看和使用我们自己的库
使用pod search命令就可以查到我们自己的库了.
$ pod search JXView
在完成这一系列步骤之后,我们就可以在正式项目中使用这个私有的Pod了只需要在项目的Podfile里增加以下一行代码即可
$ pod 'JXView', '~> 0.0.5'
然后执行pod update,更新库依赖,我们自己的库文件已经出现在Pods子项目中的Pods子目录下了,而不再是Development Pods。
至此我们的pods私有库就制作完成了,在制作过程中遇到的问题可以参考http://www.jianshu.com/writer#/notebooks/8215347/notes/16219131
参考:https://guides.cocoapods.org/making/using-pod-lib-create.html