LeakCanary源码浅析

在Android开发中最让人们头疼的就是内存泄漏了，今天来介绍一个查看内存是否泄漏的工具LeakCanary，并通过研究源码明白它是如何分析和查找存在泄漏信息的
首先送上LeakCanary文档链接:LeakCanary中文使用说明

Part1. 知识回顾

常用工具

• 1. Mat
• 2. LeakCanary(Square）
     原理:watch监视一个即将要销毁的对象

内存种类

• 1、栈（stack-基本数据类型，对象的引用）
• 2、堆（heap-存放new出来的对象和数组，在堆中分配内存由GC管理）
• 3、方法区（method,大体和堆一样）

为什么会产生内存泄漏

• 当一个对象已经不需要再使用了，在该对象被回收时候，有另外的对象引用该回收对象，导致本该被回收的对象无法回收
• 有些对象只有有限的生命周期，当生命周期很短的完成任务后，在本该结束的生命周期中仍然被引用

内存泄漏会导致什么问题

1. OOM

常见的内存泄漏情况

1. 单例造成的内存泄漏
2. 非静态内部类创建静态实例造成的内存泄漏
3. handler造成内存泄漏（handler、message、MessageQueue）
   解决方法：
   ①将Handler声明为静态类型
   ②通过弱引用的方式引入Activity
4. 线程造成的内存泄漏（解决方法:将线程定义声明为static类型）
5. webview造成的内存泄漏（example：加载页面很复杂，Ex:大量的图片）

Part2 概念

引用类型

1. 强引用（StrongReference），默认对象一般为强引用
2. 软引用（SoftReference），当内存空间足够大时相当于强引用，内存不够时通过垃圾回收器（GC）自动回收
3. 弱引用（WeakReference），当GC扫描到该类型的引用时就自己回收
4. 虚引用，相当于没有进行引用，GC可随时回收该类型的引用

ReferenceQueue

1. 软引用和弱引用都持有该对象
2. 对象被垃圾回收，Java虚拟机就会把这个引用加入到与之相关联的引用队列中

Part3.LeakCanary使用

1. 在module层级中的build.gradle中加入引用，不同的编译使用不同的引用

dependencies {
    debugCompile 'com.squareup.leakcanary:leakcanary-android:1.3'
    releaseCompile 'com.squareup.leakcanary:leakcanary-android-no-op:1.3'
}

2.在Application中:

public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        LeakCanary.install(this);
    }
}

3.在Manifest.xml中加载该Application文件

Part4. LeakCanary源码剖析

从代码入口剖析:

 LeakCanary.install(this);

跟踪源码可知

/**
   * Creates a {@link RefWatcher} that works out of the box, and starts watching activity
   * references (on ICS+).
   */
  public static RefWatcher install(Application application) {
    return install(application, DisplayLeakService.class);
  }

从上面的代码我们发现这个方法最终返回给我们一个RefWatcher这个类，这个类是主要是启动ActivityRefWatcher类，ActivityRefWatcher在Activity的onDestory方法结束时检测内存泄漏。

看下install这个方法:

/**
   * Creates a {@link RefWatcher} that reports results to the provided service, and starts watching
   * activity references (on ICS+).
   */
  public static RefWatcher install(Application application,
      Class listenerServiceClass) {
    if (isInAnalyzerProcess(application)) {
      return RefWatcher.DISABLED;
    }
    enableDisplayLeakActivity(application);
    HeapDump.Listener heapDumpListener =
        new ServiceHeapDumpListener(application, listenerServiceClass);
    RefWatcher refWatcher = androidWatcher(application, heapDumpListener);
    ActivityRefWatcher.installOnIcsPlus(application, refWatcher);
    return refWatcher;
  }

通过RefWatcher refWatcher = androidWatcher(application, heapDumpListener)创建一个RefWatcher对象，启动activityRefWatcher来监视内存泄漏
enableDisplayLeakActivity(application)主要作用是开启DisplayLeakActivity这个类，这个类主要是显示内存泄漏的弹框页面

ActivityRefWatcher.installOnIcsPlus(application, refWatcher);

public static void installOnIcsPlus(Application application, RefWatcher refWatcher) {
    if (SDK_INT < ICE_CREAM_SANDWICH) {
      // If you need to support Android < ICS, override onDestroy() in your base activity.
      return;
    }
    ActivityRefWatcher activityRefWatcher = new ActivityRefWatcher(application, refWatcher);
    activityRefWatcher.watchActivities();
  }
 public void watchActivities() {
    // Make sure you don't get installed twice.
    stopWatchingActivities();
    application.registerActivityLifecycleCallbacks(lifecycleCallbacks);
  }
  public void stopWatchingActivities() {
    application.unregisterActivityLifecycleCallbacks(lifecycleCallbacks);
  }

小结：
①通过stopWatcher方法反注册以前的Activity的生命周期的callback，目的是为了保证以前的内存泄漏的activity删除
②重新注册activity生命周期的callback
③通过lifecycleCallbacks中的onActivityDestroyed方法将activity的生命周期和ActivityReference关联起来

 @Override 
  public void onActivityDestroyed(Activity activity) {
     ActivityRefWatcher.this.onActivityDestroyed(activity);
        }

跟踪onActivityDestroyed方法发现通过调用RefWatcher调用了watcher类

void onActivityDestroyed(Activity activity) {
    refWatcher.watch(activity);
  }

  private final RefWatcher refWatcher

下面我们进入RefWatcher类中发现有如下的变量信息

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