CocoaPods三重奏(二) 之 组件化开发

CocoaPods三重奏(二) 之 组件化开发

前言

Cocoapods 不仅是一个很好的iOS依赖管理工具,同时也可以使用Cocoapods 管理项目中的公共组件,关于Cocoapods的安装和使用可以参考我的另一篇文章Cocoapods安装和使用,本篇是关于如何使用Cocoapods进行组件化。


背景

背景1:项目开发到一定阶段后会变得很庞大,模块间的依赖错从复杂,维护成本增加,并且模块间紧耦合不利用代码复用。

背景2:同时开发多个项目,基础模块都一样(比如网络模块、model解析模块,工具模块等),不同的项目使用不同的模块。

基于以上背景,可以把公共模块抽离出来进行组件化重构,然后根据项目自身需要进行组合,提升代码复用性,降低模块间耦合。

本文主要介绍,如何通过搭建私有Spec仓库,然后创建私有pod库并上传到Spec仓库的操作过程让你了解如何通过Cocoapods进行组件化开发。


操作步骤

  • 创建并设置一个 Spec repo 仓库来管理podspec文件
  • 创建私有pod工程,并提交远程git托管平台
  • 创建pod库对应的podspec文件
  • 修改并验证podspec文件是否可用
  • 提交podspec文件到 Spec 仓库
  • 在项目Podfile中引用常见的pod库并使用
  • 更新维护podspec

创建私有Spec repo

Spec repo仓库是什么?它是所有的Pods的一个索引,就是一个容器,所有公开的Pods都在这个里面,它实际是一个Git仓库remote端在GitHub上,但是当你使用了Cocoapods后它会被clone到本地的~/.cocoapods/repos目录下,可以进入到这个目录看到master文件夹就是这个官方的Spec Repo了,这个master目录结构如下:

└── Specs
    └── [SPEC_NAME]
        └── [VERSION]
            └── [SPEC_NAME].podspec
            

而我们需要做的是创建一个类似Spec repo的私有库,先在 git 上创建一个git仓库,这个git仓库可以是私有的也可以是共有的,但是既然是私有的Spec repo,建议还是创建一个私有的git仓库,如何需要其他同事协同开发,需要把开放git权限给对方,至于如何创建私有仓库,我用的是我们公司自己搭建的gitlab。也可以使用github的私有仓库(注:付费)。或者其他的平台。

14944011544191.png

创建完git仓库后在终端执行以下命令创建私有仓库

# pod repo add [Private Repo Name] [GitHub HTTPS clone URL]
$ pod repo add GDYSpecs http://git.qfpay.net/guodongyang/GDYSpecs.git

如何添加成功,进到~/.cocoapods/repos目录下面会有刚才添加的仓库

14944013755592.png

创建pod工程

PS:如果你已经有一个组件项目,并且在git版本管理下,那么可以直接为这个项目创建podspec文件。创建它需要执行Cocoapods的另外一个命令,命令如下:,官方文档在这里,一般情况下,都是从新创建新的pod项目。

pod spec create PrivatePodTest git@git.qfpay.net:guodongyang/TestPodDemo.git

创建完成后,也需要对podspec进行验证。

pod lib lint

如果你还没有创建pod项目,那么建议你使用Cocoapods提供的一个create工具(官方文档)来创建你的pod项目。具体步骤如下:

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

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

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

14944027647226.png

创建完成后通过 tree PrivatePodTest -L 2 命令查看目录结果

PS:如果找不到tree命令,可以通过homebrew安装tree

➜  PrivatePodTest tree PrivatePodTest -L 2
PrivatePodTest
├── Example
│   ├── Podfile
│   ├── Podfile.lock
│   ├── Pods
│   ├── PrivatePodTest
│   ├── PrivatePodTest.xcodeproj
│   ├── PrivatePodTest.xcworkspace
│   └── Tests
├── LICENSE
├── PrivatePodTest
│   ├── Assets
│   └── Classes
├── PrivatePodTest.podspec
├── README.md
└── _Pods.xcodeproj -> Example/Pods/Pods.xcodeproj

10 directories, 5 files

接下来向PrivatePodTest文件中添加代码和资源,然后修改podspec文件,我把一个“文件管理”的共有组件放入PrivatePodTest/Classes中,然后进入Example文件夹执行pod update命令,再打开项目工程可以看到,刚刚添加的组件已经在Pods子工程下Development Pods/PrivatePodTest中了,然后编辑demo工程,测试组件。

PS:这里需要注意的是每当你向Pod中添加了新的文件或者以后更新了podspec的版本都需要重新执行一遍pod update命令。或者你打开demo项目,直接把文件拖到对应的目录下。

项目代码测试无误后,将本地项目添加并推送到远端仓库,并修改podspec文件。

因为通过Cocoapods创建的项目本身在本地的git管理控制下,所以如果你想让别人用,就需要把它推到远端。同理在git平台创建一个git项目,然后拿到ssh地址。

016E6885-DDB0-46DF-A4CF-3E229952B693.png
14944048008341.png

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

git add .
git commit -m "initial commit"
git remote add origin git@git.qfpay.net:guodongyang/TestPodDemo.git
git push origin master

因为podspec文件中获取Git版本控制的项目还需要tag号,所以我们要打上一个tag,并推送tag到远端。

git tag 0.0.1
git push --tags

修改并验证podspec文件

接下来开始编辑podspec文件了,它是一个Ruby的文件,把编辑器的格式改成Ruby就能看到语法高亮,下面我贴上我的podspec文件,并在后面以注释的形式说明每个字段的含义,没有涉及到的字段可以去官方文档查阅

Pod::Spec.new do |s|

  s.name             = 'PrivatePodTest'                           #项目名称
  s.version          = '0.0.1'                                    #当前版本
  s.summary          = 'Test for private pod'                     #简要信息
  #项目描述
  s.description      = <<-DESC
this is a test for private pod.
                       DESC

  s.homepage         = 'http://www.jianshu.com/u/d1a569b086e4'                                  #主页
  # s.screenshots    = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2'        #截屏
  s.license          = 'MIT'                                                                   #开源协议
  s.author           = { 'guodongyang' => 'guodongyangw@163.com' }                             #作者信息
  s.source           = { :git => 'http://git.qfpay.net/guodongyang/TestPodDemo.git', :tag => "0.0.1" }   #项目git地址(注:必须是http或者https,不然验证不通过)
  
  s.ios.deployment_target = '8.0'                                                              #部署平台
  s.requires_arc = true                                                                       #是否需要arc

  s.source_files = 'PrivatePodTest/Classes/**/*'                                               #项目源代码路径
  
  # s.resource_bundles = {
  #   'PrivatePodTest' => ['PrivatePodTest/Assets/*.png']
  # }                                                                                           #项目资源文件路径

   s.public_header_files = 'PrivatePodTest/Classes/**/*.h'                                                 #项目头文件路径
   s.frameworks = 'UIKit'                                                                       #引用的框架
  # s.dependency 'AFNetworking', '~> 2.3'                                                       #依赖的第三方库
end


编辑完podspec文件后,需要对其进行验证,如果有任何WARNING或者ERROR都是不可以的,它就不能被添加到Spec Repo中,不过xcode的WARNING是可以存在的,验证需要执行一下命令

pod lib lint                    //不予许警告和错误
pod lie lint --allow-warnings   //允许警告

当出现下面信息,代表验证通过

-> PrivatePodTest (0.0.1)

PrivatePodTest passed validation.

现在只能只用这个podspec符合验证,但是不一定能使用。

本地测试podspec文件

本地创建一个项目,然后创建Podfile文件,直接指定创建的podspec文件的路径,看看是否可用。

具体内容如下:

     platform :ios , '8.0'
     target 'testPodDemo' do
     
     #pod 'PrivatePodTest', :path => '../PrivatePodTest/PrivatePodTest'
     pod 'PrivatePodTest', :podspec => '../PrivatePodTest/PrivatePodTest/PrivateP    odTest.podspec'

    inhibit_all_warnings!
 
    end
    
A314D2D3-7985-40E5-A587-ACB38494047F.png

看到上面,就证明安装成功,运行demo测试一下。

提交podspec到Specs仓库

PS: 在提交podspec文件之前,一定要保证podspec验证通过并且没有错误,尽量去掉没用的注释。

提交podspec文件命令(切换到PrivatePodTest目录下):

pod repo push GDYSPecs PrivatePodTest.podspec //前面是本地repo仓库名,后面是要提交的podspec
14944087338838.png

完成之后查看本地repo仓库GDYSpecs,可以进入~/.cocoapods/repos/GDYSpecs/

14944088256758.png

可以看到,我们已经把这个组件库添加到 本地spec repo仓库中了,这个时候你看一下远端spec repo仓库,应该也有一次提交,证明我们的podspec文件也提交到了远端spec repo。

14944091009057.png

至此,组件库已经创建并且上传成功,可以通过pod search进行搜索
如果搜索不到,请看下面相关问题总结。

-> PrivatePodTest (0.0.1)
   Test for private pod
   pod 'PrivatePodTest', '~> 0.0.1'
   - Homepage: http://www.jianshu.com/u/d1a569b086e4
   - Source:   http://git.qfpay.net/guodongyang/TestPodDemo.git
   - Versions: 0.0.1 [GDYSpecs repo]
...skipping...
  $ /usr/bin/git -C /Users/gdy/.cocoapods/repos/GDYSpecs reset --hard
  origin/master
  HEAD is now at 87d4f21 [Add] PrivatePodTest (0.0.1)

这里是添加组件库到私有仓库,如果想添加到cocoapods的开源库,需要通过trunk工具,具体请参考官方文档

使用组件库

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

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

pod 'PrivatePodTest' ,'~>0.0.1'

然后执行pod update更新依赖库,就可以正常使用了。

更新维护podspec

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

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

  1. 建源文件添加到classess目录下,或者从该目录下删除文件等修改。

  2. 修改之后提交并推送到远端,打上新的tag(比如0.0.2)。

  3. 修改之后编辑podspec文件,改为新的tag,或者修改源文件引用路径等信息。

  4. pod lib lint验证podspec文件

  5. 验证没有问题,把新版本提交到本地spec repo仓库。

    pod repo push GDYSpecs PrivatePodTest.podspec
    
  6. 添加成功会显示新添加的版本

➜  GDYSpecs git:(master) tree PrivatePodTest -L 2
PrivatePodTest
├── 0.0.1
│   └── PrivatePodTest.podspec
└── 0.0.2
    └── PrivatePodTest.podspec

2 directories, 2 files

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

-> PrivatePodTest (0.0.2)
   Test for private pod
   pod 'PrivatePodTest', '~> 0.0.2'
   - Homepage: http://www.jianshu.com/u/d1a569b086e4
   - Source:   http://git.qfpay.net/guodongyang/TestPodDemo.git
   - Versions: 0.0.2, 0.0.1 [GDYSpecs repo]

删除本地spec repo仓库 和组件库(PrivatePodTest)

删除本地Spec repo

pod repo remove GDYSpecs

删除之后也可以从新添加

pod repo add GDYSpecs git@git.qfpay.net:guodongyang/GDYSpecs.git

删除私有spec repo仓库下的某个组件库,直接切换到spec repo目录下,删除对应的组件库

14944125699786.png

然后将git的变动提交并推向远端

14944126116278.png

到git远端查看结果:

14944127063269.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

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

推荐阅读更多精彩内容