Cocoapods 私有库制作以及一些tips

96
Dennis_me
0.1 2017.07.19 16:22* 字数 3162

前言

CocoaPods是一个程序依赖管理工具,使用CocoaPods可以节省设置和更新第三方开源库的时间,同样的也可以利用CocoaPods来管理我们的私有库。以下使用CocoaPods管理私有库的方法是以安装了CocoaPods为前提条件的。CocoaPods的安装可查看这篇blog

正题

一、使用CocoaPods管理私有库的方法包括如下几个步骤:

1.创建并设置一个私有的Spec Repo
2.创建Pod所需要的项目工程文件,并且有可访问的项目版本控制地址。
3.创建Pod所对应的podspec文件。
4.本地测试配置好的podspec文件是否可用。
5.向私有的Spec Repo中提交podspec
6.在个人项目中的Podfile文件里增加自己私有库的Pod并使用。
在这一系列步骤中需要创建两个Git仓库,分别是第一步和第二步(第二步不一定非要Git仓库,只要是可以获取到相关代码文件就可以,也可以是SVN等,区别只在于podspec文件中的source配置项所填写的内容不同),并且第一步只是在初次创建私有podspec时才需要,之后在创建其他的只需要从第二步开始就可以。本文以在Git环境下的操作为例做介绍。

二、下面来逐步介绍整个流程:

1.创建私有的Spec Repo

先说第一步,什么是Spec Repo?他是所有的Pods的一个索引,也就是一个容器,所有公开的Pods都在这个里面,它实际是一个Git仓库的remote端在GitHub上,当你使用了CocoaPods后它会被clone到本地的~/.cocoapods/repos目录下,可以进入到这个目录看到master文件夹就是这个官方的Spec Repo了。所有官方公共的Pods所对应的podspec文件都在这个路径下的Specs文件夹下。
因此我们需要创建一个类似于master的私有Spec Repo,这里我们可以fork官方的Repo,也可以自己创建,个人建议不fork,因为你只是想添加自己的的Pods,没有必要把现有的公开Pods都copy一份。所以创建一个Git仓库,这个仓库你可以创建私有的也可以创建公开的,不过既然私有的Spec Repo,还是创建私有的仓库吧,需要注意的就是如果项目中有其他同事共同开发的话,你还要给他这个Git仓库的权限。
创建完成后在终端中执行以下命令:

pod repo add [Private Repo Name] [GitHub HTTPS clone URL]

此时如果成功的话进入到~/.cocoapods/repos目录下就可以看到YourSpecs这个目录了。至此第一步创建私有Spec Repo完成。
PS:如果有其他合作人员共同使用这个私有 Spec Repo的话在他有对应Git仓库的权限的前提下执行相同的命令添加这个Spec Repo即可。

2.创建Pod项目工程文件

第二步没有什么好介绍的,如果是有现有的组件项目,并且在Git的版本管理下,那么这一步就算完成了,可以直接进行下一步了。
如果你的组件还在你冗余庞大的项目中,需要拆分出来或者需要自己从零开始创建一个组件库,那么我建议你使用Cocoapods提供的一个工具将第二步与第三步结合起来做。现在来说一下这个工具,相关的文档介绍可以查看这里,我们重新创建一个工程YourPodTestLibrary为例,来具体讲一下是如何操作的,
先cd到要创建项目的目录,我就cd到桌面,
然后执行命令: pod lib create YourPodTestLibrary
之后会出现几个问题:
1.你希望使用那种开发语言?
2.是否需要一个Demo工程?
3.需要使用哪种测试框架?
4.是否需要基于视图的测试?
5.你的类以什么为前缀?

选择以后,问完这几个问题它会自动执行pod install创建项目并生成依赖。创建完成后的工程和文件夹内容看上去应该像是这样的:
接下来就是向YourPodTestLibrary文件夹中添加库文件和资源,并配置podspec文件。我新建一个名为YourPodTestLibraryDemoFile继承自NSObject的类,包含.h和.m两个文件,放入到YourPodTestLibrary/Classes中,然后进入Example文件夹执行pod update命令,再打开项目工程可以看到,刚刚添加的YourPodTestLibraryDemoFile文件已经在Pods子工程下的Development Pods/YourPodTestLibrary中了。
查看无误后需要将该项目添加并推送到远端仓库,并编辑podspec文件。通过Cocoapods创建出来的目录本身就在本地的Git管理下,我们需要做的就是给它添加远端仓库,同样去GitHub或其他的Git服务提供商那里创建一个私有的仓库,拿到SSH地址,然后cd到YourPodTestLibrary目录执行以下命令:

git add .     #这里有个"."别漏了
git commit -s -m "Initial Commit of Library"
git remote add origin git@github.com:username/YourPodTestLibrary.git   #添加远端Git仓库SSH地址
git push origin master    #提交到远端仓库

这样项目就提交到GitHub上了。
因为podspec文件中获取Git版本控制的项目还需要tag号,所以我们要打上一个tag,再执行以下命令:

git tag -m "first release" 0.1.0
git push --tags    #推送tag到远端仓库
3.编辑podspec文件

上传完工程后就可以开始编辑podspec文件了,这里是YourPodTestLibrary.podspec文件,它是一个Ruby文件,用SubLime打开它,把编辑格式改成Ruby就能看到语法高亮了,原始的podspec文件已经有很多内容了,其中以#开头的都是被注释掉的部分,看起来应该像下图所示:

Pod::Spec.new do |s|
  s.name             = 'FCBaseLibary'
  s.version          = '0.0.5'
  s.summary          = 'FCBaseLibary.'
  # s.screenshots     = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2'
  s.description      = <<-DESC
TODO: Add long description of the pod here.
                       DESC
  s.homepage         = 'https://git.xxxx.com/'
  s.license          = { :type => 'MIT', :file => 'LICENSE' }
  s.author           = { 'dennis' => 'dennis@awesomedennis.com' }
  s.source           = { :git => "http://git.xxxx.com/ios/app/iOSRepo.git", :tag => "#{s.version}" ,:submodules => true}

  s.ios.deployment_target = '7.0'
  s.platform    = :ios, "7.0"
  # s.source_files = 'FCBaseLibary/Classes/**/*'
  # s.public_header_files = 'FCBaseLibary/Classes/**/*.h'
    s.subspec 'FCCache' do |fccache|
      fccache.source_files = "FCBaseLibary/Classes/FCCache/*.{h,m,mm,c}"
      fccache.public_header_files =  "FCBaseLibary/Classes/FCCache/*.h"
    end
end

下面是编辑完成后的podspec文件,每个配置项后面都添加上了注释:
编辑完podspec文件后,需要验证一下这个文件是否可用,如果有任何warning或者error都是不可以的,它就不能被添加到Spec Repo中。验证需要执行以下命令:
pod lib lint
当你看到
表示验证通过了,不过这只是说明这个podspec文件是合格的,不一定说明这个Pod是可用的,我们需要在本地做一下验证,这就是第四步要做的内容了。

4.本地测试podspec文件

我们可以创建一个新的项目,在这个项目的Podfile文件中直接指定刚才创建编辑好的podspec文件,查看是否可用。在Podfile中我们可以这样编写,有两种方式:

pod 'PodTestLibrary', :path => '/Users/username/Desktop/YourPodTestLibrary'     // 指定本地路径
pod 'PodTestLibrary', :podspec => '/Users/username/Desktop/YourPodTestLibrary/YourPodTestLibrary.podspec'    // 指定本地podspec文件路径

然后执行pod install命令安装依赖,打开项目工程,可以看到库文件都被加载到Pods子项目中了,不过它们并没有在Pods目录下,而是跟测试项目一样存在于Development Pods/PodTestLibrary中,这是因为我们是在本地测试,而没有把podspec文件添加到Spec Repo中的缘故。

5.向Spec Repo提交podspec

Spec Repo提交podspec需要完成两点,一个是podspec必须通过验证无误,再一个就是删掉无用的注释(这个不是必须的,为了规范还是删掉吧)。向我们的私有Spec Repo提交podspec文件只需要一个命令,先cdpodspec文件所在的目录,然后执行:

pod repo push YourSpecs YourPodTestLibrary.podspec  // 前面是本地Repo名字 后面是podspec文件的名字

当你看到终端显示这样的提示后,表示podspec文件上传成功了,同时这个组件库也就添加到我们的私有Spec Repo中了:
完成后可以进入到~/.cocoapods/repos目录中查看到我们私有的Spec Repo了,并且在YourSpecs这个私有Repo中已经有一个0.1.0版本的podspec文件了,如下图:

目录

再去看我们在GitHub上为我们私有的Spec Repo创建的远端仓库,已经有了一次提交,这个podspec文件也已经被push到仓库中了。

至此,我们的这个私有组件库就已经制作添加完成了,使用pod search命令就可以查到我们自己的库了:
这里说的是添加到私有的Repo,如果要添加到Cocoapods的官方库,可以使用trunk工具,具体可以查看官方文档

6.使用制作好的pod

在完成这一系列步骤之后,我们就可以在正式项目中使用这个私有的pod了,只需要在项目的podfile文件里增加以下两行代码即可:

source 'https://github.com/username/YourSpecs.git'    // 制定pod对应的pod spec文件所在的源,切记要在自己的私有库前制定source地址!!!
pod 'YourPodTestLibrary'

然后执行pod install命令安装库依赖,然后打开项目可以看到,我们自己的库文件已经出现在Pods子项目中的Pods目录下了,而不是在Development Pods

更新和维护自己的podspec

最后再来说一下制作好的podspec文件后续的更新和维护工作要如何进行,比如要如何添加新的版本,如何删除Pod等。我们之前已经制作好了YourPodTestLibrary0.1.0版本,现在我们对它进行升级工作,这次我添加了更多的模块到YourPodTestLibrary之中,包括工具类,底层ModelUIKit扩展等,这里又尝试了一下subspec功能,给YourPodTestLibrary创建了多个分支。
具体做法是先将源文件添加到YourPodTestLibrary/Classes中,然后按照不同的模块对文件目录进行整理,因为有四个模块,所以在YourPodTestLibrary/Classes下又创建了四个子目录,完成之后继续编辑之前的YourPodTestLibrary.podspec文件,这次增加了subspec属性,变更了podspec文件的版本号和私有库的tag,其它配置项不变。

Pod::Spec.new do |s|
  s.name             = 'FCBaseLibary'
  s.version          = '0.0.5'
  s.summary          = 'FCBaseLibary.'

  s.description      = <<-DESC
TODO: Add long description of the pod here.
                       DESC
  s.homepage         = 'https://git.xxxx.com/'
  s.license          = { :type => 'MIT', :file => 'LICENSE' }
  s.author           = { 'dennis' => 'dennis@awesomedennis.com' }
  s.source           = { :git => "http://git.xxxx.com/ios/app/iOSRepo.git", :tag => "#{s.version}" ,:submodules => true}

  s.ios.deployment_target = '7.0'
  s.platform    = :ios, "7.0"
  # s.source_files = 'FCBaseLibary/Classes/**/*'
  # s.public_header_files = 'FCBaseLibary/Classes/**/*.h'
    s.subspec 'FCCache' do |fccache|
      fccache.source_files = "FCBaseLibary/Classes/FCCache/*.{h,m,mm,c}"
      fccache.public_header_files =  "FCBaseLibary/Classes/FCCache/*.h"
    end
    s.subspec 'FCCategory' do |fccategory|
      fccategory.source_files = "FCBaseLibary/Classes/FCCategory/*.{h,m,mm,c}"
      fccategory.public_header_files = "FCBaseLibary/Classes/FCCategory/*.h"
      fccategory.dependency "FCBaseLibary/FCPublicMethods"
    end
    s.subspec 'FCImage' do |fcimage|
      fcimage.source_files = "FCBaseLibary/Classes/FCImage/*.{h,m,mm,c}"
      fcimage.public_header_files = "FCBaseLibary/Classes/FCImage/*.h"
    end
    s.subspec 'FCPublicMethods' do |fcpublicMethods|
      fcpublicMethods.source_files = "FCBaseLibary/Classes/FCPublicMethods/*.{h,m,mm,c}"
      fcpublicMethods.public_header_files = "FCBaseLibary/Classes/FCPublicMethods/*.h"
    end
    s.subspec 'FCThreeDES' do |fcthreeDES|
      fcthreeDES.source_files = "FCBaseLibary/Classes/FCThreeDES/*.{h,m,mm,c}"
      fcthreeDES.public_header_files = "FCBaseLibary/Classes/FCThreeDES/*.h"
    end
    s.subspec 'HPGrowingTextView' do |hpgrowingTextView|
      hpgrowingTextView.source_files = "FCBaseLibary/Classes/HPGrowingTextView/*.{h,m,mm,c}"
      hpgrowingTextView.public_header_files = "FCBaseLibary/Classes/HPGrowingTextView/*.h"
    end
    s.subspec 'PinyinSort' do |pinyinSort|
      pinyinSort.source_files = "FCBaseLibary/Classes/PinyinSort/*.{h,m,mm,c}"
      pinyinSort.public_header_files = "FCBaseLibary/Classes/PinyinSort/*.h"
    end

    s.frameworks = 'UIKit', 'Foundation', 'WebKit', 'CoreTelephony'
    s.requires_arc = true
    s.dependency 'SDWebImage', '3.7.5'
    s.dependency 'MBProgressHUD', '0.9.2'
end

因为我们创建了subspec所以项目整体的依赖,dependency,源文件source_file,头文件public_header_files,资源文件resouece等都移动到了各自的subspec中,每个subspec之间也可以有相互的依赖关系,比如FCCategory就依赖于FCPublicMethods
编辑完成之后,在测试项目里pod update一下,几个子项目都被加进项目工程了,查看无误就可以将新增的库文件push到远端仓库,并打上新的tag->1.0.0
最后再次使用pod lib lint验证新编辑好的podspec文件,没有自身的warning或者error之后,就可以再次提交到Spec Repo中了,命令跟之前的是一样的:
验证通过,上传成功之后,再次到~/.cocoapods/repos/YourPodTestLibrary/目录下查看,发现已经有0.1.0和1.0.0两个版本了:
使用pod search命令查看私有库的结果是:
完成这些之后,在实际项目中我们就可以选择使用整个组件库或者是组件库的某一个部分了,对应的podfile中添加的内容为:

最后介绍一下如何删除一个私有Spec Repo,只需要执行一条命令即可

pod repo remove [Private Repo Name]

这样这个Spec Repo就在本地删除了,我们还是可以通过

pod repo add [Private Repo Name] [GitHub HTTPS clone URL]

再把它加回来。
如果我们要删除私有的Spec Repo下的某个podspec要怎么操作呢?此时无需借助CocoaPods,只需要cd到对应的Spec Repo目录下,如:~/.cocoapods/repos/YourSpecs/目录,删除库目录:

rm -Rf YourPodTestLibrary

然后将git的变动push到远端仓库即可:

git add --all .     #这里有个"."别漏了
git ci -m "remove unuseful pods"
git push origin master

关于'pod lint'的补充说明

在开发的过程中,不可避免,我们会遇到一些警告(好多代码压根不是自己写的,实在无法维护 - -)的情况,出于代码洁癖,就是想lint 过一下。可以采用如下方式

pod lib lint --private --use-libraries --allow-warnings

在这里解释说明一下吧:

  • --private 代表私有
  • --use-libraries 解决因为引入其他framework造成的无法通过
  • --allow-warnings 允许警告
    其他,还是要看具体报错的信息了。use google stackoverflow.
  • 解决引入.pch

欢迎补充。😁

Objective-C 小技巧
Web note ad 1