簡介

MLeaksFinder是WeRead團隊開源的一個檢測iOS記憶體洩漏的框架，其使用非常簡單，只需將檔案加入專案中，如果有記憶體洩漏，3秒後自動彈出警告來捕捉迴圈引用。使得可以在開發快速找到80％記憶體洩漏，而使用Xcode Leak工具更適合大範圍的，全部的尋找洩漏點。

特性

通過閱讀MLeaksFinder的介紹可以看出其具有以下幾個特性

1. 無侵入性
2. 可以構建洩漏堆疊
3. 有白名單機制
4. 擴充套件性
5. 其他的一些特殊處理

深入原始碼

實現的核心

在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如何檢測迴圈引用環，那得發一篇文章的篇幅來介紹了