漫谈LLDB：最优雅的方式打印UIViewController生命周期
前言
打印UIViewController的生命周期有显而易见的好处，可以很方便看到当前页进入哪个UIViewController，也可以检查退出当前UIViewController后有没有销毁（dealloc）它。
通常实现的方式有两种，一种是父类中重写（override）生命周期方法，并用NSLog或print方法输出相应的方法名，这样所有继承于它的业务子类都能自动打印指定的生命周期方法。另一种是使用Method Swizzling，无侵入的方式打印所有UIViewController指定的生命周期，我早期开发常在Category中完成方法交换，以下是一个简易打印dealloc的例子：
@implementation UIViewController (HMExtension)
+ (void)load {
SEL s1 = NSSelectorFromString(@"dealloc");
Method m1 = class_getInstanceMethod(self, s1);
SEL s2 = NSSelectorFromString(@"hm_dealloc");
Method m2 = class_getInstanceMethod(self, s2);
if (class_addMethod(self, s1, method_getImplementation(m2), method_getTypeEncoding(m2))) {
class_replaceMethod(self, s2, method_getImplementation(m1), method_getTypeEncoding(m1));
} else {
method_exchangeImplementations(m1, m2);
}
}
- (void)hm_dealloc {
NSLog(@"%@ dealloc", [self class]);
[self hm_dealloc];
}
@end
两种方法各有优劣，这里就不分析了，因为接下来介绍的才是本文重点，一种比Method Swizzling更加无侵入的方式，0行代码即可实现打印生命周期。
使用LLDB符号断点打印生命周期
Xcode允许我们添加Symbolic Breakpoint符号断点，通过设置符号让LLDB触发断点。
我们可以通过配置UIViewController生命周期的符号，让LLDB触发断点，输出上下文信息。接下来以viewDidAppear:方法为例，讲讲思路。
- 首先根据上图的提示，symbol这一行这样配置
-[UIViewController viewDidAppear:]。运行项目，程序很快就会触发了这个断点而停止，并进入LLDB调试模式。 - 如何输出需要的信息呢？可以在Action这一行新增一个Debugger Command，可以用来执行LLDB自带的命令。众所周知，OC消息发送机制的前两个参数是
self和_cmd，在LLDB环境中无法直接用这两个关键字，得用别的办法获取self和_cmd。最可靠的是通过寄存器来取值，在方法内部断点，64位模拟器(x86_64)的前两个参数的寄存器是rdi和rsi，64位真机(arm64)的前两个参数的寄存器是x0和x1，前面加上$符号即可在LLDB中取值，假设是在模拟器，那这一行输入这条命令expression -l objc -O -- @import UIKit; [[NSString alloc] initWithFormat:@"%@ %s", (id)$rdi, (char *)$rsi]。还有另一种方法，那就是LLDB提供了$arg1，$arg2，$arg3...等一系列变量，指向当前方法调用的第几个参数，为了同时兼容模拟器和真机，所以这一行应改为expression -l objc -O -- @import UIKit; [[NSString alloc] initWithFormat:@"%@ %s", (id)$arg1, (char *)$arg2]。 - 命中断点，执行命令，最后还有一个步骤，那就是让程序恢复运行状态，勾选上Automatically continue after evaluating actions这个选项。最后的成果如下图：
img3.png
把dealloc方法也配置好符号断点，运行Swift开源项目Kingfisher里的demo，Xcode的Console输出如下gif:
我在Xcode设置里把Debugger的输出换了颜色（橙色），方便和APP执行程序的输出（黑色）做区分。
优化：减少@import UIKit语句
不难看出上面的expression命令执行了两条语句，首先是@import UIKit，然后是[[NSString alloc] initWithFormat:@"%@ %s", (id)$arg1, (char *)$arg2]。可能一些APP并不需要导入UIKit框架，但为了提高稳定性我还是保留了。
LLDB只需要导入一次UIKit，而上面每次触发断点都执行了一次@import UIKit;。为了减少不必要的import，可以在触发UIViewController生命周期断点前，先导入一次UIKit。设置一个符号断点UIApplicationMain，并添加Debugger Command的Action，输入expression -l objc -O -- @import UIKit，然后勾选Automatically continue after evaluating actions，这样APP启动后就导入了UIKit。如下图所示：
接下来的工作和上一节介绍一样，为UIViewController生命周期方法添加符号断点，但是Debugger Command的命令缩减为expression -l objc -O -- [[NSString alloc] initWithFormat:@"%@ %s", (id)$arg1, (char *)$arg2]就可以了。
优化：忽略系统生成的UIViewController
如果读者有仔细看一下前面那张gif效果图，会发现有一个UIInputWindowController出现了，这属于系统生成的UIViewController。iOS系统会在一些情况下生成某些UIViewController，而大部分情况下我们并不需要关注这些系统生成的UIViewController，为了减少干扰，就需要忽略这些类。
再仔细看一眼上面断点编辑窗口，在Condition这一行是可以进行类过滤的。但如果这样做的话，每次新增一个需要忽略的类，要调整的地方就太多了：每个项目，项目中每个生命周期符号断点都要修改。
为了简化后续维护工作，我写了一个LLDB脚本命令plifecycle，这个脚本被收集在我的开源命令库HMLLDB中，读者可以参照文档，安装这个开源库。成功安装之后，Debugger Command这行就可以用plifecycle -i就能打印生命周期并忽略系统某些UIViewController，而且也不需要先@import UIKit。配置如下图：
LLDB打印生命周期的优点
我之所以认为使用LLDB打印UIViewController生命周期是最优雅的方式，是因为和传统的方法相比，前者具有以下的优势：
- 0行代码，无侵入，项目无需修改，git看不到任何相关记录。
- Xcode可以为Debugger Output设置独特颜色，Console窗口也可以设置只显示Debugger Output，非常方便定位。
- 在程序运行时，在Breakpoing navigator可以按需要开启或关闭符号断点，随时控制是否打印。
存在的问题
- 刚启动APP时有可能会触发下面的警告而暂停程序，需要点击Xcode里的Continue program execution让程序继续跑。偶现的问题，可能下次重启电脑就不会出现了。
# 遇上这个警告，要点击Xcode里的Continue program execution让程序继续跑
Warning: hit breakpoint while running function, skipping commands and conditions to prevent recursion.
- 切换页面卡顿。命中断点进入调试模式本身就会有所消耗，加上执行的命令需要经过即时编译JIT，所以页面切换会有点卡顿。一般情况下并不建议打印所有生命周期方法，推荐日常开发只启用
viewDidAppear:和dealloc打印。
后记
也许有读者已经注意到了，上面介绍的那条expression和plifecycle的命令都支持打印任意的OC方法，只不过在本篇文章中只用来打印生命周期而已。但是我不排除后期会变更plifecycle的实现方式，毕竟上面存在的问题会影响使用体验。
相关资料
HMLLDB：https://github.com/chenhuimao/HMLLDB
plifecycle源码：https://github.com/chenhuimao/HMLLDB/blob/master/commands/HMLifeCycle.py
Kingfisher：https://github.com/onevcat/Kingfisher
