LeakCanary 源码深挖

一、前言

LeakCanary 是 Android 端用于自动检测内存泄漏的开源库，使用这个工具可以方便的监控 Activity 和 Fragment 的内存泄漏情况, 并且提供了可视化界面, 可以在开发过程中很好的暴露和排查问题。基于 LeakCanary 1.5.4 源码。

二、怎样使用？

添加依赖

dependencies {
    ......
    implementation 'com.squareup.leakcanary:leakcanary-android:1.5.4'
    ......
}

编写 LeakCanary 使用工具类 LeakCanaryUtil.java

public class LeakCanaryUtil {

    private static RefWatcher sRefWatcher;

    public static void init(@NonNull Application application) {
        if (!BuildConfig.DEBUG) {
            return;
        }
        if (LeakCanary.isInAnalyzerProcess(application)) {
            return;
        }
        sRefWatcher = LeakCanary.install(application);
    }

    public static void watch(@Nullable Object obj) {
        if (sRefWatcher == null || obj == null) {
            return;
        }
        sRefWatcher.watch(obj);
    }

}

在 Application 中初始化

public class MyApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        LeakCanaryUtil.init(this);
    }
}

设置内存泄漏监控 BaseFragment.java

public abstract class BaseFragment extends Fragment {
   
    @Override
    public void onDetach() {
        LeakCanaryUtil.watch(this);
    }

}

三、怎样检测到内存泄漏的？

在 Application 中， LeakCanary 的 install 方法的构建一个 RefWatcher 对象, 并且初始化它

public final class LeakCanary {
    
  public static RefWatcher install(Application application) {
    return refWatcher(application)
               .listenerServiceClass(DisplayLeakService.class)
               .excludedRefs(AndroidExcludedRefs.createAppDefaults().build())
               .buildAndInstall();	// 分析 1
  }
    
  public static AndroidRefWatcherBuilder refWatcher(Context context) {
    return new AndroidRefWatcherBuilder(context);	// 分析 2
  }
  
}

分析 1 可以看到这是一个构建者的链式调用, 最终通过 buildAndInstall 来完成对 RefWatcher 的构建和安装。分析 2 可以看到这个 RefWatcher 对象通过 AndroidRefWatcherBuilder.buildAndInstall 创建，那么，我们看一下 AndroidRefWatcherBuilder.buildAndInstall 做了什么。

public final class AndroidRefWatcherBuilder extends RefWatcherBuilder {
    
  public RefWatcher buildAndInstall() {
    // 通过 build 构建实例对象
    RefWatcher refWatcher = build();	// 分析 1
    if (refWatcher != DISABLED) {
      // 注册内存泄漏监听
      ActivityRefWatcher.install((Application) context, refWatcher);	// 分析 2
    }
    return refWatcher;
  }  
    
}

可以看到 AndroidRefWatcherBuilder.buildAndInstall 中, 主要做了两步操作

• 通过 build 方法, 创建 RefWatcher 对象
• 调用 ActivityRefWatcher.install 注册来监听内存泄漏

下面我们接着看分析 1 中 build() 方法，其使用了 builder 设计模式去构建初始化对象

public class RefWatcherBuilder> {
    
  /** Creates a {@link RefWatcher}. */
  public final RefWatcher build() {
    if (isDisabled()) {
      return RefWatcher.DISABLED;
    }
    ......
    // 构建 RefWatcher 对象
    return new RefWatcher(watchExecutor, debuggerControl, gcTrigger, heapDumper, heapDumpListener,
        excludedRefs);
  }  
    
}

public final class RefWatcher {

  public static final RefWatcher DISABLED = new RefWatcherBuilder<>().build();

  private final WatchExecutor watchExecutor;
  private final DebuggerControl debuggerControl;
  private final GcTrigger gcTrigger;
  private final HeapDumper heapDumper;
  private final Set retainedKeys;
  private final ReferenceQueue