CTMediator源码阅读和实际使用

iOS组件化CTMediator代码阅读及实际项目使用

前言

当项目代码量越来越大，团队人数越来越多，单一工程的开发方式渐渐成为开发效率的掣肘。此时就是应该引入组件化的时候。

组件化的最大难题我认为是在组件抽离的粒度，抽离的粒度直接关系到了组件化是否能提高开发效率，或者说起反作用。

公司项目中使用的组件化方案是基于CTMediator的target-action方式，利用runtime动态生成组件类的对象实现解耦，CTMediator本身代码也只有200行十分的好理解。

大致流程

1573562135191.jpg

源码阅读

当我们希望跳转到模块A的ModuleAViewController时引入对应模块的CTMediator类扩展

#import "CTMediator+ModuleA.h"
- (IBAction)action:(id)sender {
    UIViewController* moduleA = [[CTMediator sharedInstance] Mediator_ModuleAViewController];
    [self.navigationController pushViewController:moduleA animated:YES];
}

类扩展内部调用CTMediator的performTarget:action:shouldCacheTarget（这命名十分的apple）方法

传入模块名和action的名称 例：

- (UIViewController*)Mediator_ModuleAViewController {
    UIViewController* vc = [self performTarget:@"ModuleA" action:@"ModuleAViewController" params:@{} shouldCacheTarget:NO];
    return vc;
}

CTMediator.m中的performTarget:ation:params:shouldCacheTarget方法的实现

- (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 {
        //根据传入的targetName去拼接对应模块的入口类名 规则为Target_{ModuleName}
        //注意对应模块入口类的命名
        targetClassString = [NSString stringWithFormat:@"Target_%@", targetName];
    }
    //判断对应的类是否已经在缓存中 如果在缓存中则不反复的生成类对象
    NSObject *target = self.cachedTarget[targetClassString];
    if (target == nil) {
        //缓存中不存在 根据类名获取class 再init出来类对象
        Class targetClass = NSClassFromString(targetClassString);
        target = [[targetClass alloc] init];
    }

    // 拼接方法名 注意规则
    NSString *actionString = [NSString stringWithFormat:@"Action_%@:", actionName];
    SEL action = NSSelectorFromString(actionString);//根据方法名生成方法的SEL对象
    
    if (target == nil) {
        // 这里是处理无响应请求的地方之一，这个demo做得比较简单，如果没有可以响应的target，就直接return了。实际开发过程中是可以事先给一个固定的target专门用于在这个时候顶上，然后处理这种请求的
        [self NoTargetActionResponseWithTargetString:targetClassString selectorString:actionString originParams:params];
        return nil;
    }
    //判断是否需要缓存
    if (shouldCacheTarget) {
        self.cachedTarget[targetClassString] = target;
    }
    //判断对象是否实现了对应的action方法 实现了则通过safePerformAction调用
    if ([target respondsToSelector:action]) {
        return [self safePerformAction:action target:target params:params];
    } else {
        // 对象没有实现对应的action 判断是否实现了统一处理异常的notFound方法
        SEL action = NSSelectorFromString(@"notFound:");
        if ([target respondsToSelector:action]) {
            //实现了则调用notFound方法
            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;
        }
    }
}

CTMediator.m中的safePerformAction:target:params方法的实现

- (id)safePerformAction:(SEL)action target:(NSObject *)target params:(NSDictionary *)params
{
    //根据传入的类对象和方法的SEL对象 获取到方法的签名（方法的返回类型，有什么参数）
    NSMethodSignature* methodSig = [target methodSignatureForSelector:action];
    //签名为nil直接返回
    if(methodSig == nil) {
        return nil;
    }
    const char* retType = [methodSig methodReturnType];
    //无返回值和返回值为数值类型 通过NSInvocation设置参数 调用方法
    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);
    }
//返回值为OC对象类型的通过performSelector方式调用方法
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
    return [target performSelector:action withObject:params];
#pragma clang diagnostic pop
}

通过传入模块入口类和需要调用的对应方法，我们可以在不引入对应模块头文件的情况下最终拿到ModuleAViewController的对象，从而实现解耦跳转。

总结

CTMediator通过runtime的方式解耦，主项目中不需要引入对应的模块头文件，只需要引入对应模块的CTMediator类扩展。
将一个项目拆分成一个个组件，组件之间相互隔离，专人维护，组件可以单独提测。这就很好的解决了多人开发带来的效率降低问题。