[组件化]04.基础组件抽取上传实践

前言

前面3篇文章总结一下,组件化大致流程如下:

组件的抽取,一般我们按以下3种情况来进行划分的:

1.基础组件

 基础配置(宏,常量), 分类,网络(AFN, SDW二次封装)、工具类(日期时间的处理, 文件处理, 设备处理)。

2.功能组件

 控件(弹幕,轮播器,选项卡);功能(断点续传,音频处理)。

3.业务组件

业务线一, 业务线二。

首先我们来试着抽取基础组件,最终目的是制作出'SFCloudMusicBaseKit'的组件,能够通过'pod install'安装到我们原来的宿主工程中使用。

宿主工程我做了一个小的登录Demo,使用到RxSwift,另外也使用到XCoordinator来协调各控制器的跳转,组件化之前的原Demo在这里,基于此Demo,我们一步一步来完成基础组件的抽取。我们要抽的部分如下图所示,包括扩展和工具类。

一. 创建远程索引库

每创建一个组件都会带有一个 xxx.podspec 的索引文件。专门用来存放这些索引文件的库就叫做索引库。我们需要将这些索引文件上传到远程索引库才能保证其他的同事能够拿来用。

远程索引库已经创建成功,可以看到下图中红圈中的远程索引库的地址

二.创建本地索引库

通过pod repo add '本地索引库的名字' '远程索引库的地址' ,来创建本地索引库并和远程索引库做关联,建议本地索引库的名字和远程索引库保持一致。

通过pod repo 可以查看到,已经成功将远程索引库克隆到了本地,如上图红圈所示。

也可以在本地目录中通过下面的方式查看本地索引库。在个人用户目录中,按'command + shift + .' 来显示出隐藏文件夹,然后在'.cocoaPods'文件夹下就能找到本地索引库了,如下图。

三.创建远程代码库

创建远程代码库来存放组件代码,与创建远程索引库的方式一样。

创建成功后,可以看到代码地址,如下图,红圈中就是该组件远程代码地址,对应spec文件中的source。

四.创建本地代码库

我们可以专门新建个本地目录用来存放各组件,作为模版库。将组件都放到LocalLibs目录下。

1. 创建组件本地模版库

cd到LocalLibs目录下,通过pod lib create '组件名' 来创建本地模版库

pod lib create SFCloudMusicBaseKit

根据自身需求对下面的提示信息做选择:

本地模版库已经创建成功,此时LocalLibs目录下也有了SFCloudMusicBaseKit组件的模版库,其中还包含一个测试Example,我们可以利用它来对组件进行测试。

2.将组件代码抽到Classes文件中

我们将工程中的拓展和工具类抽取出来,拖到上图中的Classes文件夹中,如下图

3.在example中pod install 安装测试

cd到Example中,pod install 安装测试,打开Example工程发现确实已将Extensions和Utils加了进来,编译后发现找不到SDWebImage,这是因为Utils中SFAlertKit文件依赖了SDWebImage,所以需要在spec文件中添加依赖。

4. 修改spec文件

要修改的地方如下图所示:

需要强调的是,我们的基础组件中包含了拓展和工具类,有时我们只想安装使用拓展,或是只想使用工具类,为了方便我们可以将基础组件再多开几个分支,如上图所示,开了两个分支,你在使用时按需求安装某个分支的组件即可,不用把整个基础组件涵盖的内容全部装到工程中,这一点可以参考AFNetworking:

开分支的写法可参考如下,由于开了分支,所以把's.source_files'注释了,否则不需要注释,另外由于Utils中添加了SDWebImage的依赖,解决了第3点中的问题:

# s.source_files = 'SFCloudMusicBaseKit/Classes/**/*'

  s.subspec 'Extensions' do |e|
      e.source_files = 'SFCloudMusicBaseKit/Classes/Extensions/**/*'
  end

  s.subspec 'Utils' do |u|
       u.source_files = 'SFCloudMusicBaseKit/Classes/Utils/**/*'
       u.dependency 'SDWebImage'
  end

修改完后,重新cd到Example中,再次pod install时,发现出现以下警告:

[!] CDN: trunk Repo update failed - 82 error(s):
CDN: trunk URL couldn't be downloaded: https://raw.githubusercontent.com/CocoaPods/Specs/master/Specs/1/1/7/SDWebImage/2.4/SDWebImage.podspec.json, error: Failed to open TCP connection to raw.githubusercontent.com:443 (Connection refused - connect(2) for "raw.githubusercontent.com" port 443)

这个坑是cocoa pod升级到1.8.4,新增了一个trunk源,并以它为默认源,我们需要在podfile文件中指定source源:

source 'https://github.com/CocoaPods/Specs.git'

添加后,再pod install就可以了,此问题可以参考这篇文章的解决方案。

5.提交上面修改并推送到远程代码仓库, 打tag

回到LocalLibs下的SFCloudMusicBaseKit中:

cd /Users/shenhaichao/学习/LocalLibs/SFCloudMusicBaseKit 

提交上面修改并推送到远程代码仓库, 打上与spec文件中相同的tag:

git add .
git commit -m 'message'
git remote add origin 组件远程代码仓库地址
git push origin master
git tag 'tag号'
git push --tags

6. 本地验证和远程验证后,提交spec文件

6.1 本地验证

pod lib lint --verbose --allow-warnings

6.2 远程验证

pod spec lint --verbose --allow-warnings

验证通过!


6.3 提交本地spec文件

pod repo push <本地索引库名> <带后缀索引文件名> --verbose --allow-warnings

提交成功后,本地也能查看到:

以上6步下来,我们就将基础组件上传成功,当然公司的代码需要放到私有库中,步骤一样。最后我们将原工程中相应的部分替换掉,导入组件应用一下。

7. 应用

回到原工程修改podfile文件,将基础组件pod进来,需要注意的是在Podfile中指定组件远程索引库地址,如果不指定默认会从master的索引库查找,就会报找不到组件。

然后pod install 安装到工程中,安装完后可以看到工程中pods文件中已经有了我们需要的组件了:

小插曲:记得我们swift组件中的要公开出来的方法和属性要加public或open权限,不然调用不了。

public和open都是用来修饰class和class成员的。而他们的区别是:
1.当修饰class时
public修饰的class只允许外部模块调用,但是不允许继承。 而open修饰的class既允许其他模块调用,也允许被子类继承
2.当修饰class成员时
public修饰的成员只允许其他模块调用,但不能被覆盖(override)。而open修饰的成员既允许被其他模块调用,也允许成员被覆盖

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,294评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,493评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,790评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,595评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,718评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,906评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,053评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,797评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,250评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,570评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,711评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,388评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,018评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,796评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,023评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,461评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,595评论 2 350

推荐阅读更多精彩内容