简介
MLeaksFinder是WeRead团队开源的一个检测iOS内存泄漏的框架，其使用非常简单，只需将文件加入项目中，如果有内存泄漏，3秒后自动弹出警告来捕捉循环引用。使得可以在开发快速找到80％内存泄漏，而使用Xcode Leak工具更适合大范围的，全部的寻找泄漏点。
特性
通过阅读MLeaksFinder的介绍可以看出其具有以下几个特性
- 无侵入性
- 可以构建泄漏堆栈
- 有白名单机制
- 扩展性
- 其他的一些特殊处理
深入源码
实现的核心
在MLeaksFinder的博客介绍中可以清晰的知道其工作原理，引用博文所说
MLeaksFinder一开始从UIViewController入手。我们知道，当一个UIViewController被pop或dismiss后，该UIViewController包括它的视图，视图的子视图等等将很快被释放（除非你把它设计成单例，或者持有它的强引用，但一般很少这样做）。在是，我们只需在一个ViewController被弹出或关闭一小段时间后，看看该UIViewController，它的视图，视图的子视图等等是否还存在。
具体的方法是，为基类NSObject添加一个方法-willDealloc方法，该方法的作用是，先用一个弱指针指向self，并在一小段时间（3秒）后，通过这个弱指针调用-assertNotDealloc， -assertNotDealloc主要作用是直接中断言。这样，当我们认为某个对象应该被释放了，在释放前调用这个方法，如果3秒后它被释放成功，weakSelf就指向nil，不会调用到-assertNotDealloc方法，也就不会中断言，如果它没被释放（泄露了）， - assertNotDealloc就会被调用中断言。这样，当一个UIViewController被弹出或关闭时（我们认为它应该要被释放了），我们遍历该UIViewController上的所有视图，依次调-willDealloc，若3秒后没被释放，就会中断言。
总结起来一句话就是，当一个对象3秒之后还没释放，那么指向它的弱指针还是存在的，所以可以调用其运行时绑定的方法willDealloc从而提示内存泄漏。
接下来我们来看看具体实现
寻找释放点
论无侵入性的最佳实践还是使用AOP面向切面的编程，通过方法Swizzling系统方法来添加
额外的功能。在MLeaksFinder中，其Swizzling了几个ViewController释放方法
// UIViewController 的方法
[self swizzleSEL:@selector(viewDidDisappear:) withSEL:@selector(swizzled_viewDidDisappear:)];
[self swizzleSEL:@selector(viewWillAppear:) withSEL:@selector(swizzled_viewWillAppear:)];
[self swizzleSEL:@selector(dismissViewControllerAnimated:completion:) withSEL:@selector(swizzled_dismissViewControllerAnimated:completion:)];
通过替换viewDidDisappear，viewWillAppear，dismissViewControllerAnimated:completion:方法来跟踪一个模态视图-控制的释放
// UINavigationController
[self swizzleSEL:@selector(pushViewController:animated:) withSEL:@selector(swizzled_pushViewController:animated:)];
[self swizzleSEL:@selector(popViewControllerAnimated:) withSEL:@selector(swizzled_popViewControllerAnimated:)];
[self swizzleSEL:@selector(popToViewController:animated:) withSEL:@selector(swizzled_popToViewController:animated:)];
[self swizzleSEL:@selector(popToRootViewControllerAnimated:) withSEL:@selector(swizzled_popToRootViewControllerAnimated:)];
而在UINavigationController的方面，勾了pushViewController:animated:，popViewControllerAnimated:，popToViewController:animated:，popToRootViewControllerAnimated:方法来追踪一个的UINavigationController栈的释放。
然而代码中没发现UIPageViewController，UISplitViewController等方法的hook，可以自己实现来扩展此。
追踪泄漏
willDealloc是一个重要的方法。在之前的追踪到一个页面需要释放的时候会调用此方法，而这个方法做了什么呢？，在NSObject的MemoryLeak分类里面可以找到这个答案。
NSString *className = NSStringFromClass([self class]);
if ([[NSObject classNamesInWhiteList] containsObject:className])
return NO;
NSNumber *senderPtr = objc_getAssociatedObject([UIApplication sharedApplication], kLatestSenderKey);
if ([senderPtr isEqualToNumber:@((uintptr_t)self)])
return NO;
__weak id weakSelf = self;
dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(2 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
__strong id strongSelf = weakSelf;
[strongSelf assertNotDealloc];
});
return YES;
代码清晰易懂，其原理是首先判断这个类是不是在白名单之中，如果是则忽略它，这也就是上文提过的白名单机制了，下面一段代码很有意思，
NSNumber * senderPtr = objc_getAssociatedObject（[UIApplication sharedApplication]，kLatestSenderKey）;
这个方法是干嘛的呢，这就得提到UIControl的target-action机制了，具体可以参考这篇文章。此代码的意义在与，如果当前的对象在发送actionize忽略它（因为willDealloc总会先于他们调用），之后设置一个弱指针，在调用dispatch_after在2秒后调用assertNotDealloc方法，如果还没释放，那么会进入这个方法，如果已经释放了，那么这个方法是进不去的。
报告泄漏
当进入assertNotDealloc方法，很不幸，这个对象极有可能泄泄了，这个时候应该做的报告此处发生了泄漏
- (void)assertNotDealloc {
if ([MLeakedObjectProxy isAnyObjectLeakedAtPtrs:[self parentPtrs]]) {
return;
}
[MLeakedObjectProxy addLeakedObject:self];
NSString *className = NSStringFromClass([self class]);
NSLog(@"Possibly Memory Leak.\nIn case that %@ should not be dealloced, override -willDealloc in %@ by returning NO.\nView-ViewController stack: %@", className, className, [self viewStack]);
}
MLeaksFinder是如何报告的呢，我们一步追踪，
首先
if ([MLeakedObjectProxy isAnyObjectLeakedAtPtrs:[self parentPtrs]]) {
return;
}
这个是什么东西，
@interface MLeakedObjectProxy : NSObject
+ (BOOL)isAnyObjectLeakedAtPtrs:(NSSet *)ptrs;
+ (void)addLeakedObject:(id)object;
@end
可以看出这个是泄漏对象的代理，这个对象只有2个类方法，分别是做什么的呢，先来看isAnyObjectLeakedAtPtrs这个方法
+ (BOOL)isAnyObjectLeakedAtPtrs:(NSSet *)ptrs {
NSAssert([NSThread isMainThread], @"Must be in main thread.");
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
leakedObjectPtrs = [[NSMutableSet alloc] init];
});
if (!ptrs.count) {
return NO;
}
if ([leakedObjectPtrs intersectsSet:ptrs]) {
return YES;
} else {
return NO;
}
}
结合上文中的assertNotDealloc方法可以看出，这个方法主要是判断当前这个对象时候已经添加到了泄漏对象名单，如果是，那么就不在添加了。
还有一个addLeakedObject方法，看名字不难看出是将泄漏对象添加到泄漏对象名单，以下下是其具体实现
+ (void)addLeakedObject:(id)object {
NSAssert([NSThread isMainThread], @"Must be in main thread.");
MLeakedObjectProxy *proxy = [[MLeakedObjectProxy alloc] init];
proxy.object = object;
proxy.objectPtr = @((uintptr_t)object);
proxy.viewStack = [object viewStack];
static const void *const kLeakedObjectProxyKey = &kLeakedObjectProxyKey;
objc_setAssociatedObject(object, kLeakedObjectProxyKey, proxy, OBJC_ASSOCIATION_RETAIN);
[leakedObjectPtrs addObject:proxy.objectPtr];
#if _INTERNAL_MLF_RC_ENABLED
[MLeaksMessenger alertWithTitle:@"Memory Leak"
message:[NSString stringWithFormat:@"%@", proxy.viewStack]
delegate:proxy
additionalButtonTitle:@"Retain Cycle"];
#else
[MLeaksMessenger alertWithTitle:@"Memory Leak"
message:[NSString stringWithFormat:@"%@", proxy.viewStack]];
#endif
}
可以看出，构造了一个MLeakedObjectProxy对象，并将其加入到leakedObjectPtrs集合中，弹出alert框，然后需要找到引用环，将此对象指针传给FBRetainCycleDetector来确定循环引用发生在哪里（这块功能是0.2版本新增的）。之后在屏幕上打印出堆栈信息，看到这里，还有一个疑问：MLeaksFinder是如何构建堆栈？
构建堆栈信息
我们可以注意到，在UIViewController的分类中有这样一段代码
- (BOOL)willDealloc {
if (![super willDealloc]) {
return NO;
}
[self willReleaseChildren:self.childViewControllers];
[self willReleaseChild:self.presentedViewController];
if (self.isViewLoaded) {
[self willReleaseChild:self.view];
}
return YES;
}
其中willReleaseChildren，willReleaseChild就是构造堆栈信息的秘密所在，我们可以看到NSObject分类中的实现方法
- (void)willReleaseChild:(id)child {
if (!child) {
return;
}
[self willReleaseChildren:@[ child ]];
}
- (void)willReleaseChildren:(NSArray *)children {
NSArray *viewStack = [self viewStack];
NSSet *parentPtrs = [self parentPtrs];
for (id child in children) {
NSString *className = NSStringFromClass([child class]);
[child setViewStack:[viewStack arrayByAddingObject:className]];
[child setParentPtrs:[parentPtrs setByAddingObject:@((uintptr_t)child)]];
[child willDealloc];
}
}
- (NSArray *)viewStack {
NSArray *viewStack = objc_getAssociatedObject(self, kViewStackKey);
if (viewStack) {
return viewStack;
}
NSString *className = NSStringFromClass([self class]);
return @[ className ];
}
- (void)setViewStack:(NSArray *)viewStack {
objc_setAssociatedObject(self, kViewStackKey, viewStack, OBJC_ASSOCIATION_RETAIN);
}
willReleaseChildren和willReleaseChild方法的作用是向这个对象之中的子对象调用释放的方法，如视图的子视图，UINavigationController的视图控制器等等的子对象。构造堆栈信息的原理就是，递归遍历子对象，然后将父对象class名称加上子对象类名，一步构造出一个视图栈。出现泄漏则直接打印此对象的视图栈即可。
其他
在UIViewController侧滑的时候释放方法需要做特殊的处理，在MLeaksFinder中添加了kHasBeenPoppedKey属性来判断是否释放代码如下
//设置侧滑的key
- (UIViewController *)swizzled_popViewControllerAnimated:(BOOL)animated {
UIViewController *poppedViewController = [self swizzled_popViewControllerAnimated:animated];
if (!poppedViewController) {
return nil;
}
// Detail VC in UISplitViewController is not dealloced until another detail VC is shown
...
// VC is not dealloced until disappear when popped using a left-edge swipe gesture
extern const void *const kHasBeenPoppedKey;
objc_setAssociatedObject(poppedViewController, kHasBeenPoppedKey, @(YES), OBJC_ASSOCIATION_RETAIN);
return poppedViewController;
}
//发现是侧滑则直接调用willDealloc方法
- (void)swizzled_viewDidDisappear:(BOOL)animated {
[self swizzled_viewDidDisappear:animated];
if ([objc_getAssociatedObject(self, kHasBeenPoppedKey) boolValue]) {
[self willDealloc];
}
}
总结
总得来说MLeaksFinder是一个质量很高的库，在实用性和便利性上做到了完美结合，日常开发中也为我们的项目寻找到了泄漏点，值得一用，至于FBRetainCycleDetector如何检测循环引用环，那得发一篇文章的篇幅来介绍了
作者：MaZengyi
链接：https://www.jianshu.com/p/ccf3014ca6a6
來源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
扫一扫
2504
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
