iOS组件化的那些事 - CTMediator

image

前言

在组件化之前，app都是在一个工程里开发的，开发的人员也是比较少的，业务发展也不是非常快，项目中不引用组件化开发也是合适的。但是当开发人员越来越多，代码量也就越来越多，业务也就越来越复杂，这时候单一的开发模式会显露出一些弊端：

耦合代码严重【代码没有明确的约束，越来越臃肿】
开发效率不高【难以维护，维护成本过高】

为了解决这些问题，于是出现了组件化开发的策略，拥有以下好处：

方便针对性测试
研发人员维护不同Module【提高开发效率，降低维护成本】

目前组件化开发的方式大约有三种：url - block、protocol - class 以及CTMediator target - action方案，本篇主要是本人项目中使用到的CTMediator target - action方案，将从源码分析，以及其优劣性。

一、准备

了解下面的概念，对理解swift的静态语言特性是有帮助的。

问：动态语言、静态语言、动态类型语言、静态类型语言、编译性语言、解释性语言区别？

1.1 编译型语言

需通过编译器【compliler】将源代码编译成机器码，之后才能执行的语言。一般需经过编译【compile】、链接【linker】这两个步骤，编译是把源代码编译成机器码，链接是把各个模块的机器码和依赖库串联起来生成可执行文件。

优点：

编译器一般会有预编译的过程对代码进行优化。因为编译只做一次，运行时不需要编译，所以编译型语言的程序执行效率高。
可以脱离语言环境独立运行。

缺点：

编译之后如果需要修改某个模块就需要重新编译。编译的时候根据对应的运行环境生成机器码，不同的操作系统之间移植就会有问题。需要根据运行的操作系统环境编译不同的可执行文件。

语言： C、C++、Object-C以及Swift

1.2 解释型语言

解释型语言的程序不需要编译，相比编译型语言省了道工序，解释性语言在运行程序的时候才逐行翻译。

优点：

良好平台兼容性，在任何环境都可以运行
灵活，修改代码的时候修改就可以，可以快速部署

缺点：

每次运行都要解释一遍，性能不如编译型语言。

语言：JavaScript、Python、PHP、Ruby

1.3 动态语言

是一类运行时可以改变其结构的语言：已有的函数，对象可以被删除或者其他结构上的变化。通俗点说是运行时可以根据某些条件改变自身结构。

语言： Object-C、C#、JavaScript、PHP、Python

【Object-C是编译型语言，但也是动态语言，得益于特有的run time机制，OC代码是可以在运行时插入、替换方法的】

1.4 静态语言

运行时结构不可变的语言就是静态语言。

语言：Java、C、Swift

1.5 动态类型语言

动态类型语言和动态语言是完全不同的两个概念。

动态类型语言是指在运行期间才去做数据类型检查的语言，说的是数据类型，动态语言说的是运行是改变结构，说的是代码结构。

动态类型语言的数据类型不是在编译阶段决定的，而是把类型绑定延后到了运行阶段。

语言：Python、Ruby、JavaScript、swift、PHP。

1.6 静态类型语言

静态语言的数据类型是在编译其间确定的，写编写代码的时候要明确确定变量的数据类型。

语言：C、C++、C#、Java、Object-C。

拓展：

@objc 是用来将Swift 的API导出给Objective-C和Objective-C runtime使用的，如果你的类继承自Objective-C【如NSObject】将会自动被编译器插入@objc标识。加了@objc标识的方法、属性无法保证都会被运行时调用，因为Swift会做静态优化。要想完全被动态调用，必须使用dynamic修饰。使用dynamic修饰将会隐式的加上@objc标识。

二、CTMediator源码

swift由于静态的本质，至今没有什么好的解耦方式，因为静态语言的类型是在编译时就确定的【上面准备的重要性】，注定了它无法像上面一样使用字符串就能获取到，所以现在iOS常用的解耦框架都是OC编写的，如果想要使用解耦框架，那就只能混编啦！

CTMediator代码结构图

image

下面我们将讲解CTMediator源码具体内容。

2.1 target-action工作图

target-action 中间采取了Runtime来完成调用。

image

2.2 本地调用入口

下面是本地调用的CTMediator的源代码：

本地组件调用：本地组件A在一处调用[[CTMediator sharedInstance] performTarget:targetName action:actionName params:@{...}]向CTMediator发起了跨组件调用,CTMediator根据发送过来的target和action,然后经过OC的runtime机制转为target实例以及action,最后调用到目标业务提供的逻辑,完成要求.

首先利用runtime进行反射，将类字符串和方法字符串转换成类和SEL方法。

/**
 *  本地组件调用入口
 *
 *  @param targetName 类对象   OC中类对象是要Target_为前缀的
 *  @param actionName 方法名称  最后实际调用的是以Action_为前缀的
 *  @param params     参数
 *  @param shouldCacheTarget 是否缓存拼接后的类对象
 *
 *  @return return value JSon格式的字符串
 */
- (id)performTarget:(NSString *)targetName action:(NSString *)actionName params:(NSDictionary *)params shouldCacheTarget:(BOOL)shouldCacheTarget
{
    //供swift项目使用，swift必须要加入模块名，swift工程内获取Target需要带上module的名称
    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];
    }

    // 拼装方法字符串
    NSString *actionString = [NSString stringWithFormat:@"Action_%@:", actionName];
    // 生成SEL
    SEL action = NSSelectorFromString(actionString);
    //先从缓存取，取不到去创建，但是也有可能创建失败的情况（targetName值不正确）
    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;
        }
    }
}

如果target 和 action 都有值，会调用[self safePerformAction:action target:target params:params]方法【【生成的类前面的会加上Target_,生成的方法前面会加上Action_】】

- (id)safePerformAction:(SEL)action target:(NSObject *)target params:(NSDictionary *)params
{
    NSMethodSignature* methodSig = [target methodSignatureForSelector:action];
    if(methodSig == nil) {
        return nil;
    }
    const char* retType = [methodSig methodReturnType];

    if (strcmp(retType, @encode(void)) == 0) {
        NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:methodSig];
        [invocation setArgument:&params atIndex:2];
        [invocation setSelector:action];
        [invocation setTarget:target];
        [invocation invoke];
        return nil;
    }

    if (strcmp(retType, @encode(NSInteger)) == 0) {
        NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:methodSig];
        [invocation setArgument:&params atIndex:2];
        [invocation setSelector:action];
        [invocation setTarget:target];
        [invocation invoke];
        NSInteger result = 0;
        [invocation getReturnValue:&result];
        return @(result);
    }

    if (strcmp(retType, @encode(BOOL)) == 0) {
        NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:methodSig];
        [invocation setArgument:&params atIndex:2];
        [invocation setSelector:action];
        [invocation setTarget:target];
        [invocation invoke];
        BOOL result = 0;
        [invocation getReturnValue:&result];
        return @(result);
    }

    if (strcmp(retType, @encode(CGFloat)) == 0) {
        NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:methodSig];
        [invocation setArgument:&params atIndex:2];
        [invocation setSelector:action];
        [invocation setTarget:target];
        [invocation invoke];
        CGFloat result = 0;
        [invocation getReturnValue:&result];
        return @(result);
    }

    if (strcmp(retType, @encode(NSUInteger)) == 0) {
        NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:methodSig];
        [invocation setArgument:&params atIndex:2];
        [invocation setSelector:action];
        [invocation setTarget:target];
        [invocation invoke];
        NSUInteger result = 0;
        [invocation getReturnValue:&result];
        return @(result);
    }

#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
    return [target performSelector:action withObject:params];
#pragma clang diagnostic pop
}

将消息和消息接受者封装成一个对象，然后执行。利用target-action生成方法签名，然后创建NSInvocation对象，进行执行invoke。

这个方法比较长，但其实前面就是重复的代码，来实现返回类型是基本数据类型的调用，使用的是NSInvocation来完成调用；最后使用performSelector实现返回值是对象的调用。最后performSelector方法前后的#pragma clang diagnostic是消除内存警告的预处理命令

2.2 远程调用入口

远程应用的调取：远程应用是通过openURL的方式,由iOS 系统根据info.plist里的scheme配置用来可以找到响应的URL的应用,应用直接通过AppDelegate接收到URL之后,调用了CTMediator的OpenURL方法将接收到的信息传入进去.当然,CTMediator也可以用CTMediator的openURL:options:方式顺便将option也接收,这取决于是否包含了option数据,传入URL之后,CTMediator进行解析URL,将请求的路由到相对应的target-action中,随后的过程就变成了上面的本地应用调用过程了,最终完成了响应.

/*
 scheme://[target]/[action]?[params]

 url sample:
 aaa://targetA/actionB?id=1234&title=title

 [url query]:  id=1234&title=title
 [url path]:  /actionB
 [url host]:  targetA
 */

- (id)performActionWithUrl:(NSURL *)url completion:(void (^)(NSDictionary *))completion
{
    //url参数的处理
    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;
}

拓展：

NSClassFromString 通过字符串的名称来获取一个类，可以根据Target来进行获取
NSSelectorFromString 通过字符串(已存在的方法名称)获取一个SEL
复制代码

三、项目

从搜索结果页-另个模块详情页界面如上,跨越了两个模块,项目采用了CTMediator的Target-Action模式.下面按照执行的顺序截图如下:

image

3.1 点击tableViewCell->func tableView(_ tableView: UITableView, didSelectRowAt indexPath: IndexPath)

image

3.2 进入openBrokerDetailScene,开始调CTMediator【公司采用Viper的变形版架构】

image

3.3 开始进入EngineToBroker_viewController,调用self.performTarget("Broker", action: "brokerDetailVC", params: params, shouldCacheTarget: false)【返回vc】

image

通过调用self.performTarget("Broker", action: *****) ,会执行下面方法

image

3.4 最终得到了ViewController,回到即将跳转到

image

这样就完成了CTMediator在Swift中的使用。

作者：国孩
链接：https://juejin.im/post/6879980785177198606