对于iOS开发者来说,Cocoapods无疑是一个非常好用的三方库管理工具,在开发过程中,我们也会使用到许多优秀的三方库。有时候我们也需要将自己的东西封装起来并重复利用,但是又不想像Cocoapods上一样让别人用,这时我们就需要建立自己的私有库。
想要上传自己的私有库,需要先弄懂Cocoapods的原理及目录结构。Cocoapods一共分为两块,即Cocoapods和Specs,Specs实际上是一个目录容器,所有的三方库的podspec文件都在里面,那么podspec文件又是什么呢,podspec文件就相当于每一个三方库的介绍文件,包含名字、版本、以及三方库的下载地址等,步骤三会详细介绍。
使用过cocoa pods的同学在本地都会有一个.cocoapods/repos文件夹,这个文件夹就是在使用cocoa pods时自动从Specs上clone到本地的,即路径~/.cocoapod/repos,进入本地看看目录结构:
repos->master->Specs->[Name]->[Version]->[Name].podspec
没错,这个是公有的三方库的目录,我们做私有库,就是要模仿公有库的结构目录,建立一个自己的Spec的私有仓库来维护,这个仓库可以是私有也可以是公开。总的来说,我们需要维护的东西有两个,一个是私有的Specs目录,一个是我们需要上传的三方库。
一、创建私有的Specs目录
在远端建一个仓库,命名为MySpecs,把仓库clone到本地,把公有Specs里面的CocoaPods-version.yml文件拷贝到里面,并建立一个名为“Specs”的文件夹,(文件夹里面可以放一个无关的小文件,要是是空文件夹推到远端可能会被忽略),然后把东西推动远端仓库,私有Specs创建完成。如图:
二、将远端的私有Specs仓库clone到本地.cocoapods目录下
$ pod repo add MySpecs https://[email protected]/xxxx/Myspecs.git
在终端执行上述命令,记得将仓库地址改正。执行成功的话,在本地~/.cocoapods/repos路径下就能发现,多了一个MySpec的文件夹。
三、创建pod spec文件
我必须说这一步尤为重要
我必须说这一步尤为重要
我必须说这一步尤为重要
重要的事情说三遍。
准备工作:1、将需要作为三方库的所有文件整理在工程的一个文件夹下(为后续方便),并上传至远端。
2、打开终端cd 到本地工程下。
执行命令:
$ pod spec create [Name] https://[email protected]/xxxx/xxxx.git
注:其中Name是三方库的名字,地址是作为三方库的工程的远端地址。
完成后在当前目录下回生成一个叫做[Name].podspec的文件。打开这个文件(建议用sublime打开,sublime很好用,另外sublime的负责人看到了记得打赏广告费,谢谢!)里面注释相当详细,我这里列举几个重要的:
s.name = "xxxx" #三方库名字
s.version = "0.0.1" #版本号,建议从0.0.1开始(官方的版本号是不能删除和向下修改的,只能递增,但私有库是我们自己维护的,所以可以随意修改)
s.summary = "xxxxxxxx" #三方库总结
s.description = "xxxxxxx" #三方库描述
s.homepage = "https://xxxxxxx" #主页信息(填写项目仓库的地址即可)
s.license = "MIT" #开源协议,一般填MIT(注:.podspec
文件同目录下必须要有一个MIT开源协议文件,如果没有,去github上别人的目录下随便拷贝一个)
s.author = { "xxxxxx" => "[email protected]" }#作者姓名、邮箱,不用我说了吧
s.platform = :ios, "7.0" #支持的系统版本
s.source = { :git => "https://[email protected]/xxx/xxx.git", :tag => "0.0.1" }#资源地址,很重要,pod install的时候根据这个地址去下载三方库,另外为避免麻烦,版本号必须与s.version中的版本号一致。
s.source_files = ""#这个很重要,指定资源文件,前缀就是.podspec文件当前路径,只用写之后的路径,如Class/*是指Class文件夹下的所有文件,但不包括子文件夹里面的文件、Class/**/*是指包含所有Class文件夹下的文件,包括子文件、Class/**/*.{h,m}是指包含所有Class文件夹下的后缀为.h或.m的文件,当然也可以指定文件。
s.requires_arc = true#是否支持arc
#######以下的为可选
#s.resource = "icon.png"#资源文件,包括图片和xib文件
# s.dependency "JSONKit", "~> 1.4"#需要依赖的三方库
#s.framework = "SomeFramework"#需要依赖的框架
#s.public_header_files = ''#公开的头文件,如果不没公开,用户在用的时候可能引不到响应的头文件
s.subspec 'subFolder' do |ss|
ss.source_files = 'Class/xxx/**/*.{h,m}'
ss.public_header_files = "Class/xxx/**/*.{h}"
end#这个是子依赖库,因为如果我们只是用s.source_files来指定文件,那么用户在pod下来之后所有的文件都在同一个目录下,没有子文件夹,如果想要分下类,用s.subspec,每一个subspec可以分一个子文件夹,但是记得一定要将.h文件通过ss.public_header_files公开,不然有可能会找不到头文件。
差不多这些重要的,可以根据库的复杂度酌情修改,然后保存。
如有不明白的可以和我讨论,或者去参考其他的如:AFNetworking等的podspec文件。
四、验证
打开终端,cd到.podspec文件的目录下,使用命令:
$ pod lib lint
如果有错,按照错误修改podspec文件,如果通过,那么恭喜你完成一大部分了。
当然为了验证你的文件路径指定对不对,我们可以做一个测试,找一个新工程,在Podfile文件中加入
pod '[Name]', :podspec => '/Users/xxxx/Desktop/xxx/xxx.podspec'
注:[Name]为pod spec中的s.name,必须一致,后面的路径为本地pod spec文件的路径。
然后打开终端cd到当前Podfile目录下执行
pod install
或
pod install --no-repo-update
第二条命令是不更新官方Specs至本地,速度要比第一条快。
执行完成之后,打开工程看看Pods下的三方库的结构是不是跟你想象的一样,并可以测试能不能用。
五、向Specs远端提交.podspec文件
通过验证后,给当前代码打上tag,建议tag和版本号一致,并推送到远端(官方的tag是不能向下修改的)
$ git tag '0.0.1
$ git push origin --tags
将tag推送到远端之后,向自己的私有库提交podsepc文件:
$ pod repo push MySpecs [Name].podspec
如果提交成功,这时候去到~/.cocoapods/repo/MySpecs文件夹下就发现多了一个文件夹,正是你刚刚创建的三方库。
到这里,恭喜你的私有库创建完成。
六、使用
不出意外,这个时候,你去终端pod search 你的三方库名字,就能搜到(如果你的名字和官方Specs里面的某个三方库名字一样的话将会搜不到),使用的时候在Podfile中加入两个Specs源即:
官方源:
source 'https://github.com/CocoaPods/Specs.git'
私有源:
source 'https://[email protected]/xxxxx/Myspecs.git'#即你的私有源仓库地址
当然,你也可以指定地址
pod 'xxxx', :git =>'https://[email protected]/xxxx/xxxx.git'
这里的地址是你的三方库的远端地址。二选一都行,为了避免冲突,建议用第二种。
把自己踩过的坑记录下来,希望对正在研究的同学有帮助。