LeakCanary实现原理浅析

LeakCanary是一个在安卓平台上检测内存泄漏的工具库。

粗略的看了以下LeakCanary的实现原理。

LeakCanary地址

工程目录

工程目录

• leakcanary-analyzer

  负责分析内存泄漏，主要使用了com.squareup.haha:haha库来分析

• leakcanary-android

  负责android的接入

• leakcanary-android-no-op

  空实现，就2个类，release后引用的空包

• leakcanary-sample

  如何使用LeakCanary的示例

• leackcanary-watcher
  负责监视对象是否泄漏

工作流程

1. 安装LeakCanary
   安装LeakCanary过程中注册监听Activity的生命周期。
2. 监听Activity生命周期，当Activity发生destroyed的时候，弱引用Activity为KeyedWeakReference。
3. 当主线程空闲的时候执行GC操作，判断弱引用是否释放。
4. 弱引用没有释放，则找到内存泄漏，进行内存泄漏分析，之后通知和展示。

源码解析

看源码的时候，从初始化入手，然后找到核心链路。

1. 安装过程

初始化的安装流程最终调用的是

   /**
   *
   * @param application
   * @param listenerServiceClass 默认传递 DisplayLeakService.class
   * @param excludedRefs 排除的情况 默认为AndroidExcludedRefs.createAppDefaults().build() 
   * @return
   */
  public static RefWatcher install(Application application,
      Class listenerServiceClass,
      ExcludedRefs excludedRefs) {
    //是否在分析的进程（HeapAnalyzerService进程）
    if (isInAnalyzerProcess(application)) {
      return RefWatcher.DISABLED;
    }
    //在桌面显示内存泄漏Activity(DisplayLeakActivity)的图标
    enableDisplayLeakActivity(application);
    //启用分析的回调 结果会启用HeapAnalyzerService进行HeapDump分析来找出泄漏的源头
    HeapDump.Listener heapDumpListener =
        new ServiceHeapDumpListener(application, listenerServiceClass);
    //监视器 leakcanary核心部分 后面会分析
    RefWatcher refWatcher = androidWatcher(application, heapDumpListener, excludedRefs);
    //把Activity列为监视器的监视对象 通过监听Activity发生destroyed
    ActivityRefWatcher.installOnIcsPlus(application, refWatcher);
    return refWatcher;
  }

install主要做了3件事情

1. 在桌面启用DisplayLeakActivity的图标
2. 初始化监听器RefWatcher，并监听Activity
3. 在监听到有内存泄漏后调用heapDumpListener来启用HeapAnalyzerService

2. RefWatcher
   RefWatcher是leackcanary的核心，他负责监听内存泄漏是否发生。

RefWatcher的成员变量

  //监听执行器 实现类 AndroidWatchExecutor 核心代码 Looper.myQueue().addIdleHandler(IdleHandler)
  private final Executor watchExecutor;
  //负责日志输出 实现类 AndroidDebuggerControl 通过Debug.isDebuggerConnected()来判断是否输出日志
  private final DebuggerControl debuggerControl;
  //GC触发器 抄AOSP代码 https://android.googlesource.com/platform/libcore/+/master/support/src/test/java/libcore/java/lang/ref/FinalizationTester.java
  private final GcTrigger gcTrigger;
  //进行headDump操作 实现类 AndroidHeapDumper 核心代码 Debug.dumpHprofData(heapDumpFile.getAbsolutePath()); 另外还做了一个5s超时处理 超时实现方法可以参考下^_^
  private final HeapDumper heapDumper;
  //保存在监听的对象 如果GC后还存在里面 说明内存泄漏了
  private final Set retainedKeys;
  //内存被成功回收会进入该队列 然后会更新retainedKeys
  private final ReferenceQueue