iOS 崩溃日志使用KSCrash收集、分析

日志收集

iOS开发中经常会遇到程序异常闪退的情况，快速的错误定位、问题修复、很大程度上依赖我们的异常日志，所以日志收集、分析及定位在修复问题时至关重要，在日志收集时如果保密性不高的应用来说，可以选择Crash统计产品，如：友盟、Bugly等，如果是保密性高，或者不愿意其他平台收集自己的日志。可以选择自己实现日志的收集及分析。本文主要介绍使用KSCrash开源第三方库实现奔溃日志的收集，使用DSYMTools工具进行日志分析及代码定位。

• 在Podfile中使用pod 'KSCrash'然后pod install安装KSCrash库，也可以使用代码集成的方式，这里不做介绍
• 新建CrashReportFilter类遵循KSCrashReportFilter协议，实现协议方法

  - (void)filterReports:(NSArray *)reports onCompletion:(KSCrashReportFilterCompletion)onCompletion

具体代码如下：

• CrashReportFilter.h

#import 
#import 
@interface CrashReportFilter : NSObject
@end

• CrashReportFilter.m

#import "CrashReportFilter.h"
#import 
#import "KSJSONCodecObjC.h"
#import 
#import "Network.h"
@implementation CrashReportFilter
+ (CrashReportFilter*)sink {
    return [[CrashReportFilter alloc]init] ;
}
- (CrashReportFilter*)defaultCrashReportFilterSet{
    return self;
}
- (void)filterReports:(NSArray *)reports
         onCompletion:(KSCrashReportFilterCompletion)onCompletion{
    NSError *error;
    for (id object in reports) {
        NSData *jsonData = [KSJSONCodec encode:object options:KSJSONEncodeOptionSorted error:&error];
        KSHTTPMultipartPostBody *body = [[KSHTTPMultipartPostBody alloc] init];
        [body appendData:jsonData name:@"formFile" contentType:@"application/json" filename:@"reports.json"];
        [[Network share] uploadCrashByData:[body data] contengType:body.contentType completion:^(NSError * _Nullable error) {
            kscrash_callCompletion(onCompletion, reports, error == nil, error);
        }];
    }
}
@end

• 新建CrashInstallation类继承KSCrashInstallation，重写父类方法 - (id)sink，该方法返回CrashReportFilter上报过滤器。
• CrashInstallation.h

#import 
#import "CrashReportFilter.h"
#import 
@interface CrashInstallation : KSCrashInstallation
+(CrashInstallation *)share;
@end

• CrashInstallation.m

#import "CrashInstallation.h"
#import 
@implementation CrashInstallation
#pragma 单列方法
+(CrashInstallation *)share {
    static CrashInstallation *shareManager = nil;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        shareManager = [[CrashInstallation alloc] init];
    });
    return shareManager;
}

- (id)init {
    self = [super initWithRequiredProperties:@[]];
    return self;
}

- (id)sink {
    return [[CrashReportFilter alloc]init];
}
@end

• 调用CrashInstallation内的方法sendAllReportsWithCompletion上传日志

- (void)uploadCrashLog:(nullable CrashBlock)completion {
    CrashInstallation *installation = [CrashInstallation share];
    [installation install];
    // 上传成功删除本地日志
    [KSCrash sharedInstance].deleteBehaviorAfterSendAll = KSCDeleteOnSucess;
    // 自定义user json数据
    [KSCrash sharedInstance].userInfo = @{
        @"MachineId": @"8179C19D-5ADC-4C9F-A768-99999999",
        @"PackageId": @"包名",
        @"PatchVersionCode": @(1),
        @"Type": @"iOS",
        @"VersionCode": @"版本号"
    }
    [installation sendAllReportsWithCompletion:^(NSArray *filteredReports, BOOL completed, NSError *error) {
        if (completion) {
            completion(error);
        }
    }];
}

• 文件格式

  
  
  GitHub set up

其中user对应json可由用户自定义，这里我定义了如图所示的五个字段，用于标记应用的相关信息，在上面代码中
[KSCrash sharedInstance].userInfo = @{};就是设置user对应json数据。其余的字段report、binary_images、process、system、crash、debug等为KSCrash框架定义的字段。需要和服务端约定相应的解析格式。

崩溃测试

• 崩溃测试必须在真机上并且不能Xcode运行调试，目前我们的崩溃日志收集逻辑是下一次启动时上传之前闪退的日志，上传完成后删除本地存储的闪退日志（删除逻辑由KSCrash内部处理）。闪退测试代码如下：

NSArray *testArray = @[@"s1",@"s2"];
NSLog(@"%@",testArray[10]);

• 目前我们的逻辑在应用启动的时候上传奔溃日志

 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  [self uploadCrashLog:nil];
}

日志分析及定位

分析日志使用DSYMTools工具，每次打包发布时，项目目录都存在符号表，查看符号表步骤如下：
Xcode->Window->Organizer->对应的打包记录右键->Show in finder->xxxx.xcarchive->显示包内容->dSYMs目录下，会有多个。将xxx.app.dSYM符号表文件拖至DSYMTools工具中，如下图所示，选择对于的cpu类型。根据收集到的日志，贴入默认地址和错误地址，即可分析定位异常闪退代码。符号表文件xxx.app.dSYM必须和ipad包一一对应。

小结

本文主要使用KSCrash收集日志并将日志上传至自己服务端，更服务端解析展示的日志详情，借助DSYMTools进行日志分析、定位然后问题修复，DSYMTools使用写得有点粗糙，大家可以自行DSYMTools的使用。
写得不好的地方，欢迎大家指正。