iOS-底層原理 21：Method-Swizzling 方法交換

iOS 底層原理文章彙總

method-swizzling 是什麼？

method-swizzling 的含義是 方法交換 ，其主要作用是 在運作時将一個方法的實作替換成另一個方法的實作 ，這就是我們常說的 iOS黑魔法 ，
在OC中就是 利用method-swizzling實作AOP ，其中 AOP (Aspect Oriented Programming，面向切面程式設計)是一種程式設計的思想，差別于 OOP（面向對象程式設計）
- OOP和AOP都是一種程式設計的思想ios_lowLevel
- OOP 程式設計思想更加 傾向于對業務子產品的封裝 ，劃分出更加清晰的邏輯單元；
- 而 AOP 是 面向切面進行提取封裝，提取各個子產品中的公共部分，提高子產品的複用率，降低業務之間的耦合性 。
每個類都維護着一個 方法清單 ，即 methodList ， methodList 中有不同的 方法 即 Method ，每個方法中包含了方法的 sel 和 IMP ，方法交換就是 将sel和imp原本的對應斷開，并将sel和新的IMP生成對應關系

如下圖所示，交換前後的sel和IMP的對應關系

iOS-底層原理 21：Method-Swizzling 方法交換

method-swizzling涉及的相關API

通過 sel 擷取方法 Method
- class_getInstanceMethod ：擷取執行個體方法
- class_getClassMethod ：擷取類方法
method_getImplementation ：擷取一個方法的實作
method_setImplementation ：設定一個方法的實作
method_getTypeEncoding ：擷取方法實作的編碼類型
class_addMethod ：添加方法實作
class_replaceMethod ：用一個方法的實作，替換另一個方法的實作，即 aIMP 指向 bIMP ，但是bIMP不一定指向aIMP
method_exchangeImplementations ：交換兩個方法的實作，即 aIMP -> bIMP, bIMP -> aIMP

坑點1：method-swizzling使用過程中的一次性問題

所謂的一次性就是：

mehod-swizzling

寫在

load

方法中，而

load

方法會

主動調用多次

，這樣會

導緻方法的重複交換

，使方法sel的指向又恢複成原來的imp的問題

解決方案

可以通過

單例設計

原則，使方法交換

隻執行一次

，在OC中可以通過

dispatch_once

實作單例

+ (void)load{
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        [LGRuntimeTool lg_bestMethodSwizzlingWithClass:self oriSEL:@selector(helloword) swizzledSEL:@selector(lg_studentInstanceMethod)];
    });
}

坑點2：子類沒有實作，父類實作了

在下面這段代碼中，

LGPerson

中實作了

personInstanceMethod

，而

LGStudent

繼承自

LGPerson

，沒有實作

personInstanceMethod

，運作下面這段代碼會出現什麼問題？

//*********LGPerson類*********
@interface LGPerson : NSObject
- (void)personInstanceMethod;
@end

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

//*********LGStudent類*********
@interface LGStudent : LGPerson
- (void)helloword;
+ (void)sayHello;
@end

@implementation LGStudent
@end

//*********調用*********
- (void)viewDidLoad {
    [super viewDidLoad];

    // 黑魔法坑點二: 子類沒有實作 - 父類實作
    LGStudent *s = [[LGStudent alloc] init];
    [s personInstanceMethod];
    
    LGPerson *p = [[LGPerson alloc] init];
    [p personInstanceMethod];
}

其中，方法交換代碼如下，是通過

LGStudent

的分類

LG

實作

@implementation LGStudent (LG)

+ (void)load{
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        [LGRuntimeTool lg_methodSwizzlingWithClass:self oriSEL:@selector(personInstanceMethod) swizzledSEL:@selector(lg_studentInstanceMethod)];
    });
}

// personInstanceMethod 我需要父類的這個方法的一些東西
// 給你加一個personInstanceMethod 方法
// imp

- (void)lg_studentInstanceMethod{
    是否會産生遞歸？--不會産生遞歸，原因是lg_studentInstanceMethod 會走 oriIMP，即personInstanceMethod的實作中去
    [self lg_studentInstanceMethod];
    NSLog(@"LGStudent分類添加的lg對象方法:%s",__func__);
}

@end

下面是封裝好的

method-swizzling

方法

@implementation LGRuntimeTool
+ (void)lg_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);
}

通過實際代碼的調試，發現會在p調用

personInstanceMethod

方法時崩潰，下面來進行詳細說明

iOS-底層原理 21：Method-Swizzling 方法交換

[s personInstanceMethod]; 中不報錯是因為 student 中的 imp 交換成了 lg_studentInstanceMethod ，而 LGStudent 中有這個方法（在LG分類中），是以不會報錯
崩潰的點在于 [p personInstanceMethod]; ，其本質原因： LGStudent 的分類 LG 中進行了 方法交換 ，将 person 中 imp 交換成了 LGStudent 中的 lg_studentInstanceMethod ，然後需要去 LGPerson 中的找 lg_studentInstanceMethod ，但是 LGPerson 中沒有 lg_studentInstanceMethod 方法，即 相關的imp找不到 ，是以就崩潰了

優化：避免imp找不到

通過

class_addMethod

嘗試添加你要交換的方法

如果 添加成功 ，即類中沒有這個方法，則通過 class_replaceMethod 進行 替換 ，其内部會調用 class_addMethod 進行添加
如果添加不成功，即類中有這個方法，則通過 method_exchangeImplementations 進行 交換

+ (void)lg_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 

    BOOL success = class_addMethod(cls, oriSEL, method_getImplementation(swiMethod), method_getTypeEncoding(oriMethod));

    if (success) {// 自己沒有 - 交換 - 沒有父類進行處理 (重寫一個)
        class_replaceMethod(cls, swizzledSEL, method_getImplementation(oriMethod), method_getTypeEncoding(oriMethod));
    }else{ // 自己有
        method_exchangeImplementations(oriMethod, swiMethod);
    }   
}

下面是

class_replaceMethod

、

class_addMethod

和

method_exchangeImplementations

的源碼實作

iOS-底層原理 21：Method-Swizzling 方法交換

其中

class_replaceMethod

和

class_addMethod

中都調用了

addMethod

方法，差別在于bool值的判斷，下面是

addMethod

的源碼實作

iOS-底層原理 21：Method-Swizzling 方法交換

坑點3：子類沒有實作，父類也沒有實作，下面的調用有什麼問題？

在調用

personInstanceMethod

方法時，父類LGPerson中隻有聲明，沒有實作，子類LGStudent中既沒有聲明，也沒有實作

//*********LGPerson類*********
@interface LGPerson : NSObject
- (void)personInstanceMethod;
@end

@implementation LGPerson
@end

//*********LGStudent類*********
@interface LGStudent : LGPerson
- (void)helloword;
+ (void)sayHello;
@end

@implementation LGStudent
@end

//*********調用*********
- (void)viewDidLoad {
    [super viewDidLoad];

    // 黑魔法坑點二: 子類沒有實作 - 父類實作
    LGStudent *s = [[LGStudent alloc] init];
    [s personInstanceMethod];
    
    LGPerson *p = [[LGPerson alloc] init];
    [p personInstanceMethod];
}

經過調試，發現運作代碼會崩潰，報錯結果如下所示

iOS-底層原理 21：Method-Swizzling 方法交換

原因是

棧溢出

，

遞歸死循環

了，那麼為什麼會發生遞歸呢？----主要是因為

personInstanceMethod

沒有實作，然後在方法交換時，始終都找不到oriMethod，然後交換了寂寞，即交換失敗，當我們調用

personInstanceMethod（oriMethod）

時，也就是

oriMethod

會進入LG中

lg_studentInstanceMethod

方法，然後這個方法中又調用了

lg_studentInstanceMethod

，此時的

lg_studentInstanceMethod

并沒有指向

oriMethod

，然後導緻了

自己調自己

，即遞歸死循環

優化：避免遞歸死循環

如果 oriMethod 為空，為了避免方法交換沒有意義，而被廢棄，需要做一些事情
- 通過 class_addMethod 給 oriSEL 添加 swiMethod 方法
- 通過 method_setImplementation 将 swiMethod 的 IMP 指向 不做任何事的空實作

+ (void)lg_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) {
        // 在oriMethod為nil時，替換後将swizzledSEL複制一個不做任何事的空實作,代碼如下:
        class_addMethod(cls, oriSEL, method_getImplementation(swiMethod), method_getTypeEncoding(swiMethod));
        method_setImplementation(swiMethod, imp_implementationWithBlock(^(id self, SEL _cmd){ }));
    }
    
    // 一般交換方法: 交換自己有的方法 -- 走下面 因為自己有意味添加方法失敗
    // 交換自己沒有實作的方法:
    //   首先第一步:會先嘗試給自己添加要交換的方法 :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);
    }
    
}

method-swizzling - 類方法

類方法和執行個體方法的method-swizzling的原理是類似的，唯一的差別是類方法存在元類中，是以可以做如下操作

LGStudent 中隻有類方法 sayHello 的聲明，沒有實作

@interface LGStudent : LGPerson
- (void)helloword;
+ (void)sayHello;
@end

@implementation LGStudent

@end

在LGStudent的分類的load方法中實作類方法的方法交換

+ (void)load{
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
         [LGRuntimeTool lg_bestClassMethodSwizzlingWithClass:self oriSEL:@selector(sayHello) swizzledSEL:@selector(lg_studentClassMethod)];
    });
}
+ (void)lg_studentClassMethod{
    NSLog(@"LGStudent分類添加的lg類方法:%s",__func__);
   [[self class] lg_studentClassMethod];
}

封裝的 類方法的方法交換 如下
- 需要通過 class_getClassMethod 方法 擷取類方法
- 在調用 class_addMethod 和 class_replaceMethod 方法添加和替換時，需要傳入的類是 元類 ，元類可以通過 object_getClass 方法擷取類的元類

//封裝的method-swizzling方法
+ (void)lg_bestClassMethodSwizzlingWithClass:(Class)cls oriSEL:(SEL)oriSEL swizzledSEL:(SEL)swizzledSEL{
    
    if (!cls) NSLog(@"傳入的交換類不能為空");

    Method oriMethod = class_getClassMethod([cls class], oriSEL);
    Method swiMethod = class_getClassMethod([cls class], swizzledSEL);
    
    if (!oriMethod) { // 避免動作沒有意義
        // 在oriMethod為nil時，替換後将swizzledSEL複制一個不做任何事的空實作,代碼如下:
        class_addMethod(object_getClass(cls), oriSEL, method_getImplementation(swiMethod), method_getTypeEncoding(swiMethod));
        method_setImplementation(swiMethod, imp_implementationWithBlock(^(id self, SEL _cmd){
            NSLog(@"來了一個空的 imp");
        }));
    }
    
    // 一般交換方法: 交換自己有的方法 -- 走下面 因為自己有意味添加方法失敗
    // 交換自己沒有實作的方法:
    //   首先第一步:會先嘗試給自己添加要交換的方法 :personInstanceMethod (SEL) -> swiMethod(IMP)
    //   然後再将父類的IMP給swizzle  personInstanceMethod(imp) -> swizzledSEL
    //oriSEL:personInstanceMethod

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

調用如下

- (void)viewDidLoad {
    [super viewDidLoad];
    
    [LGStudent sayHello];
}

運作結果如下，由于符合 方法沒有實作 ，是以會走到 空的imp 中

iOS-底層原理 21：Method-Swizzling 方法交換

method-swizzling的應用

method-swizzling最常用的應用是

防止數組、字典等越界崩潰

在iOS中

NSNumber

、

NSArray

、

NSDictionary

等這些類都是類簇，一個

NSArray

的實作可能

由多個類組成

。是以如果想對NSArray進行Swizzling，

必須擷取到其“真身”進行Swizzling，直接對NSArray進行操作是無效的

。

下面列舉了NSArray和NSDictionary本類的類名，可以通過Runtime函數取出本類。

類名	真身
NSArray	__NSArrayI
NSMutableArray	__NSArrayM
NSDictionary	__NSDictionaryI
NSMutableDictionary	__NSDictionaryM

以 NSArray 為例

建立NSArray的一個分類 CJLArray

@implementation NSArray (CJLArray)
//如果下面代碼不起作用，造成這個問題的原因大多都是其調用了super load方法。在下面的load方法中，不應該調用父類的load方法。這樣會導緻方法交換無效
+ (void)load{
    Method fromMethod = class_getInstanceMethod(objc_getClass("__NSArrayI"), @selector(objectAtIndex:));
    Method toMethod = class_getInstanceMethod(objc_getClass("__NSArrayI"), @selector(cjl_objectAtIndex:));
    
    method_exchangeImplementations(fromMethod, toMethod);
}

//如果下面代碼不起作用，造成這個問題的原因大多都是其調用了super load方法。在下面的load方法中，不應該調用父類的load方法。這樣會導緻方法交換無效
- (id)cjl_objectAtIndex:(NSUInteger)index{
    //判斷下标是否越界，如果越界就進入異常攔截
    if (self.count-1 < index) {
        // 這裡做一下異常處理，不然都不知道出錯了。
#ifdef DEBUG  // 調試階段
        return [self cjl_objectAtIndex:index];
#else // 釋出階段
        @try {
            return [self cjl_objectAtIndex:index];
        } @catch (NSException *exception) {
            // 在崩潰後會列印崩潰資訊，友善我們調試。
            NSLog(@"---------- %s Crash Because Method %s  ----------\n", class_getName(self.class), __func__);
            NSLog(@"%@", [exception callStackSymbols]);
            return nil;
        } @finally {
            
        }
#endif
    }else{ // 如果沒有問題，則正常進行方法調用
        return [self cjl_objectAtIndex:index];
    }
}

@end

測試代碼

NSArray *array = @[@"1", @"2", @"3"];
[array objectAtIndex:3];

列印結果如下，會輸出崩潰的日志，但是實際并不會崩潰

iOS-底層原理 21：Method-Swizzling 方法交換

iOS-底層原理 21：Method-Swizzling 方法交換

method-swizzling 是什麼？

method-swizzling涉及的相關API

坑點1：method-swizzling使用過程中的一次性問題

坑點2：子類沒有實作，父類實作了

坑點3：子類沒有實作，父類也沒有實作，下面的調用有什麼問題？

method-swizzling - 類方法

method-swizzling的應用

繼續閱讀

吃透MVC，馴服爛代碼吃透MVC，馴服爛代碼

PAT (Advanced Level) Practise 1083 List Grades (25)

PAT (Advanced Level) Practise 1135 Is It A Red-Black Tree (30)

UVA 348 Optimal Array Multiplication Sequence

PAT (Advanced Level) Practise 1066 Root of AVL Tree (25)

CSU 1806 Toll

CodeChef PALPROB Palindromeness

ZOJ 1032 Area 2

UVA 590 Always on the run

FZU 1978 Repair the brackets

UVA 10344- 23 out of 5

POJ 2115 C Looooops

ZOJ 3700 Ever Dream

UVA 620 Cellular Structure

swift資料合集

蘋果稽核 Guideline 2.1 - Information Needed