CocoaPods三重奏(三) 之 发布开源框架到Cocoapods

CocoaPods三重奏(三) 之 发布开源框架到Cocoapods

前言

Cocoapods 不仅是一个很好的iOS依赖管理工具,同时也可以使用Cocoapods 进行组件化开发,把项目中比较稳定,独立性强的模块抽离出来进行组件化,而本篇文章介绍的是如何发布开源框架到Cocoapods,让更多的人使用你的开源框架。


背景

开发过程中,经常会使用一些比较好用的第三方开源框架(例如AFNetworking,JSONModel等),我们通过Cocoapods就可以轻松的安装使用。所以当你自己编写一个开源框架想让别人通过Cocoapods使用时该怎么做?

基于以上背景,接下来我会一步一步介绍如何通过Cocoapods发布开源框架。


操作步骤

  1. 创建pod工程(本文以DYNetwork为例),并提交远程git托管平台
  2. 创建、修改并验证podspec文件
  3. 使用Cocoapods trunk 发布开源库
  4. 使用开源库
  5. 更新维护开源库
  6. 问题总结

创建pod工程

PS:如果你已经有一个工程,并且在git版本管理下,那么可以直接跳过第一步,直接进行第二步,为项目创建podspec文件官方文档,而进行第一步的前提是你没有创建过pod工程。

至于创建pod工程,你可以在github创建一个项目(默认不会包含podspec文件),也可以通过Cocoapods的create工具官方文档创建一个项目(会默认帮你创建一个podspec文件),下面主要介绍通过create工具创建项目,具体步骤如下:

  1. 先cd到你要创建项目的目录下
  2. 执行创建命令
pod lib create DYNetwork

之后会问你五个问题,具体问题看下面截图,问完问题后自动调用pod install创建项目并生产依赖

PS: 新版创建命令,会默认引入一些框架,例如FBSnapshotTestCase等,不用管,但是当你用新版xcode打开项目的时候,提示你是否切换swift到最新版本(按照流程切换到最新swift版本就行了),因为是这些默认的框架内部用了swift语言。

14944920634085.png

创建完成后通过 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地址。

14944925261542.png
14944925696786.png

拿到ssh地址后,切换到DYNetwork目录下,添加并推送到远端git。

git add .
git commit -m "initial commit"
git remote add origin git@github.com: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

14944934326101.png

我们可以看到,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' => 'guodongyangw@163.com' }                             #作者信息
  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

14944952410624.png

注册时需要添加自己的邮箱和用户名,成功后会提示你通过邮箱验证,点击邮箱中的连接验证一下。

14944953868709.png

如图代表你验证成功,接下来进行注册

pod trunk me 
14944955301470.png

如果你的pod是多人维护的,你可以添加其他维护者:

pod trunk add-owner 用户名 邮箱

Trunk Push

pod trunk push 命令会首先验证你本地的podspec文件(是否有错误),之后会上传spec文件到trunk,最后会将你上传的podspec文件转换为需要的json文件。在工程根目录(包含有.podspec)下执行命令:

pod trunk push
14944964748851.png

看到这个信息证明你已经发布成功了,也可以查看一下本地的~/.cocoapods/repos/master/Specs目录下看到转换之后的json文件

14944966364496.png

这时候你可以通过pod search进行搜索,搜不到看下面问题总结

14944971559690.png

使用开源库

开源库的podspec文件已经添加到远端Cocoapods仓库,这时候就可以像使用其他开源库一样使用了。

创建一个demo工程,创建Podfile文件,添加依赖如下

pod 'DYNetwork' ,'~>0.0.1'

然后执行pod update或者pod install安装依赖库,就可以正常使用了。

14944972903687.png

更新维护podspec

更新维护就是你后续可能修改代码,或者添加新的功能,或者你不在需要这个组件库然后需要删除。

上面我们已经创建了一个0.0.1版本,现在进行升级到0.0.2。具体步骤如下:

  1. 建源文件添加到classess目录下,或者从该目录下删除文件等修改。
  2. 修改之后提交并推送到远端,打上新的tag(比如0.0.2)。
  3. 修改之后编辑podspec文件,改为新的tag,或者修改源文件引用路径等信息。
  4. pod spec lint DYNetwork.podspec验证podspec文件
14944979066781.png
  1. 验证没有问题,把新版本推送到Cocoapod仓库。

    pod trunk push
    
14944979422418.png
  1. 添加成功会显示新添加的版本
14944979700004.png

7.搜索组件库,会出现两个版本

14944980280274.png

问题总结:

  1. 遇到的问题
    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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 160,646评论 4 366
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,979评论 1 301
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 110,391评论 0 250
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,356评论 0 215
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,740评论 3 293
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,836评论 1 224
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,022评论 2 315
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,764评论 0 204
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,487评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,728评论 2 252
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,200评论 1 263
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,548评论 3 260
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,217评论 3 241
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,134评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,921评论 0 201
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,919评论 2 283
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,766评论 2 274

推荐阅读更多精彩内容