CocoaPods三重奏(三) 之 发布开源框架到Cocoapods
前言
Cocoapods
不仅是一个很好的iOS依赖管理工具,同时也可以使用Cocoapods
进行组件化开发,把项目中比较稳定,独立性强的模块抽离出来进行组件化,而本篇文章介绍的是如何发布开源框架到Cocoapods,让更多的人使用你的开源框架。
背景
开发过程中,经常会使用一些比较好用的第三方开源框架(例如AFNetworking,JSONModel等),我们通过
Cocoapods
就可以轻松的安装使用。所以当你自己编写一个开源框架想让别人通过Cocoapods
使用时该怎么做?
基于以上背景,接下来我会一步一步介绍如何通过Cocoapods发布开源框架。
操作步骤
- 创建pod工程(本文以DYNetwork为例),并提交远程git托管平台
- 创建、修改并验证
podspec
文件 - 使用Cocoapods trunk 发布开源库
- 使用开源库
- 更新维护开源库
- 问题总结
创建pod工程
PS:如果你已经有一个工程,并且在git版本管理下,那么可以直接跳过第一步,直接进行第二步,为项目创建podspec文件官方文档,而进行第一步的前提是你没有创建过pod工程。
至于创建pod工程,你可以在github创建一个项目(默认不会包含podspec文件),也可以通过Cocoapods的create工具官方文档创建一个项目(会默认帮你创建一个podspec文件),下面主要介绍通过create工具创建项目,具体步骤如下:
- 先cd到你要创建项目的目录下
- 执行创建命令
pod lib create DYNetwork
之后会问你五个问题,具体问题看下面截图,问完问题后自动调用pod install创建项目并生产依赖
PS: 新版创建命令,会默认引入一些框架,例如FBSnapshotTestCase等,不用管,但是当你用新版xcode打开项目的时候,提示你是否切换swift到最新版本(按照流程切换到最新swift版本就行了),因为是这些默认的框架内部用了swift语言。
创建完成后通过 tree PrivatePodTest -L 2 命令查看目录结果
PS:如果找不到tree命令,可以通过homebrew安装tree
➜ DYNetwork tree DYNetwork -L 2
DYNetwork
├── DYNetwork
│ ├── Assets
│ └── Classes
├── DYNetwork.podspec
├── Example
│ ├── DYNetwork
│ ├── DYNetwork.xcodeproj
│ ├── DYNetwork.xcworkspace
│ ├── Podfile
│ ├── Podfile.lock
│ ├── Pods
│ └── Tests
├── LICENSE
├── README.md
└── _Pods.xcodeproj -> Example/Pods/Pods.xcodeproj
10 directories, 5 files
我们可以看到,通过Cocoapods的create工具创建的项目,会默认给你生成一个podspec文件。
接下来向DYNetwork文件中添加代码和资源,然后修改podspec文件,我把一个“网络处理”的模块放入DYNetwork/Classes中,然后进入Example文件夹执行pod update命令,再打开项目工程可以看到,刚刚添加的组件已经在Pods子工程下Development Pods/DYNetwork中了,然后编辑demo工程,测试网络模块。
PS:这里需要注意的是每当你向Pod中添加了新的文件或者以后更新了podspec的版本都需要重新执行一遍pod update命令。或者你打开demo项目,直接把文件拖到对应的目录下。
项目代码测试无误后,将本地项目添加并推送到远端仓库,因为通过Cocoapods
创建的项目本身在“本地”的git管理控制下,所以如果你想让别人用,就需要把它推到远端。同理在github创建一个git项目,然后拿到ssh地址。
拿到ssh地址后,切换到DYNetwork目录下,添加并推送到远端git。
git add .
git commit -m "initial commit"
git remote add origin [email protected]:guodongyangwen/DYNetwork.git
git push origin master
因为podspec文件中获取Git版本控制的项目还需要tag号,所以我们要打上一个tag,并推送tag到远端。
git tag 0.0.1
git push --tags
创建、修改、验证pod工程对应podspec文件
创建podspec文件
PS:如果通过第一步Cocoapod的create工具创建的项目,上面可以看到Cocoapods会默认为pod工程创建一个podspec文件,如果你是为github上已存在的项目创建一个对应的podspec文件,那么你需要执行下面步骤。
1、切换到项目目录(这里作为演示,项目名为DYFileManager)
2、提交代码,并打上tag(因为创建podspec文件需要)
3、执行以下命令
pod spec create DYFileManager
我们可以看到,create命令创建了一个podspec文件
修改podspec文件
上面介绍了两种创建pod工程的方式,两个方式分别对应不同的podspec文件创建方式(一个默认创建,一个手动创建)。现在我们创建了pod工程(DYNetwork),并创建了对应的podspec文件(DYNetwork.podspec)
接下来开始编辑podspec文件了,它是一个Ruby的文件,把编辑器的格式改成Ruby就能看到语法高亮,下面我贴上我的podspec文件,并在后面以注释的形式说明每个字段的含义,没有涉及到的字段可以去官方文档查阅
Pod::Spec.new do |s|
s.name = 'DYNetwork' #项目名称
s.version = '0.0.1' #当前版本
s.summary = 'network library' #简要信息
#项目描述
s.description = <<-DESC
this is a network library.
DESC
s.homepage = 'http://www.jianshu.com/u/d1a569b086e4' #主页
s.license = 'MIT' #开源协议
s.author = { 'guodongyang' => '[email protected]' } #作者信息
s.source = { :git => 'https://github.com/guodongyangwen/DYNetwork.git', :tag => "0.0.1" } #项目git地址(注:必须是http或者https,不然验证不通过)
s.ios.deployment_target = '8.0' #部署平台
s.requires_arc = true #是否需要arc
s.source_files = 'DYNetwork/Classes/**/*' #项目源代码路径
# s.resource_bundles = {
# 'PrivatePodTest' => ['DYNetwork/Assets/*.png']
# } #项目资源文件路径
s.public_header_files = 'DYNetwork/Classes/**/*.h' #项目头文件路径
s.frameworks = 'UIKit' #引用的框架
# s.dependency 'AFNetworking', '~> 2.3' #依赖的第三方库
end
验证podspec文件
编辑完podspec文件后,需要对其进行验证,如果有者ERROR都是不可以的,它就不能被添加到Cocoapods开源库中,不过xcode的WARNING是可以存在的,验证需要执行一下命令
//命令1 (不予许警告和错误)
pod lib lint
//命令2 (允许警告)
pod lie lint --allow-warnings
//命令3 (验证执行spec)
pod spec lint DYNetwork.podspec
当出现下面信息,代表验证通过,如果出现错误它只会直接一句红色的话The spec did not pass validation, due to 1 error.告诉你的有多少个error和warning,而不会具体的指出你的错误出在哪里,这时候你可以在这句指令后面加上参数--verbose 这样就会告诉你具体的错误信息。这样根据它提示你的错误信息去解决就可以了
-> DYNetwork (0.0.1)
DYNetwork passed validation.
Cocoapods Trunk发布自己的pods
PS:在cocoapods使用了trunk之后,CocoaPods 需要0.33以上版本,用 pod --version查看版本,如果版本低,需要更新。
注册Trunk
注册时需要添加自己的邮箱和用户名,成功后会提示你通过邮箱验证,点击邮箱中的连接验证一下。
如图代表你验证成功,接下来进行注册
pod trunk me
如果你的pod是多人维护的,你可以添加其他维护者:
pod trunk add-owner 用户名 邮箱
Trunk Push
pod trunk push 命令会首先验证你本地的podspec文件(是否有错误),之后会上传spec文件到trunk,最后会将你上传的podspec文件转换为需要的json文件。在工程根目录(包含有.podspec)下执行命令:
pod trunk push
看到这个信息证明你已经发布成功了,也可以查看一下本地的~/.cocoapods/repos/master/Specs目录下看到转换之后的json文件
这时候你可以通过pod search进行搜索,搜不到看下面问题总结
使用开源库
开源库的podspec文件已经添加到远端Cocoapods仓库,这时候就可以像使用其他开源库一样使用了。
创建一个demo工程,创建Podfile文件,添加依赖如下
pod 'DYNetwork' ,'~>0.0.1'
然后执行pod update或者pod install安装依赖库,就可以正常使用了。
更新维护podspec
更新维护就是你后续可能修改代码,或者添加新的功能,或者你不在需要这个组件库然后需要删除。
上面我们已经创建了一个0.0.1版本,现在进行升级到0.0.2。具体步骤如下:
- 建源文件添加到classess目录下,或者从该目录下删除文件等修改。
- 修改之后提交并推送到远端,打上新的tag(比如0.0.2)。
- 修改之后编辑podspec文件,改为新的tag,或者修改源文件引用路径等信息。
- pod spec lint DYNetwork.podspec验证podspec文件
-
验证没有问题,把新版本推送到Cocoapod仓库。
pod trunk push
- 添加成功会显示新添加的版本
7.搜索组件库,会出现两个版本
问题总结:
-
遇到的问题
1、执行pod lib create (组件库) 出错提示错误:rubygems/core_ext/kernel_require.rb:120:in `require': cannot load such file -- colored2 (LoadError) 解决办法: 输入上面提示的colored2的两条gem命令即可解决问题 sudo gem install colored2 sudo gem update --system
2、添加组件库到私有spec repo仓库后 执行 pod search搜索不到。
方法一:
先确认你本地仓库上面确实有你新创建的组件库,这时候可以先删除search缓存文件
rm ~/Library/Caches/CocoaPods/search_index.json
,删除后从新执行pod search ***
方法二:
1.切换到某个项目(含有podfile文件)下
2.执行pod update(提示不能更新)
3.尝试 pod repo update —verbose获取详细信息,我记得是提示我删除一个 index.lock文件,
4.删除后从新 执行 pod repo update —verbose 会更新本地私有库和master仓库
5.执行pod search *** 创建search索引,可以搜到
2.其他关于pod的问题:
Cocoapods环境配置 :
http://blog.csdn.net/cbl643966855/article/details/51120497
Cocoapods使用私有库遇到的坑:
http://www.jianshu.com/p/1e5927eeb341 http://blog.csdn.net/andanlan/article/details/50515434
Cocoapods安装或更新出错:
http://blog.csdn.net/lindir/article/details/52980526
Cocoapods search无法搜索:
http://blog.csdn.net/yuanmengong886/article/details/57083919
写在最后
如何想了解更多关于Cocoapods的用途,请参考我另外两篇文章:
Cocoapods的安装和使用
Cocoapods组件化开发
最后想说的是,写了这些关于Cocoapods使用的文章是因为最近写了一个文件管理的开源库,支持各种文件操作,希望大家支持一下,欢迎大家star,如果有问题直接issue我,项目地址:DYFileManager