iOS crash分析实践

背景

分享一些过去两个月遇到的crash。

正文

一、运行时错误

1、UICollectionView的调用顺序

从堆栈可以看出是indexPath无效，通常是indexPath的section或者row超过了数据的大小；

根据堆栈信息和日志信息，可以找到用户操作路径，是通过scheme进入分类； 但是直接用真机复现，相同的操作并不会导致crash； 通过分析crash出现的机型和系统特征，发现都是iOS 13以下系统，而刚刚尝试的是iOS 13的真机； 于是用iOS 12模拟器尝试同样的路径，可以成功复现。 分析原因后，定位到是先调用scrollToItemAtIndexPath，再调用reloadData导致的异常。 解决方案也很简单，调整为正确的顺序即可。

寻找复现路径的时候，要尽量从两个方向去复现： 1、用户设备条件，包括iOS系统版本、iphone机型、网络环境等要保持一致； 2、App运行上下文，包括App版本、操作路径、运行环境等；

2、HTML转码NSAttributedString耗时过长

业务需要把html格式的字符串转成NSAttributedString，原来HTML转码成NSAttributedString使用的是系统自带的方法：

- (nullable instancetype)initWithData:(NSData *)data options:(NSDictionary<NSAttributedStringDocumentReadingOptionKey, id> *)options documentAttributes:(NSDictionary<NSAttributedStringDocumentAttributeKey, id> * __nullable * __nullable)dict error:(NSError **)error;

举一个实际的例子：

- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view, typically from a nib.

    NSString *pathStr = [[NSBundle mainBundle] pathForResource:@"test" ofType:@"data"];
    NSString *htmlStr = [NSString stringWithContentsOfURL:[NSURL fileURLWithPath:pathStr] encoding:NSUTF8StringEncoding error:nil];

    NSLog(@"load string:%@", htmlStr);
    NSData *htmlData = [NSData dataWithBytes:htmlStr.UTF8String length:[htmlStr lengthOfBytesUsingEncoding:NSUTF8StringEncoding]];
    NSDictionary *dic = @{NSDocumentTypeDocumentAttribute:NSHTMLTextDocumentType,
                          NSCharacterEncodingDocumentAttribute:[NSNumber numberWithInt:NSUTF8StringEncoding]};
    NSDate *date = [NSDate date];
    NSAttributedString *attrStr = [[NSAttributedString alloc] initWithData:htmlData options:dic documentAttributes:nil error:nil];

    NSLog(@"transform time:%f", [[NSDate date] timeIntervalSinceDate:date]);
}

这个逻辑测试阶段一切正常， 直到遇到一段HTML文本，其中带有img标签。 这段HTML文本在转码的时候会同步对图片资源进行加载，导致线程阻塞，如果阻塞时间过长，还会引发crash。 堆栈如下：

此时，再回顾系统api的解释，才有了更深刻的理解：

It will try to synchronize with the main thread, fail, and time out. Calling it from the main thread works (but can still time out if the HTML contains references to external resources, which should be avoided at all costs).

解决方案1、转码前，手动过滤掉<img>的标签； 解决方案2、改用DTCoreText的html转NSAttributedString；

使用一个不熟悉的系统API接口，最好花时间阅读下接口说明；

二、多线程

1、dispatch_once引起死锁

dispatch_once常被用于iOS单例实现方法，也会被用来处理某些只需要执行一次的场景，比如下文的获取某些tag的方法：

+ (NSInteger)coolCommentTag { 
    static NSInteger ret = 5; // 实验写死默认值，客户端不关心，透传给后台 
    static dispatch_once_t onceToken; 
    dispatch_once(&onceToken, ^{ 
        NSDictionary *abDict = [GET_SERVICE(SSTestManager) getExperimentValueForKey:@"social_comment_tag" withExposure:YES]; 
        if (SSIsValidatedDict(abDict)) { 
            ret = [abDict bda_integerValueForKey:@"comment_tag"]; 
        } 
    });      
    return ret; 
} 

这段代码会造成一个crash：

堆栈关键信息：dispatch_gate_wait_slow； 注意到上图，crash的是子线程，这时候要习惯性看看主线程在处理什么逻辑：

从这两个堆栈信息，我们基本可以确定是因为多线程死锁导致的卡死。 场景分析： 1、主线程：did注册 =》TTNet初始化 =》发起网络请求 =》 获取公共参数 =》 dispatch_once ； 2、子线程：RPC（网络层）初始化 =》初始化 =》 获取公共参数 =》 dispatch_once ； 然后发生死锁

修复方式：去掉dispatch_once，改用线程安全的方式；

经验总结： 网络层相关接口有可能是子线程发起； dispatch_once内的代码要尽可能简单； 子线程发生crash时，要习惯性看看主线程；

三、内存相关

1、dealloc访问weak指针

weak指针经常被应用到在代理、block避免循环引用，避免有一个特性就是对象dealloc的时候，指向对象的weak指针会被置为nil。

但是使用不当的时候，weak指针也很容易造成crash，如下图：

场景举例： 1、书架某个按钮，使用getter的方式获取；getter方法中用block去响应按钮点击，block因为持有了外部self，所以会用weak-strong-dance；如果在dealloc方法访问到该按钮，则会发生crash； 2、详情页的某个view，使用getter的方式获取，在dealloc方法时访问了该getter；

getter实现

修复方式

经验总结： 1、getter实现应该简单化，尽量少的去设置很多属性和创建block等，仅仅作为懒加载去创建对象； 2、dealloc方法不要访问getter和setter的方法；

思考题，为什么对象dealloc创建对象的weak指针会crash？

2、子线程释放对象

block是常见的回调方式，当我们调用某个异步方法，想在回调时继续保持运行上下文，就会传入一个回调block，等到就绪时再执行block。 比如说常见的rpc请求：

[SSBookApiService getBookToneInfo:^(SSBookToneInfoRequest *request) {
        request.bookId = bookId;
    } completion:^(BDRpcError *error, SSBookToneInfoResponse *response) {
        XXX.XXX
    }
}];

block保持上下文的方式，就是持有block中所有访问到的外部对象。 这种持有特性可能会导致一些意想不到的情况，比如说在子线程销毁一个对象。

如图，子线程的堆栈都是在dealloc方法，一层层递归。

通过代码分析，可以知道是BDRpcAsyncOperation持有了某个block；该block持有了其他对象（因为block中访问了该对象）。 结果BDRpcAsyncOperation在子线程销毁时，dealloc方法层层递进，最终触发了某个对象在子线程销毁，而该对象会在dealloc方法处理一些UI相关的逻辑。

修复方法： 1、block访问到的外部对象，非局部变量尽可能使用weak-strong的方式来声明；用weak指针来声明外部的变量，如果该对象在block回调前被释放，则会变为nil； 2、如果需要block持有该对象，则可以在dealloc的时候使用dispatch_async的方式，放到主线程去执行；（不能访问self相关）

总结

1、寻找复现路径的时候，要尽可能还原现场，才能更好复现； 2、使用一个不熟悉的系统API接口，最好花时间阅读下接口说明； 3、子线程发生crash时，要习惯性看看主线程；