目录
● 创建壳工程TZQDemo,使用cocoaPods创建私有库TZQTool,并上传到Github远端。
● 修改私有库的描述文件,上传到Github远端。
● 验证私有库有效性。
● 搜索和使用私有库TZQTool。
一、前言
组件化越来越流行,以及很多人想把自己写的组件分享给他人使用。iOS 大部分都采用CocoaPods包管理工具安装组件,本文总结了一下如何使用CocoaPods将自己的组件制作成私有库,方便自己和他人使用,如有错误请留言指正。show me the code, talk is cheap!
二、制作私有库
1、在制作私有库之前,先搜索一下CocoaPods,看看是否有相同名字的库,如有建议换一个私有库的名字。
pod search AAA // AAA是你的私有库的名字。
2、 制作壳工程TZQDemo和TZQTool私有库。
1)使用X-Code创建一个工程,添加PodFile文件,运行pod install,生成一个.xcworkspace工程,点击运行.xcworkspace工程。
2)在工程目录下添加Components文件夹,用来存放本地组件库。使用指令,先查询一下本地有那些pod repo。
然后进入到Components,使用pod lib create TZQTool 指令生成TZQTool组件。
pod repo // 查看本地的所有的描述文件。
pod lib create TZQTool // 创建一个TZQTool的组件。
3)添加代码到TZQTool中,修改TZQTool的描述文件,先在本地验证TZQTool是否可用。TZQTool是生成一个当前时间的字符串。可用以后将相应的文件导入,先将.h .m等文件拖入到Classes文件夹,将xib、图片等资源文件拖入到Assets文件夹,删除replaceMe文件。删除原工程的相关文件,TZQTime.h和TZQTime.m,不然后面通过本地安装以后有2份,会有冲突。运行pod install命令,从本地安装组件。安装后clean一下工程,再运行看结果是否正确。如果正确,说明本地的组件已经创建好,下一步准备上传到远程仓库。
4)在Github上创建远程仓库,修改TZQTool.podspec文件,并将组件上传到远程仓库。
可以使用git客户端如soourceTree、Tower或者git命令上传组件到远程仓库。这里用命令行做演示。
cd /Users/apple/Desktop/TZQDemo/Components/TZQTool // 进入到文件夹
git init // 初始化,生成.git记录文件
add . // 所有的文件加入到版本控制
git commit -m"第一次提交TZQTool" // 将加入到版本控制的文件,提交到本地仓库
git remote add origin https://github.com/tzq20070604/TZQTool.git // 给本地的仓库关联到远程仓库
git push origin master -f // 将本地仓库同步到远程仓库,-f 表示强制提交,因为提交前一般都要update,强制提交不用。因为Github上还有readme之类的文件,需要解决冲突再pull,比较麻烦,基于是初始工程,直接强制push上去即可。查看远程仓库,可以看到自己提交的内容。到此完成把工程提交到远程仓库的任务。
5)给组件打tag,tag的目的是让其他人能够在pod中引用到具体版本。
git tag 1.0 // 打上版本,要和TZQTool.podspec文件中tag一致
git push --tags // 同步版本到远程仓库
6)制作描述文件的远程私有库TZQSpec,并且同步描述文件到远程私有库TZQSpec。多个.spec文件可以共用一个仓库。
7)提交描述文件到远程仓库。
pod repo add TZQSpec https://github.com/tzq20070604/TZQSpec.git // 在本地创建一个TZQSpec的repo文件,并关联到远程。这个文件可以在本地看到。
pod repo push TZQSpec TZQTool.podspec --verbose --allow-warnings // 定位到TZQTool.podspec所在的文件夹,向TZQSpec提交podspec。
三、验证私有库有效性。
1、验证.podspec文件的有效性。使用第一句有警告,建议使用第二句。出现TZQTool passed validation.表示验证成功。如果此时搜索pod search AAA,是搜索到本地的。
pod lib lint --verbose // 可能出现有警告的错误
pod lib lint --verbose --allow-warnings
检查.podspec文件是否合法。注意:1)带有静态库的还有加条件--use-libraries。 2).podspec 不能带有本地的依赖。3)如果有私有依赖库,验证时还要加上依赖的路径。
pod lib lint --sources=https://github.com/tzq20070604/TZQSpec.git,https://github.com/CocoaPods/Specs.git --use-libraries --allow-warnings
2、发布.podspec文件到CocoaPods的master分支。成功以后,其他人可以使用pod search AAA 搜索到。
如果是第一次创建,需要注册。
注册trunk
pod trunk register xxx@cocoapods.org 'huangxx' --description='huangxx' macbook pro' --verbose
xxx@cocoapods.org- 一个真实存在的邮箱,不一定非得是@cocopods.org,例如QQ。
huangxx - 用户名
huangxx's macbook pro - 描述性文字
如果所有的步骤都能成功的话,你会受到一份邮件,需要点击验证下。
3、如果是公有库还需要发布到cocoaPods trunk上。私有库就不用了。如果私有库发布到trunk上会报错。
[!] Source code for your Pod was not accessible to CocoaPods Trunk. Is it a private repo or behind a username/password on http?
查看trunk
pod trunk me
可以查看你已经注册的信息,其中包含你的name、email、since、Pods、sessions,其中Pods为你往CocoaPods提交的所有的Pod!
添加其他维护者(如果你的pod是由多人维护的,你也可以添加其他维护者)
pod trunk add-owner XPRACSignal wangxx@cocoapods.org
发布到trunk,--allow-warnings可以避免验证警告。会去更新Updating spec repo `master`,需要等待一段时间。
pod trunk push TZQTool.podspec --verbose --allow-warnings
如果你之前提交过Pod,那么trunk之后你需要去Claim your Pod认领下!
报找不到MBKit repo的错误。此时需要执行pod repo update 刷新一下本地repo的索引。再执行上面的命令,如果是第一次发布需要注册登记,还需要使用下面的命令,注册邮箱和用户名,邮箱会收到一条链接,点击该链接即可认证。
pod trunk register 525835890@qq.com "tzq"
pod repo update --verbose
四、使用生成的私有库
1、因为是私有库,必须把私有库的repo路径加上,让pod知道去那里找到这个私有库。
source 'https://github.com/tzq20070604/TZQSpec.git'
pod TZQTool
或者
pod TZQTool :git=>'https://github.com/tzq20070604/TZQSpec.git',:tag=>'1.0'
2、使用私有库
五、引用文章
iOS模块化开发 之 通过CocoaPods调用自己iOS模块化开发 之 通过CocoaPods调用自己封装的私有库 (一)