CTMediator源码解析

组件化开发第一步要解决的就是解耦以及不同module之间的通信问题,这个时候CTMediator就进入了大家的视野,它使用的解耦方式是非常典型的Target-Action,使用字符串(类名、方法名)来获取对象和方法,然后调用,简单粗暴又高效,它省去了其他方式例如protocol、URL路由等需要建立和维护注册表的麻烦,但相应的增加了很多字符串的硬编码,但个人认为利大于弊。

核心原理

FOUNDATION_EXPORT Class _Nullable NSClassFromString(NSString *aClassName);
FOUNDATION_EXPORT SEL NSSelectorFromString(NSString *aSelectorName);
- (id)performSelector:(SEL)aSelector withObject:(id)object;

利用OC动态语言runtime的特性,使用👆上面的前两个方法获取到类和方法,最后一个函数可以使用实例调用获取到的方法。这里不得不感叹动态语言的便利性,swift由于静态的本质,至今没有什么好的解耦方式,因为静态语言的类型是在编译时就确定的,注定了它无法像上面一样使用字符串就能获取到,所以现在iOS常用的解耦框架都是OC编写的,swift工程只能混编OC来使用这些框架,一声叹息啊……

源码解析

1. 头文件

extern NSString * const kCTMediatorParamsKeySwiftTargetModuleName;

@interface CTMediator : NSObject

+ (instancetype)sharedInstance;

// 远程App调用入口
- (id)performActionWithUrl:(NSURL *)url completion:(void(^)(NSDictionary *info))completion;
// 本地组件调用入口
- (id)performTarget:(NSString *)targetName action:(NSString *)actionName params:(NSDictionary *)params shouldCacheTarget:(BOOL)shouldCacheTarget;
- (void)releaseCachedTargetWithTargetName:(NSString *)targetName;

@end
  • kCTMediatorParamsKeySwiftTargetModuleName 这个是swift功能使用的,swift工程内获取Target需要带上module的名称
  • sharedInstance 这个没啥说的,单例
  • performActionWithUrl 远程url调用方法,主要也是解析url之后调用👇下面的target方法
  • performTarget 使用字符串来调用target对应的方法,params是action的参数,shouldCacheTarget是否缓存,这个缓存是个极其简单的字典存储,并没有实现自动内存管理,不建议开启这个缓存
  • releaseCachedTargetWithTargetName 移除缓存的target,与上一个方法的是否缓存对应
    上面最重要的还是performTarget这个方法,接下来我们详细去读一下它的实现
    2. 实现
    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];
    }

首先是获取Target,前面的就是一系列拼接Target名称的方法,拼接后是Modeule.Target_yourTarget这个格式,OC工程不需要Module,直接是Target_yourTarget。所以这里算是个默认约定,你使用CTMediator获取的Target类,必须以Target_这个前缀开头。
然后先去读缓存,缓存里并没有这个Target对象的话,就使用NSClassFromString获取类,然后初始化出target对象。swift类记得继承NSObject,不然无法使用OC方法动态获取⚠️
我们来看一个这份缓存的实现,我前面也吐槽过了,这个缓存太过简单了

#pragma mark - getters and setters
- (NSMutableDictionary *)cachedTarget
{
    if (_cachedTarget == nil) {
        _cachedTarget = [[NSMutableDictionary alloc] init];
    }
    return _cachedTarget;
}

cachedTarget就是一个NSMutableDictionary可变的字典😂,以上面拼接出来的target名称作为键值,当你肆无忌惮的开启缓存,然后你的target又特别多,target对象里面又包含很多内容,你想想你的内存会怎样,字典并不会帮助你使用LRU(最近最少使用原则)这样的原则释放内存,你自己也不可能把握好释放target的时机,所以这个不要随便缓存,我后面会提出解决方案的,继续看下去

// generate action
    NSString *actionString = [NSString stringWithFormat:@"Action_%@:", actionName];
    SEL action = NSSelectorFromString(actionString);

接下来和之前获取Target类似,拼接出方法名,格式是Action_yourAction,所以你的方法也必须使用Action_作为前缀,然后swift的类,记得方法前声明@objc

    if (target == nil) {
        // 这里是处理无响应请求的地方之一,这个demo做得比较简单,如果没有可以响应的target,就直接return了。实际开发过程中是可以事先给一个固定的target专门用于在这个时候顶上,然后处理这种请求的
        [self NoTargetActionResponseWithTargetString:targetClassString selectorString:actionString originParams:params];
        return nil;
    }
    
    if (shouldCacheTarget) {
        self.cachedTarget[targetClassString] = target;
    }

接下来是异常处理,如果没有获取到对应的Target,进入这个处理;在下面就是如果获取到target对象了,根据你的设置进行缓存。没有获取到Target可能的原因有:Target不存在、名称错误、Module错误等等

    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方法的环节!首先使用respondsToSelector:方法判断target是否响应这个sel,如果不响应也就是target对象并没有实现这个方法,进入异常处理;可以响应的话,那我们就去调用它,获取返回值,作者实现了safePerformAction:来实现调用,我们来看看这个方法的实现

- (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
}

这个方法比较长,但其实前面就是重复的代码,来实现返回类型是基本数据类型的调用,使用的是NSInvocation来完成调用;最后使用performSelector实现返回值是对象的调用。
最后performSelector方法前后的#pragma clang diagnostic是消除内存警告的预处理命令,这个和编译器有关,这里不深入说明。
讲到这里差不多就把这个框架的核心方法讲完了,之前url调用的方法也是将url解析之后调用performTarget完成的;还有那个releaseCached方法只是移除那个缓存字典里面对应的数据,需要自己手动调用,时机很难把握,这也是这个框架做的不太好的地方,提供了缓存却没有实现内存管理的逻辑😢

由于我的项目是swift项目,我上面也说了CTMediator没有实现内存管理逻辑,所以我使用swift实现了一个使用LRU(最近最少使用原则)自动管理内存的解耦工具,调用方法也使用swift的语言特性进行了一些优化,使用更加简单,👉# AAMediator,这个工具完全和CTMediator兼容,正在使用CTMediator并且使用swift的同学可以尝试一下我这个工具,pod可以直接集成,代码也很简单易懂,大家可以去读一下源码,欢迎大家提出问题和交流👏

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

推荐阅读更多精彩内容

  • 获取CTMediator单例对象 远程App调用入口 本地组件调用入口 注意:想要调用此方法,你的类必须是Targ...
    iOS扫地僧阅读 2,149评论 0 2
  • Swift1> Swift和OC的区别1.1> Swift没有地址/指针的概念1.2> 泛型1.3> 类型严谨 对...
    cosWriter阅读 11,089评论 1 32
  • 毕业意味着失业。江小南行走在老家云淡的马路上,夏天灼热的阳光烘烤着这个中国东南沿海小城的马路。云淡,名字好听,风景...
    晓兰sally阅读 240评论 0 1
  • 今天,参加棠景街组织的环境综合治理代表、委员的集中视察。一年来三次视察,亲身感受到了棠景街环境的改善:哪怕内街里巷...
    羽衣甘蓝1971阅读 431评论 0 0
  • 晚霞没有说再见偷偷地藏在了那排银杏树后生气的他,骑着辆女士自行车,行驶在人行道上,晃着车头,画着S型。 不一会儿,...
    子凌阅读 184评论 0 2