iOS组件化 - 制作pod上传自己的Github

2022-03-30 本文已影响0人 jade_xiaohui

一.前言

随着公司项目的不断迭代，业务的天马行空。工程的代码量和业务逻辑也越来越复杂，原始的开发模式和架构已经无法满足我们的业务发展速度，想分离出一个模块更是困难。直到组件化的诞生，这也是我们为什么要拥抱组件化的原因。
不得不说组件化带来的优点还有有目共睹的：
场景如：
- 聪明的产品张三有一天说：我们的IM业务日活、留存数据非常好，所以我们想单独拆出这个业务做个马甲包。
- 大厂～项目管理说我们的项目是否做业务之间隔离了没有。
- 随着业务不断增加，编译速度和打包速度越来越慢。
- 大厂～多个业务多人同时开发，等等。
哈哈！以上都是题外话，下面开始正文。

组件化分类：
共有库 - 所有人都能使用。（ $\color{red}{本文以共有库为例}$ ）。
私有库 - 公司内部拥有特殊权限才能使用。
framework - 公私都有，动态库静态库。只能看到.h文件。

二.步骤

准备工作：
Github账号一个（上传组件工程用的）
安装CocoaPods（创建并验证pod用的）
安装Git 命令行（首次上传组件工程用的）
安装Github Desktop或者SourceTree（后续更新组件用的，Git命令使用熟练者忽略此项）

1.创建共有库

首先在Github创建一个新的Repository。（你的Pods最终是要托管在Github平台上的，所以先在Github上创建一个空的Repository。）
$\color{red}{注意：“JHIMComponets”名字组成；JH = 项目前缀，Componets = 组件}$
如：JHIMComponets = IM组件化模块，这个看个人不强制。

repository.png
下图为创建成功后的样子

JHIMComponets.png

2.注册Cocoapods账户

想要创建一个开源pod库, 首先我们需要注册CocoaPods，基于Cocoapods已经安装好的前提下，这里是使用trunk 方式，只需要在终端执行:

pod trunk register 邮箱地址 '用户名' --verbose

如: pod trunk register xxxxxx@yeah.com 'JadeXH' --verbose

一般会使用GitHub邮箱和用户名，当然这个可以自由选择，注册之后，在邮箱中会收到确认邮件，在浏览器中点击链接确认即注册成功(小编遇到点击链接地址后显示：Internal server error 提示，不用理他直接验证)。成功之后可以终端执行:

pod trunk me    //验证是否注册成功

查看注册信息，以后可以使用该开源Pod库发布工具，也可以通过此方式查看已经发布过的pods:

yourname@Jade-for-MacBook-Pro podTest % pod trunk me
  - Name:     yourname
  - Email:    yourname@yeah.net
  - Since:    March 28th, 02:32
  - Pods:     None
  - Sessions:
    - March 28th, 02:32 - August 4th, 04:13. IP: 124.126.200.29

3.在本地创建pod库

利用pod命令创建了名为JHIMComponets的Pod库
$\color{red}{\normalsize{注意：这个名字要和你Github创建的Repository Name一致}}$

cd yourname@Jade-for-MacBook-Pro downloads % 
# cd到downloads目录下载，这个不强制请随意。
yourname@Jade-for-MacBook-Pro downloads % pod lib create JHIMComponets
# 执行 pod lib create JHIMComponets

执行完上述命令之后，会问你几个问题，按需求填写即可

pod create.png

# 你想使用哪个平台？
1、What platform do you want to use?? [ iOS / macOS ]
iOS
# 库语言选择？
2、What language do you want to use?? [ Swift / ObjC ]
ObjC
# 是否需要一个demo工程，用于调试Pod？
3、Would you like include a demo application with your library? [ Yes / No ]
Yes
# 你要使用哪个测试框架？
4、Which testing frameworks will you use? [ Specta / Kiwi / None ]
None
# 是否要UI测试？
5、Would you like to do view based testing? [ Yes / No ]
NO
# 类名前缀？
6、What is your class prefix?
JH

到这里pod库就创建完成了，它会自己打开刚才创建的pod库。
目录结构如下图：

pod.png
（1）配置podspec
配置详解：

Pod::Spec.new do |s| 
  #库名称
  s.name             = 'JHIMComponets'
  #版本号
  s.version          = '0.1.0'
  #库简短介绍
  s.summary          = 'A short description of JHIMComponets.'
  #开源库描述 
  s.description      = <<-DESC
TODO: Add long description of the pod here.
                       DESC
  #开源库地址，或者是博客、社交地址等
  s.homepage         = 'https://github.com/JadeXH/JHIMComponets'
  # s.screenshots     = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2'
  #开源协议
  s.license          = { :type => 'MIT', :file => 'LICENSE' }
  #开源库作者
  s.author           = { 'yourname' => 'yourname@yeah.net' }
  #源库资源文件
  s.source           = { :git => 'https://github.com/JadeXH/JHIMComponets.git', :tag => s.version.to_s }
  #社交网址
  # s.social_media_url = 'https://twitter.com/<TWITTER_USERNAME>'
  #开源库最低支持
  s.ios.deployment_target = '9.0'
  #源库资源文件
  s.source_files = 'JHIMComponets/Classes/**/*'
  #添加资源文件
  # s.resource_bundles = {
  #   'JHIMComponets' => ['JHIMComponets/Assets/*.png']
  # }

  # s.public_header_files = 'Pod/Classes/**/*.h'
  #依赖的系统库 多个用逗号隔开
  # s.frameworks = 'UIKit', 'MapKit'
  #引入第三方依赖库
  # s.dependency 'AFNetworking', '~> 2.3'
end

需要注意如图：

podspec.png
Readme主要是介绍这个组件的用途和使用的，可以随时编辑。目前就确认一下自己的名字和邮箱就可以了。

readme.png
协议文件，也是确认一下自己的名字和邮箱就可以了。

licence.png
（2）添加自己的类
打开pod库目录：

new.png
删除ReplaceMe -> 创建JHIMComponet简单类，声明一个打印函数，方便后续测试。
$\color{red}{注意：创建类文件一定要放到class目录下}$


#import "JHIMComponet.h"

@implementation JHIMComponet

- (void)printJHIMComponet {
    NSLog(@"printJHIMComponet*****");
}

@end

这时cd进入Example路径下执行pod install命令，看看是否能将刚刚添加的库文件引入到工程中

yourname@Jade-for-MacBook-Pro downloads % cd /Users/yourname/Downloads/JHIMComponets/Example
yourname@Jade-for-MacBook-Pro Example % pod install

pods.png

如果成功会在项目组Pods中看到。

4.项目上传与发布

cd到你的项目路径下，将项目上传到Github中（即刚刚创建的JHIMComponets共有库中）依次使用下列命令行，不要遗漏。

//
yourname@Jade-for-MacBook-Pro Example % cd /Users/yourname/Downloads/JHIMComponets

# 添加github项目路径
yourname@Jade-for-MacBook-Pro JHIMComponets % git remote add origin https://github.com/JadeXH/JHIMComponets.git
# 添加文件
yourname@Jade-for-MacBook-Pro JHIMComponets % git add .
# 将暂存区里的改动给提交到本地的版本库
yourname@Jade-for-MacBook-Pro JHIMComponets % git commit -m "first commit"
# 创建分支main
yourname@Jade-for-MacBook-Pro JHIMComponets % git branch -M main
# 提交版本号并push到main分支
yourname@Jade-for-MacBook-Pro JHIMComponets % git push -u origin main

#注意这里的版本号要与.podspec中的版本号保持一致
yourname@Jade-for-MacBook-Pro JHIMComponets % git tag 0.1.0
yourname@Jade-for-MacBook-Pro JHIMComponets % git push origin 0.1.0

在执行git push -u origin main的时候如果遇到需要输入用户名和密码：

Username for 'https://github.com': JadeXH
Password for 'https://JadeXH@github.com':

$\color{red}{\normalsize{需要注意的是：}}$ 这个密码不是你Github的登录密码，而是需要生成一个access tokens。

生成token步骤：需要在Github个人设置页 -> Settings -> Developer settings -> Personal access tokens 中创建一个token。

settings.png

1.设置token的有效期，访问权限等
2.选择要授予此令牌token的范围或权限。
3.要使用token从命令行访问仓库，请选择repo。
4.要使用token从命令行删除仓库，请选择delete_repo
5.其他根据需要进行勾选

token.png
delete.png
点击Generate token生成的token（ghp_zR7Zm44QK*************Ui7zikChgv2bxMNZ）。

注意：
记得把你的token保存下来，因为你再次刷新网页的时候，你已经没有办法看到它了。然后把这个token直接粘贴到命令行提示输入密码处就ok了。

执行完所有git命令行后打开浏览器输入https://github.com/JadeXH/JHIMComponets就看到你的pod库已经push上去了。

update.png

5.使用与验证

新建个带pod的项目，把我们做好的JHIMComponets加入podfile文件。

# Uncomment the next line to define a global platform for your project
 platform :ios, '9.0'

target 'podTest' do
  # Uncomment the next line if you're using Swift or would like to use dynamic frameworks
  # use_frameworks!

  # Pods for podTest
  pod 'JHIMComponets',:git =>"https://github.com/JadeXH/JHIMComponets.git"
  
  
  target 'podTestTests' do
    inherit! :search_paths
    # Pods for testing
  end

  target 'podTestUITests' do
    inherit! :search_paths
    # Pods for testing
  end
end

执行pod install

yourname@Jade-for-MacBook-Pro podTest % pod install
Analyzing dependencies
Pre-downloading: `JHIMComponets` from `https://github.com/JadeXH/JHIMComponets.git`
Downloading dependencies
Installing JHIMComponets (0.1.0)
Removing JHComponents
Generating Pods project
Integrating client project
Pod installation complete! There are 9 dependencies from the Podfile and 9 total pods installed.