筆記-method-swizzling～那些年，一塊兒遇過的坑

時間  2019-12-05
標籤 筆記 method swizzling 那些年 一塊兒 简体版
原文   原文鏈接

什麼是method-swizzling？

method-swizzling俗稱黑魔法，在前幾篇文章中說過，在OC中調用一個方法，其實就是向一個對象發送消息，而查找消息的惟一依據是selector的名字，經過名字查找到IMP。利用OC的動態特性，能夠實如今運行時偷換selector對應的方法實現，達到方法實現交換的效果。程序員

能夠經過下圖去理解 數組

在什麼地方進行方法交換，爲何？

+load方法裏，緣由有三：（後面文章裏會具體分析這個+load方法）bash

  • 執行比較早，在main函數以前調用
  • 自動執行，不須要手動執行
  • 惟一性，不用擔憂被子類覆蓋

坑一：找不到真正的方法歸屬

數組越界，是開發中最多見的一個錯誤，看下面代碼函數

- (void)viewDidLoad {
    [super viewDidLoad];
    self.dataArray = @[@"AA",@"BB",@"CC",@"DD"];
    NSLog(@"%@",self.dataArray[4]);
}
複製代碼

這段代碼執行結果，相信我不用說了，奔潰，以下圖（其實都不用給圖的。。。） 優化

其實能夠利用這個黑魔法，去規避App的奔潰，同時能夠打印出奔潰的類的所在代碼的行數，下面就用這個機制，阻止它的奔潰，代碼以下ui

@implementation ZBRuntimeTool
+ (void)zb_methodSwizzlingWithClass:(Class)cls oriSEL:(SEL)oriSEL swizzledSEL:(SEL)swizzledSEL {
    if (!cls) NSLog(@"傳入的交換類不能爲空");
    Method oriMethod = class_getInstanceMethod(cls, oriSEL);
    Method swiMethod = class_getInstanceMethod(cls, swizzledSEL);
    method_exchangeImplementations(oriMethod, swiMethod);
}
@end

// 分類中
@implementation NSArray (ZB)
+ (void)load {
    [ZBRuntimeTool zb_methodSwizzlingWithClass:self oriSEL:@selector(objectAtIndex:) swizzledSEL:@selector(zb_objectAtIndex:)];
}

- (id)zb_objectAtIndex:(NSUInteger)index {
    if (index > self.count-1) {
        NSLog(@"取值越界了,請記錄 : %lu > %lu",(unsigned long)index,self.count-1);
        return nil;
    }
    return [self zb_objectAtIndex:index];
}
@end
複製代碼

搞定，是否是感受很簡單，編譯運行看打印效果，一頓操做猛如虎，結果發現運行仍是奔潰😅，其實這就是在上面我爲何要給出奔潰的截圖，細心的小夥伴可能已經知道來緣由，上面代碼的錯誤有兩處：
第一就是方法的歸屬，咱們寫的是self，指的是NSArray，可是經過它報錯的結果能夠知道應該是__NSArrayI，它是一個族類，這個必定要分清；
第二是咱們交換的方法錯誤，一樣仍是能夠經過上面的截圖能夠看得出來，咱們應該交換objectAtIndexedSubscript:方法spa

最終代碼以下：設計

@implementation NSArray (ZB)
+ (void)load {
    [ZBRuntimeTool zb_methodSwizzlingWithClass:objc_getClass("__NSArrayI") oriSEL:@selector(objectAtIndexedSubscript:) swizzledSEL:@selector(zb_objectAtIndexedSubscript:)];
}

- (id)zb_objectAtIndexedSubscript:(NSUInteger)index {
    if (index > self.count-1) {
        NSLog(@"取值越界了,請記錄 : %lu > %lu",(unsigned long)index,self.count-1);
        return nil;
    }
    return [self zb_objectAtIndexedSubscript:index];
}
@end
複製代碼

這段代碼能夠解決上面所遇到的問題，可是很明顯，這樣的代碼漏洞百出，一個優秀的程序員不該該寫到這裏就中止的，後面篇章中，會持續優化它。3d

坑二：可能會主動調用load方法

還能夠拿上面的例子來講事，下面代碼中的調用code

- (void)viewDidLoad {
    [super viewDidLoad];
    self.dataArray = @[@"AA",@"BB",@"CC",@"DD"];
    [NSArray load];
    NSLog(@"%@",self.dataArray[4]);
}
複製代碼

運行結果和上面的結果一摸同樣，直接奔潰，並且報錯信息都是同樣的，應該可以想到緣由，兩次的交換，使得它們都指向了原來的IMP，因此爲了防止這種屢次調用的狀況，咱們能夠經過讓它只運行一次來解決這個問題，代碼以下：

+ (void)load {
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        [ZBRuntimeTool zb_methodSwizzlingWithClass:objc_getClass("__NSArrayI") oriSEL:@selector(objectAtIndexedSubscript:) swizzledSEL:@selector(zb_objectAtIndexedSubscript:)];
    });
}
複製代碼

對的，沒有錯，利用單例的方式去解決上面的這個問題。

坑三：子類沒有實現父類的方法，子類交換了父類的方法

下看看下面代碼

// Person類
@interface ZBPerson : NSObject
- (void)personInstanceMethod;
@end

@implementation ZBPerson
- (void)personInstanceMethod {
    NSLog(@"person對象方法:%s",__func__);
}
@end

// Student類
@interface ZBStudent : ZBPerson
- (void)helloWorld;
+ (void)helloWorld1;
                // 沒有實現父類ZBPerson的方法
@end

// 調用
- (void)viewDidLoad {
    [super viewDidLoad];
    ZBStudent *s = [[ZBStudent alloc] init];
    [s personInstanceMethod];

    ZBPerson *p = [[ZBPerson alloc] init];
    [p personInstanceMethod];
}
複製代碼

上面代碼中有兩個類，ZBPerson、ZBStudent，其中ZBStudent是繼承於ZBPerson，也沒有實現ZBPerson中的方法personInstanceMethod。

下面進行方法交換

@implementation ZBStudent (ZB)
+ (void)load {
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        [ZBRuntimeTool zb_betterMethodSwizzlingWithClass:self oriSEL:@selector(personInstanceMethod) swizzledSEL:@selector(zb_studentInstanceMethod)];
    });
}

- (void)zb_studentInstanceMethod{
    NSLog(@"ZBStudent分類添加的zb對象方法:%s",__func__);
    [self zb_studentInstanceMethod];
}
@end
複製代碼

若是ZBRuntimeTool類裏面的方法交換仍是和上面寫的同樣的話，運行結果確定是奔潰的，這裏就不過多描述這個錯誤，下面是優化過的代碼

+ (void)zb_betterMethodSwizzlingWithClass:(Class)cls oriSEL:(SEL)oriSEL swizzledSEL:(SEL)swizzledSEL{
    
    if (!cls) NSLog(@"傳入的交換類不能爲空");
    
    Method oriMethod = class_getInstanceMethod(cls, oriSEL);
    Method swiMethod = class_getInstanceMethod(cls, swizzledSEL);
    // 通常交換方法: 交換本身有的方法 -- 走下面 由於本身有意味添加方法失敗
    // 交換本身沒有實現的方法:
    //   首先第一步:會先嚐試給本身添加要交換的方法 :personInstanceMethod (SEL) -> swiMethod(IMP)
    //   而後再將父類的IMP給swizzle  personInstanceMethod(imp) -> swizzledSEL 
    //oriSEL:personInstanceMethod
    BOOL didAddMethod = class_addMethod(cls, oriSEL, method_getImplementation(swiMethod), method_getTypeEncoding(swiMethod));
    if (didAddMethod) {
        class_replaceMethod(cls, swizzledSEL, method_getImplementation(oriMethod), method_getTypeEncoding(oriMethod));
    }else{
        method_exchangeImplementations(oriMethod, swiMethod);
    }
}
複製代碼

這段代碼比以前的多了幾步操做，第一步會先嚐試給本身添加要交換的方法，若是添加成功，說明本類中沒有實現這個方法，那麼就直接添加一個swiMethod的IMP，而後經過方法class_replaceMethod進行替換；若是添加失敗，說明類中存在了這個方法的IMP，那麼能夠直接利用method_exchangeImplementations方法進行交換。

坑四：交換根本沒有實現的方法

顧名思義就是說交換的方法，不只本類未實現，其父類中也沒有實現，一樣能夠拿上面例子提及，ZBStudent類中的方法helloWorld，在其父類以及本類中，都沒有實現。

+ (void)load {
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        [ZBRuntimeTool zb_betterMethodSwizzlingWithClass:self oriSEL:@selector(helloWorld) swizzledSEL:@selector(zb_studentInstanceMethod)];
    });
}

- (void)zb_studentInstanceMethod{
    NSLog(@"ZBStudent分類添加的zb對象方法:%s",__func__);
    [self zb_studentInstanceMethod];
}
複製代碼

運行結果以下：

能夠看出，進入了遞歸。

思考一下，這裏爲何會進入遞歸的死循環呢？

分析： Method-Swizzling的原理就是進行消息IMP的交換，執行上面load方法後，先會把方法helloWorld的IMP指向zb_studentInstanceMethod(IMP)，而後把zb_studentInstanceMethod方法的IMP指向helloWorld(IMP)。注意了，這裏的helloWorld(IMP)爲空，意思是方法zb_studentInstanceMethod的IMP並無改變成功，仍是指向了本身的IMP，和方法helloWorld同樣。因此會一直調用方法zb_studentInstanceMethod，進入了死循環的遞歸。

優化代碼：

+ (void)zb_bestMethodSwizzlingWithClass:(Class)cls oriSEL:(SEL)oriSEL swizzledSEL:(SEL)swizzledSEL{
    if (!cls) NSLog(@"傳入的交換類不能爲空");
    Method oriMethod = class_getInstanceMethod(cls, oriSEL);
    Method swiMethod = class_getInstanceMethod(cls, swizzledSEL);
    if (!oriMethod) {
        class_addMethod(cls, oriSEL, method_getImplementation(swiMethod), method_getTypeEncoding(swiMethod));
        // IMP指向了一個空的block方法（空IMP）
        method_setImplementation(swiMethod, imp_implementationWithBlock(^(id self, SEL _cmd){ }));
    }

    BOOL didAddMethod = class_addMethod(cls, oriSEL, method_getImplementation(swiMethod), method_getTypeEncoding(swiMethod));
    if (didAddMethod) {
        class_replaceMethod(cls, swizzledSEL, method_getImplementation(oriMethod), method_getTypeEncoding(oriMethod));
    }else{
        method_exchangeImplementations(oriMethod, swiMethod);
    }
}
複製代碼

運行結果：

牛逼哦 老鐵們！！！

坑五：類方法--類方法存在元類中

其實類方法的method-swizzling和對象方法基本相似，可是有一個很大的區別，就是類方法存在元類中，代碼以下

@implementation ZBStudent (ZB)

+ (void)load{
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        [ZBRuntimeTool zb_bestMethodSwizzlingWithClass:self oriSEL:@selector(helloWorld1) swizzledSEL:@selector(zb_studentInstanceMethod1)];
    });
}

+ (void)zb_studentInstanceMethod1{
    NSLog(@"ZBStudent分類添加的zb對象方法:%s",__func__);
    [[self class] zb_studentInstanceMethod1];
}
@end

+ (void)zb_bestMethodSwizzlingWithClass:(Class)cls oriSEL:(SEL)oriSEL swizzledSEL:(SEL)swizzledSEL{
    
    if (!cls) NSLog(@"傳入的交換類不能爲空");
    Method swiCLassMethod = class_getClassMethod([cls class], swizzledSEL);
    Method oriClassMethod = class_getClassMethod([cls class], oriSEL);
    if (!oriClassMethod) {
        class_addMethod(object_getClass([cls class]), oriSEL, method_getImplementation(swiCLassMethod), method_getTypeEncoding(swiCLassMethod));
        method_setImplementation(swiCLassMethod, imp_implementationWithBlock(^(id self, SEL _cmd){ }));
    }

    BOOL didAddMethod = class_addMethod(object_getClass([cls class]), oriSEL, method_getImplementation(swiCLassMethod), method_getTypeEncoding(swiCLassMethod));
    if (didAddMethod) {
        class_replaceMethod(object_getClass([cls class]), swizzledSEL, method_getImplementation(oriClassMethod), method_getTypeEncoding(oriClassMethod));
    }else {
        method_exchangeImplementations(oriClassMethod, swiCLassMethod);
    }
}
複製代碼

代碼執行結果：

嗯，上面代碼中多處用到 object_getClass([cls class])，實際上這個就是元類，關於類方法的一些 IMP的交換都是在元類中進行的，由於 類方法存在元類中。

以上總結了一些關於Method-Swizzling的坑，固然確定不止這幾個。在平常開發中仍是慎用，不過真的很強大。上面的幾種模式下的代碼，值得細細閱讀，能夠增長對Method-Swizzling的理解，若有錯誤，但願指出，謝謝

若是對此很感興趣，能夠了解一下AOP切面設計的源碼實現

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程