iOS-MLeaksFinder详解

目录
  • 使用实例
  • 原理分析
  • 特性
  • 深入源码
    • 寻找释放点
    • 追踪泄露
    • 报告泄露
    • 构建堆栈信息
    • 侧滑返回特殊处理
序言

MLeaksFinder 是WeRead团队开源的一款检测 iOS 内存泄漏的框架，其使用非常简单，只需将文件加入项目中，如果有内存泄漏，2秒后自动弹出 alert 来捕捉循环引用。使得可以在开发快速找到大多数内存泄漏，而使用 Xcode Leak 工具更适合大范围的，全部的寻找泄漏点。

WeRead团队博客关于MLeaksFinder的介绍
MLeaksFinder：精准 iOS 内存泄露检测工具

一 使用实例

1.直接将MLeaksFinder文件夹导入项目中或者使用pod 'MLeaksFinder'都可以

  1. ViewControllerpush进FirstViewController页面，然后在FirstViewController开启一个定时器，然后点击返回。
@property(nonatomic,strong)NSTimer *timer;

- (void)addTimer {
    _timer = [NSTimer timerWithTimeInterval:1.0 target:self selector:@selector(updateTimer) userInfo:nil repeats:YES];
    [[NSRunLoop mainRunLoop] addTimer:_timer forMode:NSRunLoopCommonModes];
}

- (void)updateTimer {
    NSLog(@"%s",__func__);
}

执行结果

1.gif
二 原理分析

在 MLeaksFinder 的博客介绍中可以清晰的知道其的工作原理，引用博文所说

MLeaksFinder 一开始从 UIViewController 入手。我们知道，当一个 UIViewController 被 pop 或 dismiss 后，该 UIViewController 包括它的 view，view 的 subviews 等等将很快被释放（除非你把它设计成单例，或者持有它的强引用，但一般很少这样做）。于是，我们只需在一个 ViewController 被 pop 或 dismiss 一小段时间后，看看该 UIViewController，它的 view，view 的 subviews 等等是否还存在。

具体的方法是，为基类 NSObject 添加一个方法 -willDealloc 方法，该方法的作用是，先用一个弱指针指向 self，并在一小段时间(2秒)后，通过这个弱指针调用 -assertNotDealloc，而 -assertNotDealloc 主要作用是直接中断言。

- (BOOL)willDealloc {
    __weak id weakSelf = self;
    dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(2 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
        [weakSelf assertNotDealloc];
    });
    return YES;
}
- (void)assertNotDealloc {
     NSAssert(NO, @“”);
}

这样，当我们认为某个对象应该要被释放了，在释放前调用这个方法，如果2秒后它被释放成功，weakSelf 就指向 nil，不会调用到 -assertNotDealloc 方法，也就不会中断言，如果它没被释放（泄露了），-assertNotDealloc 就会被调用中断言。这样，当一个 UIViewController 被 pop 或 dismiss 时（我们认为它应该要被释放了），我们遍历该 UIViewController 上的所有 view，依次调 -willDealloc，若2秒后没被释放，就会中断言。

总结起来一句话就是，当一个对象3秒之后还没释放，那么指向它的 weak 指针还是存在的，所以可以调用其 runtime 绑定的方法 willDealloc 从而提示内存泄漏。

三 特性

通过阅读 MLeaksFinder 的介绍可以看出其具有以下几个特性

  • 无侵入性
  • 可以构建泄漏堆栈
  • 有白名单机制
  • 扩展性
  • 其他的一些特殊处理
四 深入源码

先看看文件目录结构

image.png

通过文件目录结构，我们知道MLeaksFinder主要是实现了几个重要类的分类，包括UINavigationController，UITabBarController，UIViewController，UIView，NSObject，UIApplication等分类。

4.1 寻找释放点

论无侵入性的最佳实践还是使用 AOP 面向切面的编程，通过 Method Swizzling 系统方法来添加额外的功能。

接下来我们以UIViewController为例

  • UIViewController+MemoryLeak.h,其 Swizzling 了几个 ViewController 释放方法
[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:方法来跟踪一个viewcontroller 的释放

- (void)swizzled_viewDidDisappear:(BOOL)animated {
    [self swizzled_viewDidDisappear:animated];
    
    if ([objc_getAssociatedObject(self, kHasBeenPoppedKey) boolValue]) {
        [self willDealloc];
    }
}

- (void)swizzled_viewWillAppear:(BOOL)animated {
    [self swizzled_viewWillAppear:animated];
    
    objc_setAssociatedObject(self, kHasBeenPoppedKey, @(NO), OBJC_ASSOCIATION_RETAIN);
}

在swizzled_viewWillAppear和swizzled_viewDidDisappear里面关联了一个变量kHasBeenPoppedKey，其作用是标记当前VC是否出栈，也就是说只有当其出栈后，再在swizzled_viewDidDisappear方法中校验是否发生内存泄露才有意义。

该变量kHasBeenPoppedKey只有在当前控制器出栈时才会设置为YES，设置位置在UINavigationController+MemoryLeak分类中

- (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
    if (self.splitViewController &&
        self.splitViewController.viewControllers.firstObject == self &&
        self.splitViewController == poppedViewController.splitViewController) {
        objc_setAssociatedObject(self, kPoppedDetailVCKey, poppedViewController, OBJC_ASSOCIATION_RETAIN);
        return poppedViewController;
    }
    
    // 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;
}
  • UINavigationController+MemoryLeak.h，Swizzling了几个常用的pop和push方法
[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:)];
4.2 追踪泄漏

通过代码查找，我们发现追踪到一个页面需要释放的时候会调用一个叫willDealloc的方法，该方法在 NSObject+MemoryLeak 分类里面， 而这个方法做了什么呢？

- (BOOL)willDealloc {
    NSString *className = NSStringFromClass([self class]);
    if ([[NSObject classNamesWhitelist] 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;
}

源码解读

[[NSObject classNamesWhitelist] containsObject:className]

首先判断这个 class 是不是在白名单之中，如果是则忽略它， 这也就是上文提过的白名单机制了。

NSNumber *senderPtr = objc_getAssociatedObject([UIApplication sharedApplication], kLatestSenderKey);
if ([senderPtr isEqualToNumber:@((uintptr_t)self)])
    return NO;

这个方法是干嘛的呢，这就得提到 UIControl 的target-action 机制了，此段代码的意义在与，如果当前的对象在发送 action 则忽略它（因为 willDealloc 总会先于他们调用）。

__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];
});

之后设置一个 weak 指针，在调用 dispatch_after 在2秒后调用 assertNotDealloc 方法，如果还没释放，那么会进入这个方法，如果已经释放了，那么这个方法是进不去的。

4.3 报告泄漏

当进入 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 是如何报告的呢，我们一步步追踪代码分析

  • 1 是否已经添加进泄漏对象名单
- (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]);
}

- (NSSet *)parentPtrs {
    NSSet *parentPtrs = objc_getAssociatedObject(self, kParentPtrsKey);
    if (!parentPtrs) {
        parentPtrs = [[NSSet alloc] initWithObjects:@((uintptr_t)self), nil];
    }
    return parentPtrs;
}

这个方法主要是判断当前这个对象时候已经添加到了泄漏对象名单，如果是，那么就不在添加了，否则就添加。

  • MLeakedObjectProxy类中
// 是否添加进内存泄露名单
+ (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;
    }
}

// 添加进内存泄露名单
+ (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 是如何构建堆栈？

4.4 构建堆栈信息

我们可以注意到，在 UIViewController 的分类中有这样一段代码

  • UIViewController+MemoryLeak.h
- (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+MemoryLeak分类中的实现方法

- (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];
    }
}

// 通过关联对象kViewStackKey获取值,如果为空,则创建
- (NSArray *)viewStack {
    NSArray *viewStack = objc_getAssociatedObject(self, kViewStackKey);
    if (viewStack) {
        return viewStack;
    }
    
    NSString *className = NSStringFromClass([self class]);
    return @[ className ];
}

// 关联 kViewStackKey 对象,并将viewStack值保存到kViewStackKey中
- (void)setViewStack:(NSArray *)viewStack {
    objc_setAssociatedObject(self, kViewStackKey, viewStack, OBJC_ASSOCIATION_RETAIN);
}

// 通过关联对象kParentPtrsKey获取值,如果为空,则创建
- (NSSet *)parentPtrs {
    NSSet *parentPtrs = objc_getAssociatedObject(self, kParentPtrsKey);
    if (!parentPtrs) {
        parentPtrs = [[NSSet alloc] initWithObjects:@((uintptr_t)self), nil];
    }
    return parentPtrs;
}

// 关联 kParentPtrsKey 对象,并将viewStack值保存到parentPtrs中
- (void)setParentPtrs:(NSSet *)parentPtrs {
    objc_setAssociatedObject(self, kParentPtrsKey, parentPtrs, OBJC_ASSOCIATION_RETAIN);
}

willReleaseChildren 和willReleaseChild 方法的作用是向这个对象之中的子对象调用释放的方法，如 view 的 subviews， UINavigationController 的 viewcontrollers 等等的子对象。构造堆栈信息的原理就是，递归遍历子对象，然后将父对象 class name 加上子对象 class name，一步步构造出一个 view stack。出现泄漏则直接打印此对象的 view stack 即可。

4.5 侧滑返回特殊处理

在 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
    if (self.splitViewController &&
        self.splitViewController.viewControllers.firstObject == self &&
        self.splitViewController == poppedViewController.splitViewController) {
        objc_setAssociatedObject(self, kPoppedDetailVCKey, poppedViewController, OBJC_ASSOCIATION_RETAIN);
        return poppedViewController;
    }
    
    // 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;
}
总结

总得来说 MLeaksFinder 是一个质量很高的库，在实用性和便利性上做到了完美结合，日常开发中也为我们的项目寻找到了泄漏点。

本文参考
MLeaksFinder
MLeaksFinder：精准 iOS 内存泄露检测工具

项目连接地址 - MLeaksFinderDemo

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 156,907评论 4赞 360
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 66,546评论 1赞 289
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 106,705评论 0赞 238
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 43,624评论 0赞 203
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 51,940评论 3赞 285
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 40,371评论 1赞 210
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 31,672评论 2赞 310
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 30,396评论 0赞 195
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 34,069评论 1赞 238
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,350评论 2赞 242
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,876评论 1赞 256
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 28,243评论 2赞 251
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 32,847评论 3赞 231
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,004评论 0赞 8
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,755评论 0赞 192
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 35,378评论 2赞 269
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 35,266评论 2赞 259

推荐阅读更多精彩内容

  • iOS 内存泄露监测
    iOS可能存在的内存泄露： block 循环引用。当一个对象有一个block属性，而block属性又引用这个对象本...
    谢谢生活阅读 3,124评论 0赞 23
  • 内存泄漏的检测
    一:block内部可能存在的self的集中使用情况 (1)什么时候在 block 里面用 self，不需要使用 w...
    雷鸣1010阅读 1,182评论 0赞 1
  • MLeaksFinder 源码学习笔记
    0.前言 项目中集成了 MLeaksFinder 用于平时检测内存泄漏之用，它的基本工作原理也多少了解一些，最近恰...
    RiverSea阅读 3,019评论 1赞 12
  • 迷糊的迷失的迷茫的孩子
    我还是个孩子 迷糊的孩子 我还是个孩子 迷失的孩子 一直是个孩子 迷茫的孩子 要是青春 没有那么多假设 要是我 没...
    邦彦尘阅读 144评论 0赞 0
  • 振华与你共勉
    不要抱怨辅导孩子写作业累人, 用不了几年, 晚上,你看着孩子房间熄灭的台灯, 一片漆黑。会怀念那个小小的背影, 坐...
    完颜古方张振华阅读 428评论 0赞 0