一、背景
首先了解下使用需求。公司有多个项目同时进行,期望可以共用一个工具库。而该工具库代码可能涉及到公司内部信息,不便公开,需要部署在内部服务器上。也就是私有库的管理。
大家都知道CocoaPods
管理第三方库十分方便,所以我们希望私有库的使用也可以借助CocoaPods
管理。
二、准备私有库平台
首先,我们需要一个管理私有库代码的平台,我们公司暂时使用的是GitLab
,先了解下概念。
Git
:版本控制系统。
Github
:在线的基于 Git 的代码托管服务,同时提供付费账户和免费账户。这两种账户都可以创建公开的代码仓库,只有付费账户可以创建私有的代码仓库。
Gitlab
解决了这个问题, 可以在上面创建免费的私人repo
。
如何搭建本地服务器Gitlab
仓库管理,大家自己去看吧。
三、创建一个Git远程仓库
我们私有库包含多个工具类的代码库,每个工具库代码使用
CocoaPods
打包后会生成一个.podspec
文件,来描述该工具库的具体信息,包括代码地址。而所有的库的.podspec
文件要有一个Spec Repo
私有仓库去管理。
多个.podspec
文件也称specs
,作为我们查找库时候的一个索引,为什么我们执行pod search AFNetworking
命令时,返回结果如此之快。因为安装CocoaPods
的时候,本地目录就已经有了一份master
(公开)的specs
,全球程序员们提交到CocoaPods
的开源代码在这都有记录。
我们可以通过执行命令查看一下目录结构,结果一目了然。命令如下:
open ~/.cocoapods/repos/master
我们创建的私有specs
仓库地址为http://私有库地址/EHILibraryiOS/EHILibrarySpecs.git
。下面执行命令把Spec
创建到本地。命令如下:
pod repo add EHILibrarySpecs http://私有库地址/EHILibraryiOS/EHILibrarySpecs.git
这时候EHILibrarySpecs
就在本地目录下创建成功了,通过命令查看EHILibrarySpecs
的目录结构,会发现里面的内容和git
仓库上的保持一致。EHILibrarySpecs
和master
在目录中同级。
open ~/.cocoapods/repos/EHILibrarySpecs
四、创建Pod代码库
有了仓库,我们就可以添加代码库啦。
4.1 使用pod
创建库:
pod lib create EHIHiCarBluetooth
过程中终端会向我们提出一系列问题,大家自行选择即可。
4.2 添加文件,写好Demo
如图,添加文件:
工程目录如下:
在Example
中写好Demo
,保证编译运行ok。
4.3 编辑*.podspec
务必保证填写的每一项都要是正确的,比如主页和链接都要能够访问。
编辑EHIHiCarBluetooth.podspec
文件如下:
#
# Be sure to run `pod lib lint EHIHiCarBluetooth.podspec' to ensure this is a
# valid spec before submitting.
#
# Any lines starting with a # are optional, but their use is encouraged
# To learn more about a Podspec see https://guides.cocoapods.org/syntax/podspec.html
#
Pod::Spec.new do |s|
s.name = 'EHIHiCarBluetooth'
s.version = '0.1.0'
s.summary = '一句话描述'
# This description is used to generate tags and improve search results.
# * Think: What does it do? Why did you write it? What is the focus?
# * Try to keep it short, snappy and to the point.
# * Write the description between the DESC delimiters below.
# * Finally, don't worry about the indent, CocoaPods strips it!
s.description = <<-DESC
TODO: Add long description of the pod here.
DESC
s.homepage = 'http://私有库地址/EHILibraryiOS/EHIHiCarBluetooth'
# s.screenshots = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2'
s.license = { :type => 'MIT', :file => 'LICENSE' }
s.author = { '用户名' => '邮箱地址' }
s.source = { :git => 'http://私有库地址/EHILibraryiOS/EHIHiCarBluetooth.git', :tag => s.version.to_s }
# s.social_media_url = 'https://twitter.com/<TWITTER_USERNAME>'
s.ios.deployment_target = '8.0'
s.source_files = 'EHIHiCarBluetooth/Classes/*'
# s.resource_bundles = {
# 'EHIHiCarBluetooth' => ['EHIHiCarBluetooth/Assets/*.png']
# }
# s.public_header_files = 'Pod/Classes/**/*.h'
# s.frameworks = 'UIKit', 'MapKit'
s.dependency 'YYKit'
s.dependency 'BabyBluetooth', '~> 0.7.0'
end
4.4 验证*.podspec
验证本地库是否通过验证,终端输入如下命令:
pod lib lint --use-libraries --allow-warnings
--use-libraries
表示使用了第三方,--allow-warnings
表示忽略警告。
如果使用了私有库,命令如下(我的这个没有用到):
pod lib lint --sources=http://私有库地址/EHILibraryiOS/EHIHiCarBluetooth.git,https://github.com/CocoaPods/Specs.git --use-libraries --allow-warnings
4.5 提交代码
git add .
git commit -m 'create EHIHiCarBluetooth 0.1.0'
如果你还未创建远程仓库,你需要创建与之对应的远程仓库:
创建之后与本地仓库关联并推送,在终端执行如下命令:
git push --set-upstream http://私有库地址/EHILibraryiOS/EHIHiCarBluetooth.git master
提交完成之后进行打标签操作(这就作为该库的版本,版本号和上面.podspec
文件配置中保持一致):
git tag -a 0.1.0 -m 'release version 0.1.0'
git push http://私有库地址/EHILibraryiOS/EHIHiCarBluetooth.git 0.1.0
4.6 推送*.podspec
到远程
4.6.1 推送到私有库
首先将本地EHIHiCarBluetooth.podspec
推送到远程私有EHILibrarySpecs
仓库:
pod repo push EHILibrarySpecs EHIHiCarBluetooth.podspec --use-libraries --allow-warnings
--force
一般用不着,需要强制推送的话可以在后面加上。
4.6.2 推送到公有库
顺便记录下公有库的上传吧。公有库的上传前面操作一样的,保证在Github
上已经创建了库,.podspec
里的地址和Github
上对应,打好Tag
并上传验证等。然后推送如下:
先使用邮箱注册命令:
pod trunk register 邮箱 '用户名'
命令成功后,会提示去邮箱验证。登录邮箱,打开邮箱里的链接进行验证。
回到终端,输入以下命令(如果提示验证过期,重新操作上一步骤):
pod trunk me
命令后终端界面如下即可:
上传.podspec
到CocoaPods/repo
(注意在.podspec文件上级目录下操作):
pod trunk push xxx.podspec
4.7 验证远程是否通过
pod spec lint EHIHiCarBluetooth.podspec --allow-warnings --use-libraries
4.8 pod搜索
pod search EHIHiCarBluetooth
如果远程验证通过,但是搜索不到,是因为没有添加进pod search
缓存文件,删掉缓存重建即可!命令如下:
# 切换到CocoaPods目录
cd ~/Library/Caches/CocoaPods/
# 查看该目录下有Pods和search_index.json两个文件
ls
# 删除缓存文件
rm search_index.json
# 重新搜索
pod search EHIHiCarBluetooth
五、使用
Podfile
文件如下:
# CocoaPods官方spec仓库
source 'https://github.com/CocoaPods/Specs.git'
# 私有spec仓库
source 'http://私有库地址/EHILibraryiOS/EHILibrarySpecs.git'
platform :ios, '8.0'
target 'TextPodBluetooth' do
# 私有库
pod 'EHIHiCarBluetooth','~> 0.1.0'
end