在大多数iOS应用开发过程中, 循环引用一直都是最常见的iOS开发问题之一。通常情况下, 最常见的循环引用问题就是在Block回调中的self指针的不当使用了。在这种最常见的场景中, 对象self本身使用的Block被self对象本身持有(临时变量block是不会形成循环引用的), 而在Block回调中又使用了self导致形成了一个循环引用。
self.myBlock = ^{
[self doSomething];
};
+-----------+ +-----------+
| self | ref | Block |
---> | | --------> | |
| retain 2 | <-------- | retain 1 |
| | ref | |
+-----------+ +-----------+
针对上述最常见的循环引用的场景, 在市面上最常用的几款循环引用检查工具都不能特别有效的检测出是否真正的产生了循环引用。笔者针对这种场景突然脑洞大开, 设想是否能够通过文本扫描的方式提前知道哪些block使用场景可能会产生潜在的循环引用问题。为了支持自己的大脑洞想法, 笔者尝试用python书写一个文本扫描器来提前预知潜在Self Retain Block循环引用风险的代码。哈哈, 至此, 一个无聊又奇怪的检测Block的小工具RiskBlockScanner就诞生了。
想法起源
笔者这个奇怪的Block想法的起源是因为笔者在工作中参与过的几个大型iOS项目(大于30人协作开发)中都涉及到很多使用Block的场景, 而且经常会发现代码中有些潜在或者确定的Block引用风险, 并且这些引用的风险多数和self指针和Block的组合使用相关联。同时, XCode自带的Warning只能报出比较简单的循环引用警告, 并且通过XCode自带的静态分析有时候也难以发现循环引用的出处。
虽然这个奇怪的想法是突然萌生的, 但是刺激因素有如下:
- 上百万行的代码量太多, 无法人肉检查(最主要用途)
- ReactiveCocoa使用中大量涉及Self Retain Cycle的场景
- 大型项目开发参差不齐&参与人数过多, 低级错误无法100%避免
- 循环引用排查困难
- XCode自带循环引用排查功能不太完善
实现方案
有奇怪的想法第一件事情当然是验证想法的可行性。在不追求性价比的前提下, 验证想法可行性最愚蠢也是最有效的方法就是把想法实现出来，那么RiskBlockScanner就这么诞生了。
市面上大多数的Block循环检查基本都是要编译链接的(例如XCode自带的Anaylse), 有些甚至是在操作过程中分析内存是否释放(例如facebook开源的FBRetainCycleDetector), 很少有检测工具针对编写代码过程中快速发现风险的方面进行设计。
我的这个奇怪的思想是通过正则表达式去匹配发现所有的Block使用起始行、该Block所在的方法起始&结束行。
RiskBlockScanner的大致思路如下:
- 扫描目录提取代码文件(.m格式)
- 提取每一行代码行
- 根据每一行代码行去根据正则表达式匹配出方法起始行(func line)、block起始行(block line)、潜在多行block起始行(potential block line)、block结束行和weak执行行(weak line)
- 根据"}"和";"组合判断和潜在多行block起始行过滤不是block的行, 保留真正block行
- 过滤固定匹配关键字的block行(例如masonry等常见不持有block的场景)
- 判断weak执行行(weak line)是否包含在方法起始行(func line)和block起始行(block line)之间
- 根据第7步的判断结果来决定是否该Block存在循环引用风险
上图表述的步骤均是根据存储数据来维护的, 具体的逻辑实现因为比较简单本文就不赘述了。如果大家有感兴趣的话请自行访问Github地址进行代码阅读~
通过RiskBlockScanner可以扫描出大量的Block Self-Retain的风险代码行, 使用方法相对简单.(PS: 对代码量比较小或者不怎么使用Block的工程几乎没有作用)
下图为简单的使用示例:
优化设想
- 通过不断的积累实验, 过滤更多的白名单方法
- 风险检测包含但不限于self的检测
- 开发一个XCode插件工具(看笔者是否够勤奋)
- 尝试支持检查Swift语法
总结
RiskBlockScanner是一个检测简单的Block循环引用风险的灵感实现。鉴于该工具是基于文本扫描实现的, 并且没有检测Block是否被使用对象真正持有(不持有则不产生循环引用), 所以它并不能真正意义上的检查出Block循环引用, 只能检查出所有潜在的风险点方便开发者排查定位。
该工具纯属笔者好奇实现, 可能有不少童鞋会觉得这个很无聊, 其实笔者觉得这个实际意义也不是特别大哈, 但是有总比没有好。至少该工具可以在开发者编写代码过程中快速分析定位block引用风险的代码位置, 能够帮助开发者高效的定位Block使用风险。
PS: 笔者水平有限, 如果文章有错误之处, 请大家一定要指出, 防止误导大家哈~~
参考文献
- 避免Block的循环引用
- 使用FBRetainCycleDetector检测引用循环