在本文中鲁捏，我們將了解到如下內(nèi)容：

1. 類簇(cù)
2. 關(guān)于方法交換的幾個接口
3. 攔截易崩潰方法的方案

前言

在iOS的開發(fā)過程中，NSArray锰茉、NSDictionary设联、NSString等Foundation框架的一些類是我們非常常用的類型，同時這些類也為我們提供了很多非常好用且實用的接口(例如NSArray的objectAtIndex:方法)褥影。在我們享受著這些接口為我們提供的便利的同時池户，我們還需要承擔(dān)傳參錯誤導(dǎo)致崩潰的風(fēng)險(比如objectAtIndex:接口常出現(xiàn)的數(shù)組越界問題)。
本著規(guī)避類似問題并方便開發(fā)的目的凡怎，在本篇文章以NSArray為例校焦，將對這些易出現(xiàn)崩潰的接口進行攔截，并做安全處理统倒。

類簇

想要攔截一個類的某個方法寨典，我們會馬上想到方法交換(Method Swizzing)，因為方法交換真的很適合做這樣的工作房匆。但是當(dāng)我們嘗試對NSArray的方法進行交換時耸成，發(fā)現(xiàn)交換成功了但是根本沒有任何效果。這是因為為我們工作的真實類并不是NSArray浴鸿，而是NSArray的類簇井氢。
在Foundation中，NSArray其實是一個抽象類(一個只負(fù)責(zé)定義方法而不負(fù)責(zé)實現(xiàn)方法的類)岳链。真正實現(xiàn)了NSArray中定義的方法的其實是它的各個實現(xiàn)類花竞。
如果我們?yōu)?code>NSArray添加一個分類，并重寫initialize如下：

@implementation NSArray (HMXSafe)

+ (void)initialize {
    [super initialize];
    
    printf("class name is:%s \n", class_getName(self.class));
}

@end

會得到如下的打印結(jié)果：

class name is:NSArray 
class name is:NSMutableArray 
class name is:__NSPlaceholderArray 
class name is:__NSSingleObjectArrayI 
class name is:__NSArrayM 
class name is:__NSArray0 
class name is:__NSCFArray 
class name is:__NSArrayI 
class name is:__NSArrayI_Transfer 
class name is:__NSFrozenArrayM 
class name is:NSConstantArray 
class name is:CALayerArray 
class name is:__NSOrderedSetArrayProxy 

除了NSArray和NSMutableArray掸哑，其它的類我們有些見過约急，有些沒見過，但是這些類才是我們平時使用的真正的類举户。要證實這一點烤宙，我們可以在代碼中打斷點查看變量的類型躺枕，如下：

NSArray *arr0 = @[]; // __NSArray0
NSArray *arrSI = @[@"123"]; // __NSSingleObjectArrayI
NSArray *arrI = @[@"123", @"234", @"345"]; // __NSArrayI
NSArray *arrM = @[@"123"].mutableCopy; // __NSArrayM

正因為NSArray是以類簇的形式而存在的罢猪，所以我們只是交換NSArray的方法是沒有用的膳帕。
Foundation框架中還有很多其它的類簇薇缅，例如NSString泳桦、NSDictionary、NSNumber谒府、NSAttributedString，或者還有更多的類簇壳鹤，筆者沒有做詳細(xì)的統(tǒng)計蹦锋。
既然是類簇兆沙，那么是不是意味著方法交換的方式不能達(dá)成我們的需求了呢莉掂？并不是厘唾。本篇文章依然是使用方法交換來進行攔截的趟大。

關(guān)于方法交換的幾個接口

在說明實現(xiàn)方案之前，我們先對方法交換的幾個接口做一個清晰地了解逊朽。不感興趣的小伙伴可以直接跳過岛蚤，不影響對實現(xiàn)方案的理解灭美。

// 獲取cls的實例方法蜂奸。如果當(dāng)前類沒有，則會向上追溯到根類。
// 需要注意的是它并不僅僅是獲取常規(guī)意義上的實例方法，如果cls是元類則會獲取這個元類的類方法吃挑。
Method _Nullable class_getInstanceMethod(Class _Nullable cls, SEL _Nonnull name)

// 獲取cls的類方法钝荡。如果當(dāng)前類沒有，則會向上追溯到根類舶衬。
Method _Nullable class_getClassMethod(Class _Nullable cls, SEL _Nonnull name)

// 給cls新增方法埠通，需要提供結(jié)構(gòu)體的三個成員。
// 新增成功返回YES逛犹，否則返回NO(例如cls已經(jīng)存在了該方法)
BOOL class_addMethod(Class _Nullable cls, SEL _Nonnull name, IMP _Nonnull imp, const char * _Nullable types)

// 替換cls中的SEL為name的方法的實現(xiàn)為imp端辱。
// 如果name不存在則直接新增方法蟹瘾，如果存在則進行替換
IMP _Nullable class_replaceMethod(Class _Nullable cls, SEL _Nonnull name, IMP _Nonnull imp, const char * _Nullable types)

// 交換兩個method的imp
// IMP imp1 = method_getImplementation(m1);
// IMP imp2 = method_getImplementation(m2);
// method_setImplementation(m1, imp2);
// method_setImplementation(m2, imp1);
method_exchangeImplementations(Method _Nonnull m1, Method _Nonnull m2);

// cls是類對象則獲取實例方法列表、cls是元類對象則獲取類方法列表掠手。
// 需要注意的是返回值中不包含父類的方法
Method _Nonnull * _Nullable class_copyMethodList(Class _Nullable cls, unsigned int * _Nullable outCount)

// 獲取cls的類方法列表憾朴。
// 需要注意的是返回值中不包含父類的方法
Class _Nonnull * _Nullable objc_copyClassList(unsigned int * _Nullable outCount)

// 注冊一個名為str的SEL，如果這個名字的SEL已經(jīng)存在喷鸽，則直接返回該SEL
SEL _Nonnull sel_registerName(const char * _Nonnull str)

攔截易崩潰方法的方案

通常的方法有兩種：

1. 為NSArray添加分類众雷，在分類中添加safe方法，然后規(guī)定開發(fā)人員使用分類中的安全方法做祝，從而達(dá)到規(guī)避崩潰的目的砾省。
2. 手動找到NSArray類簇中的所有實現(xiàn)類，在代碼中對指定的實現(xiàn)類進行方法替換混槐，從而達(dá)到目的编兄。

對于方法1而言，筆者是不太喜歡的声登，因為要在調(diào)用的地方手動引入NSArray分類的頭文件狠鸳，然后調(diào)用指定的安全方法。首先是不喜歡引入非必要的頭文件悯嗓，其次是希望能調(diào)用系統(tǒng)方法件舵，以無感知的方式來達(dá)到目的。
對于方法2而言脯厨，其實已經(jīng)基本上達(dá)到了目的铅祸，但是一來是否找全了需要處理的實現(xiàn)類，二者多少有些不夠智能化的感覺合武。

我們的目標(biāo)是不在代碼中硬編碼類簇中實現(xiàn)類的類名临梗，并且能夠替換所有實現(xiàn)類的相關(guān)方法。
鑒于initialize方法是在每個類第一次被使用時調(diào)用稼跳，并且會調(diào)用[super initialize](每個實現(xiàn)類都會調(diào)用NSArray的initialize方法)盟庞，所以我們選擇在initialize方法進行方法交換的操作。
直接貼出NSArray分類的實現(xiàn)：

@implementation NSArray (HMXSafe)

+ (void)initialize {
    [super initialize];
    
    [self exchangeSafeMethod];
}

+ (void)exchangeSafeMethod {
    [self safe_sizzleSelector:@selector(initWithObjects:count:) toSelector:@selector(safe_initWithObjects:count:)];
    [self safe_sizzleSelector:@selector(objectAtIndex:) toSelector:@selector(safe_objectAtIndex:)];
    [self safe_sizzleSelector:@selector(getObjects:range:) toSelector:@selector(safe_getObjects:range:)];
    [self safe_sizzleSelector:@selector(subarrayWithRange:) toSelector:@selector(safe_subarrayWithRange:)];
}

- (instancetype)safe_initWithObjects:(id  _Nonnull const [])objects count:(NSUInteger)cnt {
    id __unsafe_unretained newObjects[cnt];
    NSUInteger index = 0;
    for (int i = 0; i < cnt; i++) {
        if (objects[i] == nil) {
            continue;
        }
        newObjects[index++] = objects[i];
    }
    return [self safe_initWithObjects:newObjects count:index];
}


- (id)safe_objectAtIndex:(NSUInteger)index {
    if (index >= [(NSArray *)self count]) {
        NSLog(@"out of array range  %@", NSStringFromClass(self.class));
        return nil;
    }
    
    id obj = [self safe_objectAtIndex:index];
    return obj;
}

- (void)safe_getObjects:(__unsafe_unretained id  _Nonnull *)objects range:(NSRange)range {
    if (range.location + range.length > self.count) {
        return;
    }
    [self safe_getObjects:objects range:range];
}

- (NSArray *)safe_subarrayWithRange:(NSRange)range {
    if (range.location + range.length > self.count) {
        NSLog(@"error subarrayWithRange -- %@", self.class);
        return @[];
    }
    return [self safe_subarrayWithRange:range];
}

@end

我們替換NSArray在exchangeSafeMethod方法中列出的4個方法岂贩。代碼的邏輯簡單且清晰茫经，關(guān)鍵代碼是safe_sizzleSelector:toSelector:，下面貼出這個方法的代碼：

+ (void)safe_sizzleSelector:(SEL)selector toSelector:(SEL)toSelector {
    if (selector == NULL || toSelector == NULL) {
        return;
    }
    
    // 找到擁有該selector的類cls
    Class cls = [self findWhoHasSelector:selector];
    if (cls == NULL) {
        return;
    }
    
    // 查找backupSelector
    // 如果沒有則認(rèn)為是第一次替換方法萎津，此時需要拷貝toSelector到backupSelector
    const char *prefix = "backup_";
    const char *toName = sel_getName(toSelector);
    char *backupName = (char *)malloc(strlen(prefix) + strlen(toName) + 1);
    strcpy(backupName, prefix);
    strcat(backupName, toName);
    SEL backupSelector = sel_registerName(backupName);
    Method backupMethod = class_getInstanceMethod(self, backupSelector);
    if (backupMethod == NULL) {
        Class rootCls = [self findWhoHasSelector:toSelector];
        if (rootCls == NULL) {
            return;
        }
        
        class_addMethod(rootCls, backupSelector, class_getMethodImplementation(rootCls, toSelector), method_getTypeEncoding(backupMethod));
        
        // 為backupMethod賦值
        backupMethod = class_getInstanceMethod(rootCls, backupSelector);
    }
    
    // 檢查selector的imp與backupSelector的imp是否相同卸伞，如果相同則認(rèn)為已經(jīng)替換過了，不再進行替換操作
    if (class_getMethodImplementation(cls, selector) == class_getMethodImplementation(cls, backupSelector)) {
        return;
    }
    
    // 如果cls沒有有toSelector锉屈，則為cls添加name為toSelector荤傲，imp為backupSelector的方法
    class_addMethod(cls, toSelector, method_getImplementation(backupMethod), method_getTypeEncoding(backupMethod));
    
    [cls exchangeSelector:selector toSelector:toSelector];
}

其中使用到的幾個自定義方法如下：

/// 檢查當(dāng)前Class是否有指定的selector
/// @param selector 指定的selector
+ (BOOL)checkExistSelector:(SEL)selector {
    if (selector == NULL) {
        return NO;
    }
    
    unsigned int count = 0;
    Method *methodList = class_copyMethodList(self, &count);
    for (int i = 0; i < count; i++) {
        Method method = methodList[i];
        SEL methodSel = method_getName(method);
        if (methodSel == selector) {
            return YES;
        }
    }
    return NO;
}

/// 找到當(dāng)前Class中尋找selector，如果沒有則在其父類中尋找颈渊，直到在Root Class上尋找不到時遂黍，返回NULL
/// @param selector 指定的selector
+ (Class)findWhoHasSelector:(SEL)selector {
    Class cls = self;
    while (cls) {
        if ([cls checkExistSelector:selector]) {
            break;
        }
        cls = class_getSuperclass(cls);
    }
    return cls;
}

/// 交換當(dāng)前Class上的兩個方法的實現(xiàn)
+ (void)exchangeSelector:(SEL)selector toSelector:(SEL)toSelector {
    Method originalMethod = class_getInstanceMethod(self, selector);
    Method customMethod = class_getInstanceMethod(self, toSelector);
    
    method_exchangeImplementations(originalMethod, customMethod);
}

1. 首先我們找到擁有要替換的selector的類cls终佛，如果沒找到則直接返回。
   因為是類簇雾家，我們不知道有幾層繼承關(guān)系铃彰，也不知道是哪個類實現(xiàn)了這個方法，所以通過回溯父類的方式找到實現(xiàn)這個方法的類芯咧。
2. 查找backupSelector
backupSelector是對safe方法toSelector的一個備份牙捉。因為可能會對同一個selector進行復(fù)數(shù)次的交換請求，所以我們需要有一個機制來進行判定敬飒，筆者想到的方法就是判斷selector的imp與safe方法的imp是否相等邪铲，如果相等，則認(rèn)為已經(jīng)進行了替換无拗。我們在開始方法交換之前带到，在NSArray中將toSelector的imp備份到backupSelector，保證每次進行判定的時候英染，都能找到safe方法的imp揽惹。
3. 如果沒有backupSelector則認(rèn)為是第一次進行該方法的交換，這個時候我們需要備份toSelector税迷。
   找到toSelector所在的類永丝，這里其實就是NSArray。為NSArray添加一個Method箭养，其SEL為backupSelector，imp則是toSelector的imp哥牍。
   在我們后續(xù)需要進行判定時毕泌，只需要對比selector和backupSelector的imp，如果兩者一樣嗅辣，則認(rèn)定已經(jīng)做了方法交換撼泛。
4. 判定是否做了方法交換，如果已經(jīng)交換過澡谭，則直接返回愿题。
5. 調(diào)用class_addMethod為cls添加方法toSelector。
   class_addMethod在目標(biāo)類沒有該方法時才進行添加操作蛙奖。
   添加的方法的SEL為toSelector潘酗，而imp是backupSelector的imp。這樣做的原因是有可能cls的父類已經(jīng)交換了方法雁仲，這時候找到的toSelector就是交換后的方法仔夺，其imp指向的會是父類的方法。我們使用backupSelector的imp則不會出現(xiàn)imp指向錯誤的問題攒砖。
6. 交換cls中selector和toSelector的實現(xiàn)缸兔。
7. 在NSArray的initialize方法中發(fā)起方法交換的請求日裙。

這個方案有如下缺點：

1. 在NSArray中會有多余的backupSelector存在。
2. 交換了類簇中所有類的相應(yīng)方法惰蜜，可能有些實現(xiàn)類并不需要交換昂拂。