iOS 利用Method Swizzling解决线上数组越界的问题

最近项目上线以后，想解决下线上的bug，发现数组越界的问题还存在不少，特别空数组越界。

image

为了提高提高用户体验，减少崩溃，便开始想办法解决。首先想到的是，既然数组越界，那只要在从数组中取值之前对数组的长度进行判断不就可以了嘛。但是项目中从数组中取值用到的地方有很多，如果一个个地方去加的话，首先要花上大量的时间，一不小心还有漏掉某些地方。

经过查阅资料，我发现利用Method Swizzling，在运行时将自己的方法和NSArray类的方法进行交换，能够很好的解决这一问题。Method Swizzling的使用，我用了github上的第三方库JRSwizzle。

#import "NSObject+SafeCategory.h"
#import <JRSwizzle/JRSwizzle.h>

#define LOG_ERROR(err) \
do { \
if (err) { \
NSLog(@"Error: %@", err); \
err = nil; \
} \
} while(0)



@interface NSArray (SafeCategory)

- (id)objectAtSafeIndex:(NSUInteger)index;

@end

@implementation NSArray (SafeCategory)

- (id)objectAtSafeIndex:(NSUInteger)index
{
    if (index > self.count - 1 || !self.count) {
        @try {
            return [self objectAtSafeIndex:index];
        }
        @catch (NSException *exception) {
            NSLog(@"exception: %@", exception.reason);
            return nil;
        }
        
    }else {
        return [self objectAtSafeIndex:index];
    }
}


@end




@interface NSMutableArray (SafeCategory)

- (void)TKSafe_addObject:(id)anObject;

- (id)mutableObjectAtSafeIndex:(NSUInteger)index;

@end

@implementation NSMutableArray (SafeCategory)

- (void)TKSafe_addObject:(id)anObject
{
    if (anObject != nil) {
        [self TKSafe_addObject:anObject];
    } else {
#ifdef DEBUG
        NSAssert(NO, @"object is nil");
#endif
    }
}

- (id)mutableObjectAtSafeIndex:(NSUInteger)index
{
    if (index > self.count - 1 || !self.count) {
        @try {
            return [self mutableObjectAtSafeIndex:index];
        }
        @catch (NSException *exception) {
            NSLog(@"exception: %@", exception.reason);
            return nil;
        }
        
    }else {
        return [self mutableObjectAtSafeIndex:index];
    }
}


@end




@implementation NSObject (SafeCategory)

+ (void)configureSafeMethods
{
    NSError *error = nil;
    
    [[[NSArray array] class] jr_swizzleMethod:@selector(objectAtIndex:)
                                   withMethod:@selector(objectAtSafeIndex:)
                                        error:&error];
  
    LOG_ERROR(error);
    
    [[[NSMutableArray array] class] jr_swizzleMethod:@selector(objectAtIndex:)
                                          withMethod:@selector(mutableObjectAtSafeIndex:)
                                               error:&error];
    LOG_ERROR(error);
    
    [[[NSMutableArray array] class] jr_swizzleMethod:@selector(addObject:)
                                          withMethod:@selector(TKSafe_addObject:)
                                               error:&error];
    LOG_ERROR(error);
}

@end

本以为这样将NSArray和NSMutableArray类的方法都进行了交换，线上的数组越界bug应该再也不会出现了吧,没想到新版本上线以后，数组越界的问题依旧存在。
那到底是什么原因导致的呢？在多次尝试之后和打印。

    NSArray *arr1 = @[];
    NSArray *arr2 = @[@"1",@"2"];
    NSArray *arr3 = @[@"3"];
    NSLog(@"%@",[arr1 class]);
    NSLog(@"%@",[arr2 class]);
    NSLog(@"%@",[arr3 class]);
    
    NSMutableArray *arr4 = [NSMutableArray arrayWithArray:@[]];
    NSMutableArray *arr5 = [NSMutableArray arrayWithArray:@[@"1"]];
    NSMutableArray *arr6 = [NSMutableArray arrayWithObjects:@[@"2",@"3"], nil];
    NSLog(@"%@",[arr4 class]);
    NSLog(@"%@",[arr5 class]);
    NSLog(@"%@",[arr6 class]);

2018-08-18 15:40:26.667455+0800 Kivie[22422:6746775] __NSArray0
2018-08-18 15:40:26.667619+0800 Kivie[22422:6746775] __NSArrayI
2018-08-18 15:40:26.667961+0800 Kivie[22422:6746775] __NSSingleObjectArrayI
2018-08-18 15:40:26.668216+0800 Kivie[22422:6746775] __NSArrayM
2018-08-18 15:40:26.668237+0800 Kivie[22422:6746775] __NSArrayM
2018-08-18 15:40:26.668250+0800 Kivie[22422:6746775] __NSArrayM

我发现原来NSArray在为空时它的类簇为__NSArray0，而当里面有一个元素时它的类簇为__NSSingleObjectArrayI，而其他情况则为__NSArrayI，而我之前使用[[NSArray array] class] 其实只对__NSArray0，即空数组进行了处理。
另外经过打印我发现当我们使用arr[7]这种取值方式对数组进行取值时，并没有调用objectAtIndex:方法，而是调用了objectAtIndexedSubscript:方法。
找到了问题之后，我又对代码进行了改进如下。

#import "NSObject+SafeCategory.h"
#import <JRSwizzle/JRSwizzle.h>

#define LOG_ERROR(err) \
do { \
if (err) { \
NSLog(@"Error: %@", err); \
err = nil; \
} \
} while(0)



@interface NSArray (SafeCategory)

- (id)objectAtSafeIndex:(NSUInteger)index;

- (id)objectAtSafeIndexSubscript:(NSUInteger)index;

@end

@implementation NSArray (SafeCategory)

- (id)objectAtSafeIndex:(NSUInteger)index
{
    if (index > self.count - 1 || !self.count) {
        @try {
            return [self objectAtSafeIndex:index];
        }
        @catch (NSException *exception) {
            NSLog(@"exception: %@", exception.reason);
            return nil;
        }
        
    }else {
        return [self objectAtSafeIndex:index];
    }
}

- (id)objectAtSafeIndexSubscript:(NSUInteger)index{
    if (index > self.count - 1 || !self.count) {
        @try {
            return [self objectAtSafeIndex:index];
        }
        @catch (NSException *exception) {
            NSLog(@"exception: %@", exception.reason);
            return nil;
        }
        
    }else {
        return [self objectAtSafeIndexSubscript:index];
    }
}

@end




@interface NSMutableArray (SafeCategory)

- (void)TKSafe_addObject:(id)anObject;

- (id)mutableObjectAtSafeIndex:(NSUInteger)index;

- (id)mutableObjectAtSafeIndexSubscript:(NSUInteger)index;

@end

@implementation NSMutableArray (SafeCategory)

- (void)TKSafe_addObject:(id)anObject
{
    if (anObject != nil) {
        [self TKSafe_addObject:anObject];
    } else {
#ifdef DEBUG
        NSAssert(NO, @"object is nil");
#endif
    }
}

- (id)mutableObjectAtSafeIndex:(NSUInteger)index
{
    if (index > self.count - 1 || !self.count) {
        @try {
            return [self mutableObjectAtSafeIndex:index];
        }
        @catch (NSException *exception) {
            NSLog(@"exception: %@", exception.reason);
            return nil;
        }
        
    }else {
        return [self mutableObjectAtSafeIndex:index];
    }
}

- (id)mutableObjectAtSafeIndexSubscript:(NSUInteger)index{
    if (index > self.count - 1 || !self.count) {
        @try {
            return [self mutableObjectAtSafeIndexSubscript:index];
        }
        @catch (NSException *exception) {
            NSLog(@"exception: %@", exception.reason);
            return nil;
        }
        
    }else {
        return [self mutableObjectAtSafeIndexSubscript:index];
    }
}


@end




@implementation NSObject (SafeCategory)

+ (void)configureSafeMethods
{
    NSError *error = nil;
    
    //对不可变数组方法 objectAtIndex: 的三种情况分别进行处理
    [objc_getClass("__NSSingleObjectArrayI") jr_swizzleMethod:@selector(objectAtIndex:)
                                                   withMethod:@selector(objectAtSafeIndex:)
                                                        error:&error];
    [objc_getClass("__NSArrayI") jr_swizzleMethod:@selector(objectAtIndex:)
                                                   withMethod:@selector(objectAtSafeIndex:)
                                                        error:&error];
    [objc_getClass("__NSArray0") jr_swizzleMethod:@selector(objectAtIndex:)
                                                   withMethod:@selector(objectAtSafeIndex:)
                                                        error:&error];
    
    //对不可变数组方法 objectAtIndexedSubscript: 的三种情况分别进行处理
    [objc_getClass("__NSSingleObjectArrayI") jr_swizzleMethod:@selector(objectAtIndexedSubscript:)
                                       withMethod:@selector(objectAtSafeIndexSubscript:)
                                            error:&error];
    
    [objc_getClass("__NSArrayI") jr_swizzleMethod:@selector(objectAtIndexedSubscript:)
                                       withMethod:@selector(objectAtSafeIndexSubscript:)
                                            error:&error];
    
    [objc_getClass("__NSArray0") jr_swizzleMethod:@selector(objectAtIndexedSubscript:)
                                       withMethod:@selector(objectAtSafeIndexSubscript:)
                                            error:&error];
    LOG_ERROR(error);
    
    //对可变数组方法 objectAtIndex: 的情况分别进行处理
    [[[NSMutableArray array] class] jr_swizzleMethod:@selector(objectAtIndex:)
                                          withMethod:@selector(mutableObjectAtSafeIndex:)
                                               error:&error];
    
    //对可变数组方法 objectAtIndexedSubscript: 的情况分别进行处理
    [[[NSMutableArray array] class] jr_swizzleMethod:@selector(objectAtIndexedSubscript:)
                                          withMethod:@selector(mutableObjectAtSafeIndexSubscript:)
                                               error:&error];
    
    
    LOG_ERROR(error);
    
    [[[NSMutableArray array] class] jr_swizzleMethod:@selector(addObject:)
                                          withMethod:@selector(TKSafe_addObject:)
                                               error:&error];
    
    LOG_ERROR(error);
}

这样数组越界导致线上崩溃的问题应该被彻底解决了。

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 213,616评论 6赞 492
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 91,020评论 3赞 387
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 159,078评论 0赞 349
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 57,040评论 1赞 285
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 66,154评论 6赞 385
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 50,265评论 1赞 292
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 39,298评论 3赞 412
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 38,072评论 0赞 268
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 44,491评论 1赞 306
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 36,795评论 2赞 328
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 38,970评论 1赞 341
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 34,654评论 4赞 337
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 40,272评论 3赞 318
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 30,985评论 0赞 21
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 32,223评论 1赞 267
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 46,815评论 2赞 365
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 43,852评论 2赞 351

iOS 利用Method Swizzling解决线上数组越界的问题

推荐阅读更多精彩内容