参考:
蘑菇街 App 的组件化之路
蘑菇街 App 的组件化之路·续
iOS应用架构谈 组件化方案
在现有工程中实施基于CTMediator的组件化方案
iOS 组件化方案探索
当我们在项目组件化的过程中,我们会把项目各个部分或者模块,做成组件(主要是通过cocoapods),这样整个项目就会搭积木一样,由各个组件拼起来。但是这时候,组件之间的跳转,通信,回调,就成了一个需要解决的问题。目前也有很多方案,这里主要调研了下 MGJRouter 和 CTMediator 两种方式。
本篇文章的Demo
MGJRouterAndCTMediatorDemo
一,MGJRouter
- 1,App启动时实例化各组件模块,然后这些组件向ModuleManager注册Url,有些时候不需要实例化,使用class注册。
- 2,当组件A需要调用组件B时,向ModuleManager传递URL,参数跟随URL以GET方式传递,类似openURL。然后由ModuleManager负责调度组件B,最后完成任务。
GlobalModuleRouter 就是负责注册和管理URL 的类,项目所有的URL都是统一管理,这样就不会分散在各个组件或模块里。
@implementation GlobalModuleRouter
+(void)load
{
[MGJRouter registerURLPattern:@"mgj://app/gethome" toObjectHandler:^id(NSDictionary *routerParameters) {
NSString * title = routerParameters[MGJRouterParameterUserInfo][@"title"];
ZDHomeViewController * vc = [ZDHomeViewController new];
vc.navigationItem.title = title;
return vc;
}];
[MGJRouter registerURLPattern:@"mgj://app/getcategory" toObjectHandler:^id(NSDictionary *routerParameters) {
NSString * title = routerParameters[MGJRouterParameterUserInfo][@"title"];
CategoryViewController * vc = [CategoryViewController new];
vc.navigationItem.title = title;
return vc;
}];
[MGJRouter registerURLPattern:@"mgj://app/godetail" toHandler:^(NSDictionary *routerParameters) {
NSString * title = routerParameters[MGJRouterParameterUserInfo][@"title"];
UINavigationController * nav = routerParameters[MGJRouterParameterUserInfo][@"navigationVC"];
NSString * name = routerParameters[MGJRouterParameterUserInfo][@"name"];
ProductDetailViewController * vc = [ProductDetailViewController new];
vc.navigationItem.title = title;
vc.name = name;
vc.hidesBottomBarWhenPushed = YES;
[nav pushViewController:vc animated:YES];
}];
[MGJRouter registerURLPattern:@"mgj://app/gonext" toHandler:^(NSDictionary *routerParameters) {
UINavigationController * nav = routerParameters[MGJRouterParameterUserInfo][@"navigationVC"];
void(^clicked)(NSString *) = routerParameters[MGJRouterParameterUserInfo][@"btnClickBlock"];
NextViewController * vc = [NextViewController new];
vc.btnClickBlock = clicked;
vc.hidesBottomBarWhenPushed = YES;
[nav pushViewController:vc animated:YES];
}];
}
可以通过objectForURL方法获取指定的 controller,
[MGJRouter objectForURL:<#(NSString *)#> withUserInfo:<#(NSDictionary *)#>];
openURL:打开指定页面,withUserInfo :传值
[MGJRouter openURL:@"mgj://app/godetail" withUserInfo:@{
@"title" : @"详情",
@"navigationVC" : self.navigationController,
@"name" : @"传值"
} completion:nil];
回调:通常是通过在userinfo字典中传入block。
[MGJRouter openURL:@"mgj://app/gonext" withUserInfo:@{
@"navigationVC" : self.navigationController,
@"btnClickBlock" : ^(NSString * title){
NSLog(@"---%@",title);
}
} completion:nil];
MGJRouter 大概的原理:是在registerURL 的时候,把URL作为key,handler 的block 作为value,存起来,在openURL的是,根据URL 取出handler 的block 去执行。
[MGJRouter registerURLPattern:@"mgj://app/godetail" toHandler:^(NSDictionary *routerParameters) {
NSString * title = routerParameters[MGJRouterParameterUserInfo][@"title"];
UINavigationController * nav = routerParameters[MGJRouterParameterUserInfo][@"navigationVC"];
NSString * name = routerParameters[MGJRouterParameterUserInfo][@"name"];
ProductDetailViewController * vc = [ProductDetailViewController new];
vc.navigationItem.title = title;
vc.name = name;
vc.hidesBottomBarWhenPushed = YES;
[nav pushViewController:vc animated:YES];
}];
看上面的代码片段就知道这个 toHandler block 会在 registerURL 时候存起来,然后再openUrl 取出来执行,就是执行一个 push 操作。但是业务多起来之后,这样带来的问题就是注册表常驻内存,而且内存会越来越大。
二,CTMediator
CTMediator 采取的是一种中间件的方式,这样每个页面会多出一个category 和一个Target_xxx 文件,避免了注册URL带来的内存问题。
下面简单看下 CTMediatorDemo 的调用过程,
要获取 ZDHomeViewController 类创建的实例,先调用下面这个方法
[CTMediator sharedInstance] getHomeVCWithTitle:@"首页1"]
它会转到 CTMediator+Home 这个分类里
@implementation CTMediator (Home)
- (UIViewController *)getHomeVCWithTitle:(NSString *)title;
{
NSMutableDictionary * dict = @{}.mutableCopy;
[dict setValue:title forKey:@"title"];
return [self performTarget:@"ZDHomeViewController" action:@"ZDHomeViewController" params:dict shouldCacheTarget:NO];
}
@end
字典是为了传值,主要是 performTarget:这个方法,它跳转到 CTMediator 类中.
- (id)performTarget:(NSString *)targetName action:(NSString *)actionName params:(NSDictionary *)params shouldCacheTarget:(BOOL)shouldCacheTarget
{
NSString *swiftModuleName = params[kCTMediatorParamsKeySwiftTargetModuleName];
// generate target
NSString *targetClassString = nil;
if (swiftModuleName.length > 0) {
targetClassString = [NSString stringWithFormat:@"%@.Target_%@", swiftModuleName, targetName];
} else {
targetClassString = [NSString stringWithFormat:@"Target_%@", targetName];
}
NSObject *target = self.cachedTarget[targetClassString];
if (target == nil) {
Class targetClass = NSClassFromString(targetClassString);
target = [[targetClass alloc] init];
}
// generate action
NSString *actionString = [NSString stringWithFormat:@"Action_%@:", actionName];
SEL action = NSSelectorFromString(actionString);
if (target == nil) {
// 这里是处理无响应请求的地方之一,这个demo做得比较简单,如果没有可以响应的target,就直接return了。实际开发过程中是可以事先给一个固定的target专门用于在这个时候顶上,然后处理这种请求的
[self NoTargetActionResponseWithTargetString:targetClassString selectorString:actionString originParams:params];
return nil;
}
if (shouldCacheTarget) {
self.cachedTarget[targetClassString] = target;
}
if ([target respondsToSelector:action]) {
return [self safePerformAction:action target:target params:params];
} else {
// 这里是处理无响应请求的地方,如果无响应,则尝试调用对应target的notFound方法统一处理
SEL action = NSSelectorFromString(@"notFound:");
if ([target respondsToSelector:action]) {
return [self safePerformAction:action target:target params:params];
} else {
// 这里也是处理无响应请求的地方,在notFound都没有的时候,这个demo是直接return了。实际开发过程中,可以用前面提到的固定的target顶上的。
[self NoTargetActionResponseWithTargetString:targetClassString selectorString:actionString originParams:params];
[self.cachedTarget removeObjectForKey:targetClassString];
return nil;
}
}
}
这时候 targetClassString 会拼成 Target_ ZDHomeViewController 类名,actionString 会拼成 Action_ZDHomeViewController: 这个方法名,接着就是让 Target_ ZDHomeViewController 执行Action_ZDHomeViewController: 这个方法,从而返回 controller。
下面就是这个方法的实现,它会返回 ZDHomeViewController
@implementation Target_ZDHomeViewController
- (UIViewController *)Action_ZDHomeViewController:(NSDictionary *)param;
{
ZDHomeViewController * vc = [ZDHomeViewController new];
vc.navigationItem.title = param[@"title"];
return vc;
}
另外补充一点,Target对象的Action设计出来也不是仅仅用于返回ViewController实例的,它可以用来执行各种属于业务线本身的任务。例如上传文件,转码等等各种任务其实都可以作为一个Action来给外部调用,Action完成这些任务的时候,业务逻辑是可以写在Action方法里面的。换个角度说就是:Action具备调度业务线提供的任何对象和方法来完成自己的任务的能力。它的本质就是对外业务的一层服务化封装。
关于 CTMediator 的原理部分,可以看看这篇文章
iOS NSInvocation应用与理解
三,CTMediator 的思路
CTMediator 的作者认为组件化不应该跟URL扯上关系,因为组件对外提供的接口主要是模块间代码层面上的调用,URL只是满足运营人员可以通过URL来控制不同的活动页面。而且MGJRouter 没有拆分本地调用和远程调用,模块代码层上的调用称为本地调用,URL作为APP之间的通信,称为远程调用,远程调用应该作为本地调用的子集,正确的思路应该像下面这样👇
后台提供的url -> openUrl -> urlRouter -> perform -> target-action
事实上 CTMediator 也提供了这样的方法:
// 远程App调用入口
- (id)performActionWithUrl:(NSURL *)url completion:(void(^)(NSDictionary *info))completion;
下面看看这个方法的实现
/*
scheme://[target]/[action]?[params]
url sample:
aaa://targetA/actionB?id=1234
*/
- (id)performActionWithUrl:(NSURL *)url completion:(void (^)(NSDictionary *))completion
{
NSMutableDictionary *params = [[NSMutableDictionary alloc] init];
NSString *urlString = [url query];
for (NSString *param in [urlString componentsSeparatedByString:@"&"]) {
NSArray *elts = [param componentsSeparatedByString:@"="];
if([elts count] < 2) continue;
[params setObject:[elts lastObject] forKey:[elts firstObject]];
}
// 这里这么写主要是出于安全考虑,防止黑客通过远程方式调用本地模块。这里的做法足以应对绝大多数场景,如果要求更加严苛,也可以做更加复杂的安全逻辑。
NSString *actionName = [url.path stringByReplacingOccurrencesOfString:@"/" withString:@""];
if ([actionName hasPrefix:@"native"]) {
return @(NO);
}
// 这个demo针对URL的路由处理非常简单,就只是取对应的target名字和method名字,但这已经足以应对绝大部份需求。如果需要拓展,可以在这个方法调用之前加入完整的路由逻辑
id result = [self performTarget:url.host action:actionName params:params shouldCacheTarget:NO];
if (completion) {
if (result) {
completion(@{@"result":result});
} else {
completion(nil);
}
}
return result;
}
最终也是将url 转化为调用 performTarget:action 这个方法
id result = [self performTarget:url.host action:actionName params:params shouldCacheTarget:NO];
我在 CTMediatorUrlDemo 这个demo 里也尝试了利用短链也拆分项目,
NSString * urlStr = @"App://ProductDetail/GetProductDetailVC?Id=111";
NSURL * url = [NSURL URLWithString:[urlStr stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLFragmentAllowedCharacterSet]]];
UIViewController * vc = [[CTMediator sharedInstance] performActionWithUrl:url completion:NULL];
[self.navigationController pushViewController:vc animated:YES];
在不需要远程调用的时候,我们只需要考虑target action 的命名,但是在需要远程调用的时候,就需要考虑短链和target action 的命名问题。
另外在处理短链的时候,应该更细致一些,短链的格式也应该规范一点,这里只是按照CTMediator 的作者提供的思路做了下拆分尝试,仅供参考。
网友评论