1.前言
我们的项目里或多或少都使用了别人提供的三方库,它们可能托管在github、bitbucket、coding上。以github为例,它托管了海量的三方库代码。在github上创建一个空的repository,它会指导你如何上传你的代码。这也是我们经常做的。
本文将简要介绍一下我个人使用cocoapods制作私有源的过程和遇到的一些问题。
1.Cocoapods如何管理它的三方库
Cocoapods是通过Spec Repo下的索引找到对应的代码。什么是Spec Repo?这是一个容器,所有的Pods都在这个里面。其实,它也是一个git仓库。安装好Cocoapods后,我们可以在如下目录中可以找到它。
~/.cocoapods/repos/master/Specs
不同的开发者将他们的代码上传到github上时,需要编写一个.podspec文件,让“Cocoapods可以通过索引找到这些代码,以及一些必要的信息,如版本号、依赖、资源等”。
我们可以不必写.podspec文件去引用别人的代码,Podfile中可以这么写:
pod 'XXXHelper', :git => '[git地址]'
这么写存在一个问题,它会去拉去该仓库master分支下最新的代码。对于一些存在版本控制功能的代码,这样显然是不满足需求的。而且,这与我们常见的写法相比,更繁琐。
pod 'XXXHelper', '~> 1.0.0'
2.编写podspec
podspec是cocoapods提供的一种文件格式,用来描述pod的信息。它有自己的一套语法,其中也包含了很多的坑~~~。我们可以用以下命令创建一个官方的podspec。
pod lib create [PodName]
但是这样会在目录下生成比较多文件(看着很难受),我常用的方式是去github上找一个比较权威的pod,把它的podspec拷贝一份,在这个基础上修改。podspec的语法不难,一些基本的配置非常容易理解,比如:name、version、summary、license等。有几个比较难理解的我简要说明一下:
//当别人引用你的pod时,将会提供source_files目录下的文件
s.source_files = 'XXXHelper/**/*.{h.m}'
//提供给别人的资源文件
s.resources = {XXX.bundle}
//项目依赖的frameworks,多个用逗号隔开
s.framework = 'XXX.frameworks'
//项目依赖的其他三方pod
s.dependency = 'XXX', '~> 1.0.0'
//项目需要用到的库
s.libraries = 'sqlite3'
还有一些复杂的内容一般用不到,个人也不建议使用(这方面的有用资源比较有限,一些复杂的语法出了问题不好找解决办法)。
3.验证podspec是否合格
校验的方法分2步,本地校验和远程校验,分别是:
pod lib lint [podspecName]
pod spec lint [podspecName]
验证过程中经常会遇到各种各样的问题,以下是部分解决办法
1.去除警告: 在结尾增加 --allow-warnings
2.依赖库包含了.a静态库: 在结尾增加 --use-libraries
4.上传到私有源
开源的项目可以上传github,它提供了免费的公有仓库,上传成功后可以直接在Cocoapods公有仓库的索引中找到,即
pod search XXXHelper
如果我们的代码只是在内部使用,就需要建立一个私有仓库存放了。首先创建一个远程的repository。然后在终端中输入:
pod repo add [Private Repo Name] [Repo address]
这样在~/.cocoapods/repos/目录下就多了一个名为[Private Repo Name]的私有源,后续我们可以把我们的podspec都上传到这个私有源。
补充说明一下:
我们都写过Podfile,里面会写很多我们依赖的pod库。Cocoapods是如何找到这些pod的?
Cocoapods通过公有源找到我们依赖的pod。如果Podfile中没有指定源地址,Cocoapods默认会去它自己的公有源中找pod:
source 'source 'https://github.com/CocoaPods/Specs.git''
这是一个公有源的远程端,对应我们本地~/.cocoapods/repos/master的本地端(其实就是一个git仓库)。他里面其实只存放了每个pod的podspec文件,podspec中明确的指出了每个pod的信息。最后Cocoapods就是根据podspec提供的信息找到对应的pod仓库,并拉去我们的代码。
同理,如果我们使用了私有源,我们需要在Podfile中明确指出,即在开始写:
source '[Private Pod Address]'
回到之前的上传podspec的话题上来。如果你通过了podspec的校验,最后只需要
pod repo push origin [Private Pod Address] [podspecName]
每一次更新podspec的时候,记得为你的代码打好tag。版本控制是非常重要的一件事情~