FBRetainCycleDetector框架详细解析（一）

版本记录

版本号	时间
V1.0	2017.09.25

前言

在APP中，内存是极其宝贵的资源，但是由于程序员的代码有时候会大意而出现问题，容易引起leak，其中循环引用就是引起leak的主要原因之一，FBRetainCycleDetector框架就可以检查循环引用的问题。下面我们就详细的解析这个框架，这里先给出 Github - FBRetainCycleDetector。

关于

它是Facebook开发的使用运行时分析找到循环引用的iOS库。

循环引用是创建内存泄漏的最常见方式之一。创建一个循环引用是非常容易的，往往很难发现。FBRetainCycleDetector的目标是帮助在运行时找到循环引用。

安装

1. Carthage

在你的Cartfile中加入：

github "facebook/FBRetainCycleDetector"

使用时

carthage update --configuration Debug

2. CocoaPods

pod 'FBRetainCycleDetector'

使用示例

首先引入头文件

#import <FBRetainCycleDetector/FBRetainCycleDetector.h>

FBRetainCycleDetector *detector = [FBRetainCycleDetector new];
[detector addCandidate:myObject];
NSSet *retainCycles = [detector findRetainCycles];
NSLog(@"%@", retainCycles);

- (NSSet<NSArray<FBObjectiveCGraphElement *> *> *)findRetainCycles将返回一组包装对象的数组。起初很难看，但让我们来看看。该集合中的每个数组将表示一个运行循环。该数组中的每个元素都是在该保留周期中围绕一个对象的包装。

输出如下所示：

{(
    (
        "-> MyObject ",
        "-> _someObject -> __NSArrayI "
    )
)}

MyObject通过someObject属性保留了NSArray。

FBRetainCycleDetector将寻找不超过10个对象的循环。我们可以使它更大（尽管它会变慢！）。

FBRetainCycleDetector *detector = [FBRetainCycleDetector new];
[detector addCandidate:myObject];
NSSet *retainCycles = [detector findRetainCyclesWithMaxCycleLength:100];

1. 过滤

也可能有留下的循环引用，我们想忽略。这是因为不是每个循环引用都是泄漏的，我们可能想要过滤掉它们。为此，我们需要指定过滤器：

NSMutableArray *filters = @[
  FBFilterBlockWithObjectIvarRelation([UIView class], @"_subviewCache"),
];

// Configuration object can describe filters as well as some options
FBObjectGraphConfiguration *configuration =
[[FBObjectGraphConfiguration alloc] initWithFilterBlocks:filters
                                     shouldInspectTimers:YES];
FBRetainCycleDetector *detector = [[FBRetainCycleDetector alloc] initWithConfiguration:configuration];
[detector addCandidate:myObject];
NSSet *retainCycles = [detector findRetainCycles];

每个过滤器都是一个有两个FBObjectiveCGraphElement对象的块决定，如果它们的关系是有效的。详细的可参考FBStandardGraphEdgeFilters

2. 定时器

NSTimer可能很麻烦，因为它会保留它的目标。通常这意味着引用循环。 FBRetainCycleDetector可以检测到这些，但是如果要跳过它们，可以在配置中指定要传递给FBRetainCycleDetector。

FBObjectGraphConfiguration *configuration =
[[FBObjectGraphConfiguration alloc] initWithFilterBlocks:someFilters
                                     shouldInspectTimers:NO];
FBRetainCycleDetector *detector = [[FBRetainCycleDetector alloc] initWithConfiguration:configuration];

3. 关联

我们使用Objective-C，使用objc_setAssociatedObject为每个对象设置关联对象。

如果我们使用引用策略（如OBJC_ASSOCIATION_RETAIN_NONATOMIC），这些关联对象可能会导致引用循环。 FBRetainCycleDetector可以捕获这些类型的循环，但是要做到这一点，我们需要设置它们。在应用程序的生命周期中，最好在main.m中，我们可以添加：

#import <FBRetainCycleDetector/FBAssociationManager.h>

int main(int argc, char * argv[]) {
  @autoreleasepool {
    [FBAssociationManager hook];
    return UIApplicationMain(argc, argv, nil, NSStringFromClass([AppDelegate class]));
  }
}

在上面的代码中，[FBAssociationManager hook]将使用fishhook来插入函数objc_setAssociatedObject和objc_resetAssociatedObjects，以便在创建之前跟踪关联。

后记

未完，待续~~~

最后编辑于：2017.12.10 17:56:29