CocoaPods|自定义Pod的发布和使用

Version

Time Version Description
2020-03-30 0.0.1 初版提交
image-20210330092354599.png

Preface

pod的原义是豆荚,cocoa原义是可可豆.所以CocoaPods的本义就是很多的可可豆的豆荚,也就是帮助我们管理可可豆豆荚的意思.

一个App可以看做是一份炒青豆,里面包含了很多的豆子,是将豆子有效管理起来,形成的一个艺术品.

所以,一个pod,就是一个豆子,一个组件,他实现的是一个基本的功能.更重要的是,具有复用性.我们创造出一个pod,就可以在其他app中随时使用,提高我们的效率,而不是在每个app中反反复复造一样的组件.

你能管理好的组件越多,你就能实现更多的功能,开发出更有用的app.

管理好自己的组件,是一个真正的码者必须掌握的技能,而对于iOS开发,帮助我们管理组件的工具,就是CocoaPods.

1 本文目标

二维码,QuickResponseCode,简称QrCode,是日常生活中不可分割的一部分.

本文将创建一个简单的二维码工具,旨在阐述如何发布自己的组件(Pod),并在项目中使用.

记录了3个Pod的发布过程,这三个pod,一个发布为公有Pod,一个发布为私有Pod,一个发布为开发Pod.

这三个pod为:

GaoQrCodeManager,将成为公有库Pod,用来实现图片和String的互相转换.

GaoStdListViewController,将成为私有库Pod,通用的列表展示页面,这样不用每次都写一样的列表页面.

GaoGeometryManager,将成为本地的测试Pod,笔者喜欢用代码进行布局,这个类是用来方便计算控件的frame的.

2 CocoaPods管理Pod的原理

1,组件.

即一个pod,实现了一个基本功能,代码可以复用.

比如,AFNetworking,SDWebImage,就是比较出名的组件.

2,组件源代码仓库.

组件的源代码需要发布到一个远程的仓库中,并且需要打好标记.

比如AFNetworking的组件源代码仓库,就是

https://github.com/AFNetworking/AFNetworking.git

3,项目App.

我们正在开发的App,需要引入一些组件来加快开发效率.

4,podspec文件.

是CocoaPods管理的核心文件.该文件记录了组件的组件源代码仓库,使用的文件有哪些,使用的资源有哪些.

将podspec文件,发布到公有仓库,则该pod成为公共仓库

将podsepc文件,发布到私有仓库,则该pod成为私有仓库

将podspec文件,仅仅保存到本地,成为开发pod

5,本地PodSpec仓库

6,远程Podspec仓库

7,podfile文件.

指定了当前项目App需要依赖哪些组件以及对应的版本.

8,项目依赖组件.

项目App中依赖的所有组件.

9,安装组件.

当我们首次安装组件,或者有组件新增或者删除时,我们使用命令pod install来让项目依赖的组件进行更新.

10,更新组件.

当项目依赖组件的仅仅是版本有变化时,我们使用命令pod update来更新项目的组件.

3 发布开发Pod

3.1 将组件源代码上传到github

a,本地准备组件源代码

b,在Github上新建存放组件源代码的仓库,勾选生成一个MIT文件.

c,将本地的源代码文件夹上传到远程仓库

# 初始化本地仓库
git init

# 提交本地文件到本地仓库
git add .
git commit . -m "first init"

# 关联本地和远程仓库
git remote add origin https://github.com/GikkiAres/GaoGeometryMaster.git
# 本地master分支,关联远程的main分支
git branch --set-upstream-to=origin/main master
# 将远程的ReadMe文件pull下来
git pull --allow-unrelated-histories
# 将本地的代码提交到远程
 git push -u origin master:main

d,打一个版本标签

我这里打的最初版本标签为0.0.1(0.0.0这样的标签验证不通过,本来想用的...)

git tag 0.0.1
git push origin 0.0.1

3.2 创建podspec文件.

在组件源代码目录中,创建podspec文件,但是这个文件并不需要提交到远程仓库中.

pod spec create GaoGeometryManager

3.3 编写podspec文件

编写的规则这里不展开讨论

3.4 验证podspec文件

验证pod文件是否ok

pod spec lint GaoGeometryManager.podspec --verbose

如果验证不通过,则修改源代码或者podspec文件直到通过验证.

3.5 项目中使用开发pod

在项目的podfile中引入开发pod:

target 'GaoQrCodeDemoAlpha' do
  # Comment the next line if you don't want to use dynamic frameworks
  use_frameworks!

  # Pods for Lib
   pod 'GaoGeometryManager', :path => '/Users/gikkiares/Desktop/MP_MyProject/MP06_MyLibProject/MP0601_iOS/29_ViewPosition/GaoGeometryManager/GaoGeometryManager_Master_Shared/GaoGeometryManager.podspec'

end

由于是开发Pod,需要指定本地podspec文件路径

安装组件

pod install
image-20210328113537325.png

可以看到,在Pods的DevelopmentPods中,已经加入了我们的库了.

4 发布私有Pod

前面的步骤和前面基本相同,只是在podspec文件处理的时候,需要上传到自己的一个私有仓库中去.

4.1 将组件源代码上传到github

a,本地准备组件源代码

b,在Github上新建存放组件源代码的仓库,勾选生成一个MIT文件.

c,将本地的源代码文件夹上传到远程仓库

# 初始化本地仓库
git init

# 提交本地文件到本地仓库
git add .
git commit . -m "first init"

git branch -M main

# 关联本地和远程仓库
git remote add origin https://github.com/GikkiAres/GaoStdListViewController.git
# 本地master分支,关联远程的main分支
git branch --set-upstream-to=origin/main master
# 将远程的ReadMe文件pull下来
git pull --allow-unrelated-histories
# 将本地的代码提交到远程
 git push -u origin master:main

d,打一个版本标签

我这里打的最初版本标签为0.0.1(0.0.0这样的标签验证不通过,本来想用的...)

git tag 0.0.1
git push origin 0.0.1

4.2 创建podspec文件.

在组件源代码目录中,创建podspec文件,但是这个文件并不需要提交到远程仓库中.

pod spec create GaoStdListViewController

4.3 编写podspec文件

编写的规则这里不展开讨论

4.4 验证podspec文件

验证pod文件是否ok

pod spec lint GaoStdListViewController.podspec --verbose

如果验证不通过,则修改源代码或者podspec文件直到通过验证.

4.5 建立pod私有仓库

就是要里创建一个自己仓库,用来存放podspec文件的.

直接在github建立一个仓库就可以了.

我这里直接建立一个远程仓库:

https://github.com/GikkiAres/GaoRepo

远程私有仓库克隆到本地:

pod repo add GaoRepo https://github.com/GikkiAres/GaoRepo

4.6 将podspec文件推送到pod私有仓库

所谓的私有,只是指podspec文件存放的仓库,其远端是自己的创建的仓库,而非cocoapod官方的仓库.

如果pod依赖了其他库,需要添加--user-libraries

pod repo push GaoRepo GaoStdListViewController.podspec  --allow-warnings --verbose --use-libraries

这一步就是将podsepc文件,从本地上传到了自己的pod私有仓库.

image-20210329102047762.png

可以看到,我的私有仓库中已经多了这个库.

另一方面,在私有仓库的本地端中,也同步了这个库:

image-20210329102427384.png

5 发布公有pod

发布公有pod的方法和发布私有的方法大致相同,只是最终podspec上传的仓库远端,是cocopod的官方仓库.

5.1 将组件源代码上传到github

a,本地准备组件源代码

b,在Github上新建存放组件源代码的仓库,勾选生成一个MIT文件.

c,将本地的源代码文件夹上传到远程仓库

# 初始化本地仓库
git init

# 提交本地文件到本地仓库
git add .
# git commit . -m "first init"有什么区别?
git commit -m "first init"

git branch -M main

# 关联本地和远程仓库
git remote add origin https://github.com/GikkiAres/GaoQrCodeManager.git
# 本地master分支,关联远程的main分支
git branch --set-upstream-to=origin/main main
# 将远程的ReadMe文件pull下来
git pull --allow-unrelated-histories
# 将本地的代码提交到远程
 git push -u origin 

d,打一个版本标签

我这里打的最初版本标签为0.0.1(0.0.0这样的标签验证不通过,本来想用的...)

git tag 0.0.1
git push origin 0.0.1

5.2 创建podspec文件.

在组件源代码目录中,创建podspec文件,但是这个文件并不需要提交到远程仓库中.

pod spec create GaoQrCodeManager

5.3 编写podspec文件

编写的规则这里不展开讨论

5.4 验证podspec文件

验证pod文件是否ok

pod spec lint GaoQrCodeManager.podspec --verbose

如果验证不通过,则修改源代码或者podspec文件直到通过验证.

5.5 将podspec文件推送到pod公有仓库

pod公有仓库地址是:

https://github.com/CocoaPods/Specs

我们使用以下命令提交到该仓库:

pod trunk push GaoQrCodeManager.podspec  --allow-warnings --verbose

上传成功的提示:

image-20210329110542566.png

上传成功后,下面会显示我们刚刚上传了一个pod.

image-20210329110851274.png

他会提示我们一个地址:

https://raw.githubusercontent.com/CocoaPods/Specs/303a02ee2d00c1699e8d029b1673b8df9cddd6d5/Specs/4/9/3/GaoQrCodeManager/0.0.1/GaoQrCodeManager.podspec.json

我们根据后面的'Specs/4/9/3'可以在对应的目录中找到我们的podspec文件.

image-20210329111032756.png

6 项目App安装组件

a,编写podfile文件

# 指定仓库地址
source 'https://cdn.cocoapods.org'
source 'https://github.com/GikkiAres/GaoRepo'


target 'GaoQrCodeDemoAlpha' do
  # Comment the next line if you don't want to use dynamic frameworks
  use_frameworks!

  # Pods for Lib
  # 开发Pod
  pod 'GaoGeometryManager', :path => '/Users/gikkiares/Desktop/MP_MyProject/MP06_MyLibProject/MP0601_iOS/29_ViewPosition/GaoGeometryManager/GaoGeometryManager_Master_Shared/GaoGeometryManager.podspec'
    # 私有Pod
    pod 'GaoStdListViewController'
    # 共用pod
    pod 'GaoQrCodeManager'
    
end

b,第一次安装,以及导入组件的有改动时,使用命令pod install来更新安装组件.

3,完成后,就可以使用了.

你可能感兴趣的:(CocoaPods|自定义Pod的发布和使用)