美文网首页iOSiOS CollectioniOS奋斗
iOS组件化方案-总结第一篇

iOS组件化方案-总结第一篇

作者: sun6boys | 来源:发表于2016-12-19 00:44 被阅读16526次

概述

近一年iOS业界讨论组件化方案甚多,大体来说有3种。

  • Protocol注册方案
  • URL注册方案
  • Target-Action runtime调用方案

URL注册方案据我了解很多大公司都在采用,蘑菇街 App 的组件化之路蘑菇街的Limboy在这篇博客中做了很详尽的阐述

Target-Action runtime调用方案Casa在 iOS应用架构谈 组件化方案中也做了很详尽的描述,前阵时间Casa开了一篇博客在现有工程中实施基于CTMediator的组件化方案清楚讲述了如何用这套方案实施组件化

Protocol方案我尚未看到有人做过详尽的分享,也许是我孤陋寡闻,不过在这里,我会教大家用Protocol方案实施组件化,不仅如此..

我会采用以上3种方案详尽的实现3个Demo,Demo会在文尾给到,本文不过多阐述3种方案的优劣,我会在最后做一个总结,希望给想了解组件化方案的同学或者给在项目中准备实施组件化方案的同学提供一个借鉴。

第二篇 也已经出来了传送门iOS组件化方案-总结第二篇

业务模拟场景

  • 首页展示商品列表
  • 商品详情页展示商品的详细信息
  • 确认订单页生成订单

把业务连贯起来 点击首页中A商品,进入A商品的商品详情页 ,点击商品详情页中的 立即购买 进入确认订单页,点击确认订单页中的提交订单 会返回到商品详情页,并且在商品详情页中告知用户下单成功.

真实业务场景下确认订单页提交订单 是不会回到商品详情页的,模拟这个场景是想在Demo中实现2个模块中反向回调。

一、Protocol注册方案

正式实施前先奉上Demo,建议只下一个主项目就可以了(注:下载完不需要pod install或者pod update,pods在我私有源上 我没有填写.gitignore文件,下载完都是可以直接跑的)

主项目地址

商品详情业务接口组件地址

商品详情业务组件地址

确认订单业务接口组件地址

确认订单业务组件地址

业务调度中间件地址

1.基本准备工作

  • 先去gitHub创建一个项目存放私有Repo源,repo地址https://github.com/sun6boys/CRRepositories.git 后面3种方案私有pod源都会放在这里。
  • 本地添加私有源 终端执行命令pod repo add CRRepositories https://github.com/sun6boys/CRRepositories.git(如果之前并未向gitHub push过文件也没有把SSH公钥保存到gitHub,这时候应该会提示你输入gitHub账号密码)
  • 以上操作完成 cd ~/.cocoapods/repos目录下至少会有2个文件夹 CRRepositoriesmaster, master文件下面存放的是公有源文件,CRRepositories*目录下目前是空的,后面会存放我们私有源文件
  • 基本准备工作完成。

2.Xcode创建项目[CRProtocolManager]

CRProtocolManagerMGJRouterCTMediator一样属于模块之间调度的中间件

CRProtocolManager项目下创建名为CRProtocolManager的文件夹,后面我们需要做成私有pod的文件均放在该文件夹下。

创建CRProtocolManager类(.h,.m),定义2个对外接口

@interface CRProtocolManager : NSObject

+ (void)registServiceProvide:(id)provide forProtocol:(Protocol*)protocol;

+ (id)serviceProvideForProtocol:(Protocol *)protocol;

@end

具体方法实现很简单可以参看Demo,我这里只是简单处理。
接下来就是要把项目提交到gitHub,做私有pod了

  • gitHub新建一个project名为CRProtocolManager

  • 终端cd至CRProtocolManager项目目录下执行命令git remote add origin https://github.com/sun6boys/CRProtocolManager.git

  • 因cocoaPods强制添加开源许可文件执行命令echo MIT>FILE_LICENSE创建名为FILE_LICENSE的文件

  • 终端cd至CRProtocolManager目录下执行命令pod spec create CRProtocolManager

  • 执行命令vim .CRProtocolManager.podspec编辑podspec文件,具体如何编辑可参看Demo中的podspec文件或者google

  • 退出编辑执行命令git add .

  • `git commit -m 'log'

  • git tag 0.0.1 tag一定要和podspec中的version一致

  • git push origin master --tags --tags为了把刚才添加的tag提交上去

  • 执行命令pod repo push CRRepositories CRProtocolManager.podspec --verbose --allow-warnings 注:CRRepositories即为准备工作中的私有源仓库

  • 成功后pod search CRProtocolManager应该就能搜索到了

万里长征终于走完第一步,基础设施已经构建完毕

3.商品详情业务模块

既然组件化了,那我们所有的业务模块都是单独的project,但是这里我会分2个project,一个是商品详情业务入口模块,一个是商品详情业务模块。业务入口模块即是定义该模块对外提供业务接口的protocol,如果A模块需要调用到B模块,那A模块只需要引入CRProtocolManager和B模块的protocol,而不是引入整个B模块。

新建一个projectCRGoodsDetailServiceProtocol,创建一个和项目名一样的protocol文件,定义接口如下


@protocol CRGoodsDetailServiceProtocol <NSObject>

@required;

- (UIViewController *)goodsDetailViewControllerWithGoodsId:(NSString*)goodsId goodsName:(NSString *)goodsName;

@end

参照CRProtocolManager做成私有pod

以上实施完毕,新建一个projectCRGoodsDetail,新建2个类

CRGoodsDetailServiceProvide
CRGoodsDetailViewController

CRGoodsDetailServiceProvide即是CRGoodsDetailServiceProtocol的实现者 所以他依赖
CRGoodsDetailServiceProtocol,因为商品详情模块需要跳转到订单确认页,所以他也依赖CRProtocolManager

添加Podfile文件编辑如下

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

target 'CRGoodsDetail' do

pod "CRProtocolManager"
pod "CRGoodsDetailServiceProtocol"

end

执行pod install --verbose --no-repo-update

最终CRGoodsDetailServiceProvide实现代码如下

#import "CRGoodsDetailServiceProvide.h"
#import <CRGoodsDetailServiceProtocol/CRGoodsDetailServiceProtocol.h>
#import <CRProtocolManager/CRProtocolManager.h>

#import "CRGoodsDetailViewController.h"

@interface CRGoodsDetailServiceProvide()<CRGoodsDetailServiceProtocol>

@end

@implementation CRGoodsDetailServiceProvide

+ (void)load
{
    [CRProtocolManager registServiceProvide:[[self alloc] init] forProtocol:@protocol(CRGoodsDetailServiceProtocol)];
}

- (UIViewController *)goodsDetailViewControllerWithGoodsId:(NSString*)goodsId goodsName:(NSString *)goodsName
{
    CRGoodsDetailViewController *goodsDetailVC = [[CRGoodsDetailViewController alloc] initWithGoodsId:goodsId goodsName:goodsName];
    return goodsDetailVC;
}

@end

CRGoodsDetailViewController实现代码如下

#import "CRGoodsDetailViewController.h"

@interface CRGoodsDetailViewController ()

@property (nonatomic, copy) NSString *goodsId;
@property (nonatomic, copy) NSString *goodsName;

@property (nonatomic, strong) UILabel *statusLabel;
@property (nonatomic, strong) UIButton *buyButton;
@end

@implementation CRGoodsDetailViewController

- (instancetype)initWithGoodsId:(NSString *)goodsId goodsName:(NSString *)goodsName
{
    self = [super init];
    if (self) {
        _goodsId = goodsId;
        _goodsName = goodsName;
    }
    return self;
}

- (void)viewDidLoad {
    [super viewDidLoad];
    self.navigationItem.title = self.title;
    
    [self.view addSubview:self.statusLabel];
    [self.view addSubview:self.buyButton];
}

- (void)viewWillLayoutSubviews
{
    [super viewWillLayoutSubviews];
    self.statusLabel.frame = CGRectMake(0, 0, 100, 20);
    self.statusLabel.center = self.view.center;
    
    self.buyButton.frame = CGRectMake(0, self.view.frame.size.height - 45, self.view.frame.size.width, 45);
}

#pragma mark - event 
- (void)didClickBuyButton:(UIButton *)button
{
    
}

#pragma mark - getters
- (UILabel *)statusLabel
{
    if (_statusLabel == nil) {
        _statusLabel = [[UILabel alloc] init];
        _statusLabel.textColor = [UIColor redColor];
        _statusLabel.font = [UIFont systemFontOfSize:15.f];
        _statusLabel.textAlignment = NSTextAlignmentCenter;
        _statusLabel.text = @"暂未购买";
    }
    return _statusLabel;
}

- (UIButton *)buyButton
{
    if (_buyButton == nil) {
        _buyButton = [UIButton buttonWithType:UIButtonTypeCustom];
        [_buyButton setTitle:@"立即购买" forState:UIControlStateNormal];
        [_buyButton setTitleColor:[UIColor whiteColor] forState:UIControlStateNormal];
        [_buyButton setBackgroundColor:[UIColor redColor]];
        [_buyButton addTarget:self action:@selector(didClickBuyButton:) forControlEvents:UIControlEventTouchUpInside];
    }
    return _buyButton;
}
@end

CRGoodsDetail做成私有pod 记得编辑podspec文件的时候添加dependencyCRProtocolManager CRGoodsDetailServiceProtocol

4.新建主项目MainProject

为了少建一个项目首页模块我是直接放在主项目中的,按理首页也应该是一个独立的pod.
首页业务场景是,显示商品列表,点击某个商品进入该商品详情页. 所以他依赖CRGoodsDetailServiceProtocolCRProtocolManager因为首页模块即是主项目所以他还得依赖CRGoodsDetail

最终首页核心代码如下

#pragma mark - event
- (void)didClickGoodsButton:(UIButton *)button
{
    id<CRGoodsDetailServiceProtocol> goodsServiceProvide = [CRProtocolManager serviceProvideForProtocol:@protocol(CRGoodsDetailServiceProtocol)];
    UIViewController *goodsDetailVC = [goodsServiceProvide goodsDetailViewControllerWithGoodsId:@"123" goodsName:@"农夫山泉矿泉水"];
    [self.navigationController pushViewController:goodsDetailVC animated:YES];
    
}

5.确认订单模块

参照商品详情新建确认订单业务入口pod 以及确认订单业务pod.和商品详情有区别的是,提交订单完成后要回到商品详情并且通知商品详情用户已经购买,所以CRConfirmOrderServiceProtocol接口定义如下

@protocol CRConfirmOrderServiceProtocol <NSObject>

- (UIViewController *)confirmOrderViewControllerWithGoodsId:(NSString *)goodsId sureComplete:(dispatch_block_t)sureComplete;

@end

最后记得在商品详情加上跳转并且podspec里面加上dependency

Protocol注册方案完结


初稿未完结 待续

相关文章

  • iOS组件化方案

    iOS组件化方案 iOS组件化方案

  • iOS 组件化/模块化文章

    1.博客文章总结 iOS组件化思路-大神博客研读和思考iOS组件化实践方案-LDBusMediator炼就组件化架...

  • iOS组件化方案-总结第二篇

    概述 这是iOS组件化方案-总结的第二篇,在本文中我实现了Target-Action方案的Demo,并与第一篇介绍...

  • 组件化方案

    组件化方案引用 在现有工程中实施基于CTMediator的组件化方案 iOS组件化实践(一):简介 iOS组件化实...

  • iOS组件化文章汇总

    iOS应用架构谈 组件化方案 APP组件化之路 我所理解的组件化之路 iOS 组件化方案探索 围观神仙打架,反革命...

  • 07 CTMediator iOS组件化方案

    关于iOS组件化方案在Casa的iOS应用架构谈 组件化方案写得已经很清楚了。方案本身并不难,CTMediator...

  • 蜂鸟商家版 iOS 组件化 / 模块化实践总结

    蜂鸟商家版 iOS 组件化 / 模块化实践总结 蜂鸟商家版 iOS 组件化 / 模块化实践总结

  • iOS组件化 文章

    iOS组件化 BeeHive iOS应用架构谈 组件化方案 Small iOS BeeHive —— 一个优雅但还...

  • iOS系统架构

    1: 滴滴出行iOS客户端架构演进之路 2: iOS应用架构谈 组件化方案 3:iOS组件化方案调研 4: 饿了么...

  • iOS有关架构组件化的文章链接

    iOS应用架构谈 组件化方案 iOS 组件化方案探索 iOS移动端架构的那些事 如何优雅的实现界面跳转 之 统跳协...

网友评论

  • bigParis:有一点费解的地方, 首页点击某个商品进入该商品详情页. 所以他依赖CRGoodsDetailServiceProtocol和CRProtocolManager, 这样和直接依赖商品详情模块有什么区别, 我怎么感觉就是把商品详情类分开到2个类(CRGoodsDetailServiceProtocol和CRGoodsDetailServiceProvide)而已, 组件化就是面向协议开发, 实现CRGoodsDetailServiceProtocol里面定义的接口, 感觉和只用一个类CRGoodsDetailService也可以达到这样的目的, 调用方(首页)直接以来CRGoodsDetailService. 请大神指点迷津
    bigParis:@sun6boys 我觉得一个模块引入另一个模块定义的接口也算是一种依赖吧,protocol 注册方式只是换种写法吧?如果A模块要信用B模块定义的类型或者枚举怎么办呢?
    sun6boys:@bigParis 组件化不是面向协议编程,另组件化有一个选择,业务组件之间不相互依赖,如果换成你说的方式,他们之间肯定依赖了。
  • slimsallen:- ERROR | [iOS] file patterns: The `source_files` pattern did not match any file. 老是最后一步 卡在这里
  • slimsallen:一直 报这个错 求解 SAProtocolManager (0.0.1)
    - ERROR | license: Sample license type.
    - WARN | homepage: The homepage has not been updated from default
    - ERROR | source: The Git source still contains the example URL.
    - WARN | summary: The summary is not meaningful.
    - ERROR | description: The description is empty.
    - ERROR | [OSX] unknown: Encountered an unknown error (The `SAProtocolManager` pod failed to validate due to 3 errors.
    [!] The validator for Swift projects uses Swift 3.0 by default, if you are using a different version of swift you can use a `.swift-version` file to set the version for your Pod. For example to use Swift 2.3, run:
    `echo "2.3" > .swift-version`:
    - ERROR | license: Sample license type.
    - WARN | homepage: The homepage has not been updated from default
    - ERROR | source: The Git source still contains the example URL.
    - WARN | summary: The summary is not meaningful.
    - ERROR | description: The description is empty.
    b57bc247097e:这个解决了吗
  • 天下无贼:大神 我在使用pod spec lint 验证podspec有效性的时候 报Remote branch 1.0.0 not found in upstream origin 然后我猜测是没有给项目打tag值 cd到本地想你目录 使用git tag “v1.0.0"给项目打tag 出现Failed to resolve 'HEAD' as a valid ref. 这问题卡了我很长时间 跪求大神帮忙给看一下 :pray: :pray:
    sun6boys:@天下无贼 不用客气。
    天下无贼:@sun6boys 我的GitHub上面没有1.0.0的版本 所以找不到 我用sourcetree推一个1.0.0的版本 解决了 非常感谢大神的教程和回答:pray: :pray:
    sun6boys:@天下无贼 你podspec里面的version也是v1.0.1吗?
  • xlL503721:其实你可以直接说 这是一种依赖倒转方式
  • 5900bf190246:1、使用者在调用某个类的时候必须要导入对应该类的协议 ,这也算是间接的产生了耦合, 为啥不将所有协议放在CRProtocolManager模块
    2、用Protocol实在没意义,不知道博主用Protocol是用来解决什么问题
    3、针对第一个问题 个人觉得可以为CRProtocolManager增加一个category 里面处理所有页面的跳转逻辑,所有的页面头文件都导入在这里
  • 5900bf190246:为毛明明很简单的路由思想, 为毛能搞的这么复杂
  • 5900bf190246:感觉没必要pod git操作写在文章里
  • 5900bf190246:觉得博主应该把cocoapods方面的操作 和 架构方面的思想分开来讲
  • yuditxj:网络库封装成组件,那请求的时候显示菊花是不是在这个组件里做
    sun6boys:@yuditxj 拦截器。又或者你网络层获取到数据怎么反馈到业务层的,要么是代理要么是block,那在发起请求前展示菊花,请求回来后关闭菊花即可。你要恶补下了,已经在研究组件化了竟然会问这些问题。:stuck_out_tongue_winking_eye:
    yuditxj:@sun6boys 网络层只负责发送请求?那要怎么写显示菊花比较好呢?
    sun6boys:@yuditxj 不做,网络层不做视图层的事情。
  • R0b1n_L33:画个流程图表达整体结构比较好
    sun6boys:@yuditxj 网络请求也是个模块,由业务模块引入
    yuditxj:网络请求怎么办?
    sun6boys:@ljysdfz 嗯哈:smile:谢谢建议啦。
  • junfly:能指导下么?
    写多个 s.dependency 这个怎么写, 老是报错,
    着急
    - ERROR | [iOS] unknown: Encountered an unknown error (Unable to find a specification for `ZJYCeShiProtocolManager` depended upon by `ZJYCeShiDetail`) during validation.
    sun6boys:@junfly 你把qq简信告诉我,我加你,你把demo发给我,我帮你找问题。
    junfly:@sun6boys 我的就是报刚才这个错...
    sun6boys:@junfly 依赖哪个就填写哪个,比如 s.dependency ="abcd"
  • 55d97ebe1031:膜拜下 太有用了对于我这样的新手来说 希望楼主以后多写点这种文章
  • f14230aebeb0:你好,如果vc 需要一些自定义的view 这个view 也要做成组件化的形式么 还有 model类
    sun6boys:@小小程序员222 不需要的。当前模块就直接引入头文件好了。
    f14230aebeb0:@sun6boys 放在当前模块的view 也需要制定一个协议来引用么
    sun6boys:@小小程序员222 看场景,如果这个view在其他模块可以复用就独立出一个pod,不复用,就放在当前模块,未来要复用再拎出来
  • 游走iOS:写的很好,很有帮助
    sun6boys:@游走iOS 谢谢:smile:
  • 1d2aa59a2e8b:等下文 :clap:
    sun6boys:@Tk_Jacky 最近忙,应该会在周四,周五。
  • 恋之空的blog:阿里有个BeeHive
    sun6boys:@zhangIPeng 好的。
    sun6boys:@zhangIPeng 官方有demo的吧。
    sun6boys:@恋之空的blog 嗯,谢谢。
  • 栈溢出:蘑菇街在补全本地调用的时候就用了Protocol的方式 :cry:
    sun6boys:@栈溢出 嗯,看到了。不过他没提供demo:smile:
  • 十秒_:所以用一个业务模块需要做两个pod库?protocol的pod库和业务模块的pod库?
    sun6boys:@Feeeeeerny 是的,他是用了runtime 解决的依赖关系,但是NSProtolFromString,也可以解决我里面的依赖,只是不优雅。
    十秒_:@sun6boys 那感觉这个和casa的category差不多。但是casa的业务二不需要依赖category,而这种方案中业务二还需要依赖protocol。相当于调用者和响应者都需要依赖protocol才能完成完整的调用。
    sun6boys:@Feeeeeerny 是的,业务一需要调用业务二,业务一只需要引用业务二定义的protocol,在现实开发中,可能业务一的开发人员需要进去业务二中做些事情测试,那就在业务一模块中Podfile 引入业务二,但是podspec 中dependency 只添加业务二的protocol
  • 还有梦想吗zZ:期待下文。 :smiley:
    sun6boys:@还有梦想吗zZ 近期播出:stuck_out_tongue:
  • 051f1813be2f:大神我也在做这方面的东西,能不能指导下呢,我已经完成了正向界面调度,反向调度这块我还没想法
    sun6boys:@你若不弃我便不离 看我protocol的demo中,商品详情页跳转至确认订单页,confirmorderprotocol提供的确认订单业务接口有一个block.
    051f1813be2f:@sun6boys protocol
    sun6boys:@你若不弃我便不离 你看我demo.有这样的案例,你们用的什么方案,大致介绍下,我明天可以给你写个demo

本文标题:iOS组件化方案-总结第一篇

本文链接:https://www.haomeiwen.com/subject/wuwzmttx.html