iOS Method Swizzle的秘密

什么是Method Swizzling

方法交换(Method Swizzling),顾名思义就是将两个方法的实现交换,即由原来的SEL(A)-IMP(A)、SEL(B)-IMP(B)对应关系变成了SEL(A)-IMP(B)、SEL(B)-IMP(A),如下图:

方法替换Befor和After.png

Method类型

Method类型是一个objc_method结构体指针,而结构体objc_method有三个成员,方法交换(Method Swizzling)的本质就是更改两个成员method_typesmethod_imp

runtime.h源码

/// An opaque type that represents a method in a class definition.
typedef struct objc_method *Method; // 本质是一个结构体

struct objc_method {
    SEL method_name;        // 方法名称
    char *method_types;    // 参数和返回类型的描述字串
    IMP method_imp;         // 方法的具体的实现的指针
}

Method Swizzling 实现方式

比如我们有一个控制器ParentViewController继承于UIViewController,子控制器SubViewController继承于ParentViewController。我们想替换SubViewControllerviewDidAppearswizzle_viewDidAppear, 运行后先显示ParentViewController页面,然后点击一个Button按钮,push到SubViewController页面,代码如下:(页面都是通过StoryBoard来构建的,请自行构建,我比较懒,这里就只贴上代码)


@interface ParentViewController : UIViewController
@end

@implementation ParentViewController
- (void)viewDidAppear:(BOOL)animated{
    NSLog(@"%@ %s (IMP = ParentViewController viewDidAppear)",self, _cmd);
    [super viewDidAppear:animated];
}
@end


@interface SubViewController : ParentViewController
@end

@implementation SubViewController
+ (void)load {
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        Class class = [self class];
        
        // 原方法名和替换方法名
        SEL originalSelector = @selector(viewDidAppear:);
        SEL swizzledSelector = @selector(swizzle_viewDidAppear:);
        
        // 原方法结构体和替换方法结构体
        Method originalMethod = class_getInstanceMethod(class, originalSelector);
        Method swizzledMethod = class_getInstanceMethod(class, swizzledSelector);
        
        // 如果当前类没有原方法的实现IMP,先调用class_addMethod来给原方法添加默认的方法实现IMP
        BOOL didAddMethod = class_addMethod(class,
                                            originalSelector,
                                            method_getImplementation(swizzledMethod),
                                            method_getTypeEncoding(swizzledMethod));
        
        if (didAddMethod) {// 添加方法实现IMP成功后,修改替换方法结构体内的方法实现IMP和方法类型编码TypeEncoding
            class_replaceMethod(class,
                                swizzledSelector,
                                method_getImplementation(originalMethod),
                                method_getTypeEncoding(originalMethod));
        } else { // 添加失败,调用交互两个方法的实现
            method_exchangeImplementations(originalMethod, swizzledMethod);
        }
    });
}

- (void)swizzle_viewDidAppear:(BOOL)animated {
    NSLog(@"%@ %s (IMP = SubViewController swizzle_viewDidAppear)",self, _cmd);
    [self swizzle_viewDidAppear:animated];
}
@end

代码说明:

dispatch_once 保证方法替换只被执行一次

为什么要先调用类添加方法class_addMethod,然后判断添加失败后,再调用方法交换实现方法method_exchangeImplementations

上面代码中SubViewController是没有Override父类的viewDidAppear。如果我们直接调用method_exchangeImplementations会怎么样? 在这种情况下,我们试试

+ (void)load {
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        Class class = [self class];
        
        // 原方法名和替换方法名
        SEL originalSelector = @selector(viewDidAppear:);
        SEL swizzledSelector = @selector(swizzle_viewDidAppear:);
        
        // 原方法结构体和替换方法结构体
        Method originalMethod = class_getInstanceMethod(class, originalSelector);
        Method swizzledMethod = class_getInstanceMethod(class, swizzledSelector);
        
        // 调用交互两个方法的实现
        method_exchangeImplementations(originalMethod, swizzledMethod);
    });
}

改成上面的代码,然后运行。哎哟,出错了!Let me see see 什么情况

2018-05-07 21:38:56.615884+0800 TestiOS[3469:385923] <ParentViewController: 0x7f8f38c09aa0> viewDidAppear: (IMP = SubViewController swizzle_viewDidAppear)
2018-05-07 21:38:56.616189+0800 TestiOS[3469:385923] -[ParentViewController swizzle_viewDidAppear:]: unrecognized selector sent to instance 0x7f8f38c09aa0
2018-05-07 21:38:56.621157+0800 TestiOS[3469:385923] *** Terminating app due to uncaught exception 'NSInvalidArgumentException', reason: '-[ParentViewController swizzle_viewDidAppear:]: unrecognized selector sent to instance 0x7f8f38c09aa0'
*** First throw call stack:
(
    0   CoreFoundation                      0x000000010e0fd1e6 __exceptionPreprocess + 294
    1   libobjc.A.dylib                     0x000000010d792031 objc_exception_throw + 48
    2   CoreFoundation                      0x000000010e17e784 -[NSObject(NSObject) doesNotRecognizeSelector:] + 132
    3   UIKit                               0x000000010e7a873b -[UIResponder doesNotRecognizeSelector:] + 295
    4   CoreFoundation                      0x000000010e07f898 ___forwarding___ + 1432
    5   CoreFoundation                      0x000000010e07f278 _CF_forwarding_prep_0 + 120
    6   TestiOS                             0x000000010ce903fb -[SubViewController swizzle_viewDidAppear:] + 75
    7   UIKit                               0x000000010e723ebf -[UIViewController _setViewAppearState:isAnimating:] + 697
    8   UIKit                               0x000000010e75ac53 -[UINavigationController viewDidAppear:] + 187
    9   UIKit                               0x000000010e723ebf -[UIViewController _setViewAppearState:isAnimating:] + 697
    10  UIKit                               0x000000010e726cfb __64-[UIViewController viewDidMoveToWindow:shouldAppearOrDisappear:]_block_invoke + 42
    11  UIKit                               0x000000010e72503f -[UIViewController _executeAfterAppearanceBlock] + 78
    12  UIKit                               0x000000010e58564f _runAfterCACommitDeferredBlocks + 634
    13  UIKit                               0x000000010e57477e _cleanUpAfterCAFlushAndRunDeferredBlocks + 388
    14  UIKit                               0x000000010e5942d7 __34-[UIApplication _firstCommitBlock]_block_invoke_2 + 155
    15  CoreFoundation                      0x000000010e09fb0c __CFRUNLOOP_IS_CALLING_OUT_TO_A_BLOCK__ + 12
    16  CoreFoundation                      0x000000010e0842db __CFRunLoopDoBlocks + 331
    17  CoreFoundation                      0x000000010e083a84 __CFRunLoopRun + 1284
    18  CoreFoundation                      0x000000010e08330b CFRunLoopRunSpecific + 635
    19  GraphicsServices                    0x0000000113267a73 GSEventRunModal + 62
    20  UIKit                               0x000000010e57a0b7 UIApplicationMain + 159
    21  TestiOS                             0x000000010ce9047f main + 111
    22  libdyld.dylib                       0x0000000111b56955 start + 1
)

控制台打印ParentViewController找不到swizzle_viewDidAppear方法。 这是为什么呢?

第一行日志显示,ParentViewController是调用自己的方法viewDidAppear,通过打印_cmd输出为viewDidAppear可知道,但是执行的是SubViewControllerswizzle_viewDidAppear的方法实现IMP,在swizzle_viewDidAppear方法实现IMP里又调用了[self swizzle_viewDidAppear:animated]这行代码,但是此时self是ParentViewController实例对象,类方法列表里根本没有swizzle_viewDidAppear方法,所以就导致找不到方法错误。说的我都觉得挺绕口的,千言万语不如一张图来的直观,向下瞅:

子类方法替换1.png

现在明白了吧,方法交换(Method Swizzling)在子类没有实现viewDidAppear方法的情况下会交换父类的viewDidAppear的实现IMP,所以在swizzle_viewDidAppear实现IMP中调用swizzle_viewDidAppear方法会触发doesNotRecognizeSelector找不到方法错误


如果我们的子类SubViewController重写Override了父类的viewDidAppear方法会怎么样?
我们在SubViewController中重写viewDidAppear方法

+ (void)load {
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        Class class = [self class];
        
        // 原方法名和替换方法名
        SEL originalSelector = @selector(viewDidAppear:);
        SEL swizzledSelector = @selector(swizzle_viewDidAppear:);
        
        // 原方法结构体和替换方法结构体
        Method originalMethod = class_getInstanceMethod(class, originalSelector);
        Method swizzledMethod = class_getInstanceMethod(class, swizzledSelector);
        
        // 调用交互两个方法的实现
        method_exchangeImplementations(originalMethod, swizzledMethod);
    });
}

- (void)viewDidAppear:(BOOL)animated{
    NSLog(@"%@ %s (IMP = SubViewController viewDidAppear)",self, _cmd);
    [super viewDidAppear:animated];
}

- (void)swizzle_viewDidAppear:(BOOL)animated {
    NSLog(@"%@ %s (IMP = SubViewController swizzle_viewDidAppear)",self, _cmd);
    [self swizzle_viewDidAppear:animated];
}

改成上面的代码,然后运行。这次竟然成功了

2018-05-07 21:41:58.467190+0800 TestiOS[3556:400520] <ParentViewController: 0x7fd5a060b730> viewWillAppear
2018-05-07 21:41:58.475185+0800 TestiOS[3556:400520] <ParentViewController: 0x7fd5a060b730> viewDidAppear: (IMP = ParentViewController viewDidAppear)
2018-05-07 21:42:08.772307+0800 TestiOS[3556:400520] <SubViewController: 0x7fd5a0405170> viewWillAppear
2018-05-07 21:42:09.312426+0800 TestiOS[3556:400520] <SubViewController: 0x7fd5a0405170> viewDidAppear: (IMP = SubViewController swizzle_viewDidAppear)
2018-05-07 21:42:09.312643+0800 TestiOS[3556:400520] <SubViewController: 0x7fd5a0405170> swizzle_viewDidAppear: (IMP = SubViewController viewDidAppear)
2018-05-07 21:42:09.312792+0800 TestiOS[3556:400520] <SubViewController: 0x7fd5a0405170> viewDidAppear: (IMP = ParentViewController viewDidAppear)

你逗我玩儿呢,怎么子类实现viewDidAppear就好了。那是因为子类在检查到自己有viewDidAppear方法就直接交换自己的viewDidAppear方法实现IMP,直接上图,我不想废话了

子类方法替换2.png

这下我们明白了,如果直接调用方法method_exchangeImplementations来交换方法,需要考虑到子类有没有相应的方法,如果没有就要特殊处理,那岂不是太麻烦了。哈哈😁不用你瞎操心,苹果有这个方法class_addMethod来帮助我们解决


我们把直接调用method_exchangeImplementations稍微做点修改

+ (void)load {
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        Class class = [self class];
        
        // 原方法名和替换方法名
        SEL originalSelector = @selector(viewDidAppear:);
        SEL swizzledSelector = @selector(swizzle_viewDidAppear:);
        
        // 原方法结构体和替换方法结构体
        Method originalMethod = class_getInstanceMethod(class, originalSelector);
        Method swizzledMethod = class_getInstanceMethod(class, swizzledSelector);
        
        // 如果当前类没有原方法的实现IMP,先调用class_addMethod来给原方法添加默认的方法实现IMP
        BOOL didAddMethod = class_addMethod(class,
                                            originalSelector,
                                            method_getImplementation(swizzledMethod),
                                            method_getTypeEncoding(swizzledMethod));
        
        if (didAddMethod) {// 添加方法实现IMP成功后,修改替换方法结构体内的方法实现IMP和方法类型编码TypeEncoding
            class_replaceMethod(class,
                                swizzledSelector,
                                method_getImplementation(originalMethod),
                                method_getTypeEncoding(originalMethod));
        } else { // 添加失败,调用交互两个方法的实现
            method_exchangeImplementations(originalMethod, swizzledMethod);
        }
    });
}

这样我们就不用关心子类有没有实现viewDidAppear方法,方法class_addMethod在子类没有实现viewDidAppear方法的时候,为其添加swizzle_viewDidAppear方法实现IMP,原方法swizzle_viewDidAppear指向父类的viewDidAppear方法实现IMP

子类方法替换3.png

这就是为什么先要调用class_addMethod方法的原因了,如果子类SubViewController实现了方法viewDidAppear,那么class_addMethod方法会返回NO,意思子类存在viewDidAppear方法实现,就直接走method_exchangeImplementations方法交换

好了,就说到这里吧,有问题请留言

参考:

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

推荐阅读更多精彩内容