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;
}