OC组件化01：制作pod上传自己的Github

背景

  • 随着公司业务的不断发展，应用的代码体积将会越来越大，业务代码耦合也越来越多，代码量也是急剧增加
  • 如果仅仅完成代码拆分还不足以解决业务之间的代码耦合，而组件化是一种能够解决代码耦合、业务工程能够独立运行的技术
  • 这篇文章主要介绍远程私有库的创建和管理以及本地索引库的使用

本文以创建 公有库 为例

查看本地索引库

  • 我们用 cocoaPods 的时候，默认使用的是cocoaPods自带的索引库
    终端中使用命令 $ pod repo 
cocoapods
- Type: git (remotes/origin/master)
- URL:  https://github.com/CocoaPods/Specs.git
- Path: /Users/mac/.cocoapods/repos/cocoapods

trunk
- Type: CDN
- URL:  https://cdn.cocoapods.org/
- Path: /Users/mac/.cocoapods/repos/trunk

2 repos

组件化分类

  • 公有库：所有人都能使用

  • 私有库：公司内部拥有特殊权限才能使用

  • framework：公私都有，动态库静态库。只能看到.h文件。

准备工作

  • GitHub 账号一个：上传组件工程用

  • 安装 CocoaPods：创建并验证 pod 用

  • 安装 Git 命令行 ：首次上传组件工程用

  • 安装 Github Desktop 或者 SourceTree：后续更新组件用的，Git命令使用熟练者忽略此项

创建公有库

  • 首先在 Github 创建一个新的 Repository，你的 pods 最终要托管在 Github 平台上的，所以在 Github 上创建一个空的 Repository

注意：库名 = 项目前缀 + 组件名称 ，如 ZJWeakProxy = 解决循环引用组件库

image.png
  • 创建完成后的信息如下：
image.png

注册 cocoapods 账户

  • 先安装 cocoapods，这个很简单，可以百度搜索自行安装

  • 想要创建一个开源 pod 库，首先我们需要注册 cocoapods账户，基于 cocoapods 已经安装好的前提下，这里直接使用 trunk 去注册 cocopods账户，在终端执行：

pod trunk register 邮箱地址 '用户名' --verbose
mac@bogon ~ % pod trunk register 13718004742@163.com 'BboyZJ' --verbose

邮箱地址：一般会使用 GitHub邮箱
用户名：随便

  • 注册之后，在邮箱会受到确认邮件
image.png
  • 注册成功之后可以在终端 验证是否注册成功：
// 验证是否注册成功
mac@bogon ~ % pod trunk me
  • 查看注册信息，以后可以使用该开源pod库发布工具，也可以通过此方式查看已经发布过的pods：
mac@bogon ~ % pod trunk me
  - Name:     BboyZJ
  - Email:    13718004742@163.com
  - Since:    October 20th, 2021 19:20
  - Pods:
    - ZJSDKDemo
    - ZJSDK_iOS
  - Sessions:
    - October 20th, 2021 19:20 - March 31st, 2022 04:01. IP: 114.253.15.66 
    Description: iMac
    - February 27th, 02:33     -        July 5th, 02:37. IP:
    114.252.233.188

在本地创建pod库

  • 利用pod命令创建名为 ZJWeakProxy 的 pod 库

注：这个名字要和 GitHub 创建的 Repository 名一致

# cd 到桌面文件夹(组件文件夹)ZJComponent目录下，这个不强制随意
mac@bogon ~ % cd ZJComponent 
# 执行 pod lib create ZJWeakProxy
mac@bogon ~ % pod lib create ZJWeakProxy

原因分析：一般这是因为服务器的 SSL 证书没有经过第三方机构的签署，所以才报错

解决办法：接触 SSL 验证，再次执行

mac@bogon ZJComponent % git config --global http.sslVerify false
  • 执行完上述命令后，会问你几个问题，按需求填写即可
# 你想使用哪个平台？
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?
ZJ
  • 到这里 pod 库就创建完成了，它会自己打开刚才创建的pod库

工程目录介绍

  • 目录结构如下：
image.png

【第1部分】：主要是用来编辑pod相关配置元数据区
【第2部分】：主要是用来验证pod效果区
【第3部分】：主要是用来 提供给别人使用暴露出来的pod，ReplaceMe空的可以删除，是提示我们可以添加自己的类

  • 配置 podspec 

Pod::Spec.new do |s|
  # 库名称
  s.name             = 'ZJWeakProxy'
  # 版本号
  s.version          = '0.1.0'
  # 库简短介绍
  s.summary          = 'A short description of ZJWeakProxy.'

# 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         = 'https://github.com/BboyZJ/ZJWeakProxy'
  # s.screenshots     = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2'
  # 开源协议
  s.license          = { :type => 'MIT', :file => 'LICENSE' }
  # 开源库作者
  s.author           = { 'BboyZJ' => '13718004742@163.com' }
  # 开源库资源文件
  s.source           = { :git => 'https://github.com/BBoyZJ/ZJWeakProxy.git', :tag => s.version.to_s }
  # 社交网址
  # s.social_media_url = 'https://twitter.com/<TWITTER_USERNAME>'
  # 开源库最低支持
  s.ios.deployment_target = '10.0'
  # 开源库源文件
  s.source_files = 'ZJWeakProxy/Classes/**/*'
  # 添加资源文件
  # s.resource_bundles = {
  #   'ZJWeakProxy' => ['ZJWeakProxy/Assets/*.png']
  # }
  
  # s.public_header_files = 'Pod/Classes/**/*.h'
  # 依赖系统库 多个用逗号隔开
  # s.frameworks = 'UIKit', 'MapKit'
  # 引入第三方依赖库
  # s.dependency 'AFNetworking', '~> 2.3'
end
  • 需要注意如图：
image.png
  • Readme 主要是介绍这个组件的用途和使用，可以随时编辑。目前就确认一下自己的名字和邮箱就可以了
image.png

【第1部分】：主要是用来编辑pod相关配置元数据区
【第2部分】：主要是用来验证pod效果区
【第3部分】：主要是用来 提供给别人使用暴露出来的pod，ReplaceMe空的可以删除，是提示我们可以添加自己的类

  • 配置 podspec

Pod::Spec.new do |s|
  # 库名称
  s.name             = 'ZJWeakProxy'
  # 版本号
  s.version          = '0.1.0'
  # 库简短介绍
  s.summary          = 'A short description of ZJWeakProxy.'

# 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         = 'https://github.com/BboyZJ/ZJWeakProxy'
  # s.screenshots     = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2'
  # 开源协议
  s.license          = { :type => 'MIT', :file => 'LICENSE' }
  # 开源库作者
  s.author           = { 'BboyZJ' => '13718004742@163.com' }
  # 开源库资源文件
  s.source           = { :git => 'https://github.com/BBoyZJ/ZJWeakProxy.git', :tag => s.version.to_s }
  # 社交网址
  # s.social_media_url = 'https://twitter.com/<TWITTER_USERNAME>'
  # 开源库最低支持
  s.ios.deployment_target = '10.0'
  # 开源库源文件
  s.source_files = 'ZJWeakProxy/Classes/**/*'
  # 添加资源文件
  # s.resource_bundles = {
  #   'ZJWeakProxy' => ['ZJWeakProxy/Assets/*.png']
  # }
  
  # s.public_header_files = 'Pod/Classes/**/*.h'
  # 依赖系统库 多个用逗号隔开
  # s.frameworks = 'UIKit', 'MapKit'
  # 引入第三方依赖库
  # s.dependency 'AFNetworking', '~> 2.3'
end
  • 需要注意如图：
image.png
  • Readme 主要是介绍这个组件的用途和使用，可以随时编辑。目前就确认一下自己的名字和邮箱就可以了
image.png
  • 协议文件，也是确认一下自己的名字和邮箱就可以了
image.png

添加自己的类

  • 打开pod库目录，删除ReplaceMe
  • 创建 ZJWeakProxy 简单类，声明一个打印函数，方便后续测试

注：创建类文件一定要放到 Classes 目录下

.h 文件下

#import "ZJWeakProxy.h"

@interface ZJWeakProxy : NSProxy
- (void)printZJWeakProxy;
@end

.m 文件下

#import "ZJWeakProxy.h"

@implementation ZJWeakProxy
- (void)printZJWeakProxy{
    NSLog(@"%s",__func__);
}
@end
  • 此时 cd 到 Example 路径下执行 pod install 命令，看看是否能将刚刚添加的库文件引入到工程中
mac@bogon ~ % cd /Users/mac/Desktop/ZJComponent/ZJWeakProxy/Example 
mac@bogon Example % pod install

如果成功会在Pods中看到：

image.png
  • 可以到项目中导入头文件简单使用一下
image.png

证明是可用的

项目上传与发布

  • cd到你的项目路径下，将项目上传到GitHub中（即刚刚创建的ZJWeakProxy公有库中），依次使用下列命令行，不要遗漏
# cd 到 组件ZJWeakProxy路径下
mac@bogon Example % cd /Users/mac/Desktop/ZJComponent/ZJWeakProxy
# 添加github项目路径
mac@bogon ZJWeakProxy % git remote add origin https://github.com/BboyZ/ZJWeakProxy.git
# 添加文件
mac@bogon ZJWeakProxy % git add .
# 将暂存区里的改动提交到本地的版本库
mac@bogon ZJWeakProxy % git commit -m "first commit"
# 创建分支main
mac@bogon ZJWeakProxy % git branch -M main
# 提交版本号并push到main分支
mac@bogon ZJWeakProxy % git push -u origin main

# 注意这里的版本号要与.podspec中的版本号保持一致
mac@bogon ZJWeakProxy % git tag 0.1.0
mac@bogon ZJWeakProxy % git push origin 0.1.0
  • 在执行 git push -u origin main 时，如果遇到需要输入用户名和密码：
Username for 'https://github.com': BboyZJ
Password for 'https://BboyZJ@github.com':

【注意】：这个 密码 不是你 GitHub 的登录密码，而是需要生成一个 access tokens

  • 生成 access token

需要在 GitHub 个人设置页 -> Settings -> Developer Settings -> Personal access tokens 中创建一个 token

image.png

  • Generate new token 生成新的 token

    • 设置 token 的有效期 按需设置，访问权限等
    image.png
* 选择要授予令牌token的范围或权限

* 要使用token从命令行访问仓库，请选择repo

* 要使用token从命令行删除仓库，请选择delete_repo
image.png
* 其他根据需要进行勾选
  • 点击 Generate token 生成 token

ghp_VcqgAmF...ZPJ2IGxu0

【注】：记得把这个 token 保存下来，因为下次再刷新这个页面的时候，你会看不到了

  • 在命令行输入完 token 密码
Username for 'https://github.com': BboyZJ
Password for 'https://BboyZJ@github.com': 
Enumerating objects: 91, done.
Counting objects: 100% (91/91), done.
Delta compression using up to 4 threads
Compressing objects: 100% (83/83), done.
Writing objects: 100% (91/91), 29.35 KiB | 2.45 MiB/s, done.
Total 91 (delta 23), reused 0 (delta 0), pack-reused 0
remote: Resolving deltas: 100% (23/23), done.
To https://github.com/BboyZJ/ZJWeakProxy.git
 * [new branch]      main -> main
branch 'main' set up to track 'origin/main'.

由上面看代表上传成功了

使用和验证

  • 新建个带 pod 的项目，把我们做好的 ZJWeakProxy 加入 podfile 文件
# Uncomment the next line to define a global platform for your project
platform :ios, '10.0'

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

  # ZJWeakProxy
  pod 'ZJWeakProxy',:git =>"https://github.com/BboyZJ/ZJWeakProxy.git"
  
  # Pods for ZJWeakProxy-Demo

end
  • 执行 pod install

mac@bogon ZJWeakProxy-Demo % pod install

【问题1】安装报错：[!] Unable to find a specification for ZJWeakProxy

image.png

解决办法：

mac@bogon ZJWeakProxy-Demo % pod repo update --verbose

【问题2】：HTTP/2 stream 1 was not closed cleanly before end of the underlying stream

image.png

解决办法：更改默认通信协议

mac@bogon ZJWeakProxy-Demo % git config --global http.version HTTP/1.1

  • 引入头文件并打印结果
image.png

版本更新与维护

  • 现在的 ZJWeakProxy 库已经在GitHub上托管了，以后维护这个项目就可以了（开始本地创建的ZJWeakProxy项目就可以删除了），管理GitHub仓库，有两种方案：

  • 其实 GitHub Desktop 更加可视化一些，上面History就是刚才git命令行的记录

总结

终于写完了，哇哦😮！

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 206,126评论 6赞 481
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 88,254评论 2赞 382
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 152,445评论 0赞 341
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 55,185评论 1赞 278
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 64,178评论 5赞 371
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,970评论 1赞 284
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,276评论 3赞 399
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,927评论 0赞 259
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 43,400评论 1赞 300
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2赞 323
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1赞 333
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,646评论 4赞 322
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,213评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1赞 260
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2赞 352
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2赞 345

推荐阅读更多精彩内容