ios 容错处理JKDataHelper和AvoidCrash

一、JKDataHelper　　

　　在大团队协同开发过程中，由于每个团队成员的水平不一，很难控制代码的质量，保证代码的健壮性，经常会发生由于后台返回异常数据造成app崩溃闪退的情况，为了避免这样情况使用JKDataHelper这个用于处理常见数据容错的工具，极大程度上降低了因为数据容错不到位产生崩溃闪退的概率。

　　在工作中，我们经常会遇到，由于服务器返回数据的结构内容发生非正常的改变，而造成app崩溃闪退的情况，虽然屡次强调，但是出现的频率仍然很高。当时心想虽然很大程度是人员技术水平的原因，但是如果能够通过技术手段，屏蔽掉这样的问题。无论你是什么样水平的开发者，只要使用了一种工具，就能很大程度上避免类似情况的发生，岂不更好。就这样JKDataHelper便应运而生了。 

对数组进行处理的函数

+ (NSArray *)safeArray:(id)array;  

内部实现：

+ (NSArray *)safeArray:(id)array {

    if ([array isKindOfClass:[NSArray class]]) {
        return array;
    }

    return nil;
}

　　在app解析后台API返回的数据时，经常会发生我们约定好的解析某一个字端后，返回的数据本来应该是数组的，但是异常情况可能时NSString类型的，也可能时NSDictionary类型的，这个时候如果我们把解析到的数据执行NSArray相关的方法操作就会crash，比如查找数组中的某一个索引下的元素。上面的这个方法很好的避免了这种情况的发生。如果不是数组类型的话，直接为nil，后续即使仍然按照NSArray执行相关的操作也不会产生crash。

+ (NSMutableArray *)safeMutableArray:(id)mutableArray
+ (NSDictionary *)safeDictionary:(id)dict
+ (NSMutableDictionary *)safeMutableDictionary:(id)dict
+ (NSString *)safeStr:(id)str
+ (id)safeObj:(id)obj

以上几个方法的思路同上。

+ (NSString *)safeStr:(id)str defaultStr:(NSString *)defaultStr

这个方法主要是用在解析NSString类型时，如果不是NSString类型，那么则输出设定的默认值。

为了方便使用我用宏定义进行了封装

#define JKSafeArray(array)   [JKDataHelper safeArray:array]
#define JKSafeMutableArray(mutableArray)   [JKDataHelper safeMutableArray:mutableArray]
#define JKSafeDic(dict)   [JKDataHelper safeDictionary:dict]
#define JKSafeMutableDic(mutableDict)   [JKDataHelper safeMutableDictionary:mutableDict]
#define JKSafeStr(str)   [JKDataHelper safeStr:str]
#define JKSafeStr1(str, defaultStr)   [JKDataHelper safeStr:str defaultStr:defaultStr]
#define JKSafeObj(obj)   [JKDataHelper safeObj:obj]

pod "JKDataHelper"

二、AvoidCrash

1、若集成了腾讯Bugly或者友盟等等异常搜集的SDK,AvoidCrash会影响到它们的异常搜集吗？

　　首先要清楚的一点是，对于一些第三方crash信息搜集工具，比如Bugly或者友盟，它们只有当程序出现异常(崩溃)的时候才会搜集异常信息。而AvoidCrash的作用是，防止部分常见异常的发生，异常被AvoidCrash捕获了，程序就不会崩溃，第三方crash信息搜集工具就不会搜集到崩溃信息咯。

　　AvoidCrash若捕获到异常，将会发出一个通知:AvoidCrashNotification,监听该通知即可获取到原本将导致崩溃的具体信息。此时你可以利用Bugly的自定义异常接口将这些异常信息上传到Bugly。下面上代码，上图说明。

 

 

1、首先先来查看下Bugly提供的上报异常的接口

 

2、创建一个上报异常的工具类 BuglyManager(可以充分利用Bugly上报自定义异常功能,方便我们快速定位app出现的异常，下图展示了我所开发的项目中使用Bugly上报了哪些错误类型)

/** 上报错误信息 */
+ (void)reportErrorName:(NSString *)errorName errorReason:(NSString *)errorReason callStack:(NSArray *)aStackArray extraInfo:(NSDictionary *)info{
    
    [Bugly reportExceptionWithCategory:3 errorName reason:errorReason callStack:aStackArray extraInfo:info terminateApp:NO];
}

3、在AppDelegate中初始化AvoidCrash并且监听通知:AvoidCrashNotification

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    
    [AvoidCrash makeAllEffective];

    //监听通知:AvoidCrashNotification, 获取AvoidCrash捕获的崩溃日志的详细信息
    [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(dealwithCrashMessage:) name:AvoidCrashNotification object:nil];
    return YES;
}

- (void)dealwithCrashMessage:(NSNotification *)note {
    //异常拦截并且通过bugly上报
    
    NSDictionary *info = note.userInfo;
    NSString *errorReason = [NSString stringWithFormat:@"【ErrorReason】%@========【ErrorPlace】%@========【DefaultToDo】%@========【ErrorName】%@", info[@"errorReason"], info[@"errorPlace"], info[@"defaultToDo"], info[@"errorName"]];
    NSArray *callStack = info[@"callStackSymbols"];
    
    [BuglyManager reportErrorName:Bugly_ErrorName_AvoidCrash errorReason:errorReason callStack:callStack extraInfo:nil];

4、写一个AvoidCrash可以拦截的异常

 NSArray *array = @[@"iOS"];
 NSString *string = array[100];

5、在Xcode控制台可以看到下图的输出

 

6、去Bugly错误分析中查看

 

 

 

 

2、为什么集成了AvoidCrash还是会报unrecognized selector sent to instance的异常？

 

若要捕获 unrecognized selector sent to instance 类型的异常，

1、首先查看下AvoidCrash中初始化AvoidCrash的两个方法

/**
 *  
 *  开始生效.你可以在AppDelegate的didFinishLaunchingWithOptions方法中调用becomeEffective方法
 *  【默认不开启  对”unrecognized selector sent to instance”防止崩溃的处理】
 *
 */
+ (void)becomeEffective;


/** 
 *  相比于becomeEffective，增加
 *  对”unrecognized selector sent to instance”防止崩溃的处理
 *
 *  但是必须配合setupClassStringsArr:使用
 */
+ (void)makeAllEffective;

2、若要捕获 unrecognized selector sent to instance 类型的异常，请使用[AvoidCrash makeAllEffective] 并且配合下面的两个方法使用。(这两个方法可以配合使用，可以同时使用)

/** 
 *  初始化一个需要防止”unrecognized selector sent to instance”的崩溃的类名数组
 *  ⚠️不可将@"NSObject"加入classStrings数组中
 *  ⚠️不可将UI前缀的字符串加入classStrings数组中
 */
+ (void)setupNoneSelClassStringsArr:(NSArray<NSString *> *)classStrings;


/**
 *  初始化一个需要防止”unrecognized selector sent to instance”的崩溃的类名前缀的数组
 *  ⚠️不可将UI前缀的字符串(包括@"UI")加入classStringPrefixs数组中
 *  ⚠️不可将NS前缀的字符串(包括@"NS")加入classStringPrefixs数组中
 */
+ (void)setupNoneSelClassStringPrefixsArr:(NSArray<NSString *> *)classStringPrefixs;

3、具体的使用方法

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    
    [AvoidCrash makeAllEffective];
    
    
    //================================================
    //   1、unrecognized selector sent to instance（方式1）
    //================================================
    
    //若出现unrecognized selector sent to instance并且控制台输出:
    //-[__NSCFConstantString initWithName:age:height:weight:]: unrecognized selector sent to instance
    //你可以将@"__NSCFConstantString"添加到如下数组中，当然，你也可以将它的父类添加到下面数组中
    //比如，对于部分字符串，继承关系如下
    //__NSCFConstantString --> __NSCFString --> NSMutableString --> NSString
    //你可以将上面四个类随意一个添加到下面的数组中，建议直接填入 NSString
    

    //我所开发的项目中所防止unrecognized selector sent to instance的类有下面几个，主要是防止后台数据格式错乱导致的崩溃。个人觉得若要防止后台接口数据错乱，用下面的几个类即可。

    NSArray *noneSelClassStrings = @[
                          @"NSNull",
                          @"NSNumber",
                          @"NSString",
                          @"NSDictionary",
                          @"NSArray"
                          ];
    [AvoidCrash setupNoneSelClassStringsArr:noneSelClassStrings];
    
    
    //================================================
    //   2、unrecognized selector sent to instance（方式2）
    //================================================
    
    //若需要防止某个前缀的类的unrecognized selector sent to instance
    //比如你所开发项目中使用的类的前缀:CC、DD
    //你可以调用如下方法
    NSArray *noneSelClassPrefix = @[
                                    @"CC",
                                    @"DD"
                                    ];
    [AvoidCrash setupNoneSelClassStringPrefixsArr:noneSelClassPrefix];
    
    
    
    //监听通知:AvoidCrashNotification, 获取AvoidCrash捕获的崩溃日志的详细信息
    [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(dealwithCrashMessage:) name:AvoidCrashNotification object:nil];
    return YES;
}