大家知道Android系統(tǒng)對(duì)app的內(nèi)存有一個(gè)上限，如果代碼風(fēng)格不好，業(yè)務(wù)龐大，時(shí)間緊沒有代碼評(píng)審來(lái)約束，是很容易引起OOM異常的，通常我們碰到這種問題，需要用profile工具去仔細(xì)的分析和排查，才能找到可能的原因?，F(xiàn)在向大家介紹LeakCanary，是一款監(jiān)測(cè)內(nèi)存泄露的工具，由大名鼎鼎的Square公司開發(fā)并開源。

基本用法

參見LeakCanary官方的介紹，一步搞定！
官網(wǎng)介紹的方法非常簡(jiǎn)單，可以自動(dòng)監(jiān)測(cè)Activity泄露，原理很直接，就是用application的ActivityLifeCycleCallback，在onActivityDestroyed時(shí)去watch。那我們遵循這個(gè)套路，自己構(gòu)建一個(gè)RefWatcher，就可以做到監(jiān)聽任何一個(gè)實(shí)例，只需要在該實(shí)例理論上應(yīng)該銷毀的時(shí)候watch一下就可以了。此處說銷毀并不是真的要銷毀，而是沒有引用，也就是所謂的jvm內(nèi)存管理的不可達(dá)狀態(tài)。

原理

jvm內(nèi)存管理

我們知道，java相對(duì)C++有一個(gè)巨大的好處就是可以不用做復(fù)雜且容易出錯(cuò)的內(nèi)存管理，jvm有一個(gè)內(nèi)存回收器會(huì)周期性的回收不用的內(nèi)存，細(xì)節(jié)性的東西很多，也不影響我們理解LeakCanary的原理，我們暫且跳過。只需知道jvm會(huì)自動(dòng)幫我們回收不需要的內(nèi)存，但是還是有內(nèi)存泄露的可能。

總體設(shè)計(jì)圖

流程圖

Main.jpg

核心類介紹

LeakCanary

入口類。接口很簡(jiǎn)單，簡(jiǎn)單到只有一個(gè)install函數(shù)就可以運(yùn)行，默認(rèn)配置已經(jīng)可以應(yīng)對(duì)絕大部分場(chǎng)景，除非你想定制一些行為。

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

/** Builder to create a customized {@link RefWatcher} with appropriate Android defaults. */
  public static AndroidRefWatcherBuilder refWatcher(Context context) {
    return new AndroidRefWatcherBuilder(context);
  }

對(duì)設(shè)計(jì)模式有了解，或者看過一些開源框架的代碼，可能知道這塊使用了Builder模式，這個(gè)Builder其實(shí)很好理解，個(gè)人認(rèn)為主要的使用場(chǎng)景，就是在構(gòu)建一個(gè)實(shí)例時(shí)，有太多參數(shù)可以配置，如果都放到構(gòu)造函數(shù)去做，那就顯得太羅嗦，接口不簡(jiǎn)潔。使用setter，好像也不太好，我們希望實(shí)例構(gòu)建后直接是可用狀態(tài)。關(guān)于AndroidRefWatcherBuilder和RefWatcherBuilder后面會(huì)有介紹。install方法返回RefWatcher，接下來(lái)我們就看看這個(gè)RefWatcher。

RefWatcher

顧名思義，引用監(jiān)控，它可以說是一個(gè)調(diào)度類，從判斷泄漏，內(nèi)存堆日志分析，結(jié)果展示，這些功能都在RefWatcher里面串起來(lái)

/**
 * Watches references that should become weakly reachable. When the {@link RefWatcher} detects that
 * a reference might not be weakly reachable when it should, it triggers the {@link HeapDumper}.
 *
 * <p>This class is thread-safe: you can call {@link #watch(Object)} from any thread.
 */
public final class RefWatcher {
private final WatchExecutor watchExecutor;
  private final DebuggerControl debuggerControl;
  private final GcTrigger gcTrigger;
  private final HeapDumper heapDumper;
  private final Set<String> retainedKeys;
  private final ReferenceQueue<Object> queue;
  private final HeapDump.Listener heapdumpListener;
  private final ExcludedRefs excludedRefs;
}

先了解這里的每一個(gè)成員：

• WatchExecutor 提供后臺(tái)線程支持以及重試的機(jī)制
• DebuggerControl 提供debug狀態(tài)的判斷，調(diào)試時(shí)有可能持有引用，規(guī)避誤報(bào)泄漏
• GcTrigger 觸發(fā)gc，盡量避免dump heap
• HeapDumper
• retainedKeys 存儲(chǔ)所有監(jiān)控的引用key，key是在watch時(shí)UUID生成的
• ReferenceQueue<Object> 監(jiān)控系統(tǒng)gc的結(jié)果
• HeapDump.Listener dump完成的回調(diào)，可以認(rèn)為是analysis的入口
• ExcludedRefs 預(yù)置的忽略引用，Android系統(tǒng)的已知內(nèi)存泄漏，就可以不用管了

AndroidRefWatcherBuilder

這個(gè)類就是通常的Builder寫法，只是多了一個(gè)RefWatcherBuilder基類，看整個(gè)包結(jié)構(gòu)就知道LeakCanary的設(shè)計(jì)不只是用于Android，而是在java的外面再包一層android實(shí)現(xiàn)，這樣擴(kuò)展性好，watcher層定義行為和流程，android層對(duì)應(yīng)具體的實(shí)現(xiàn)。

主流程

前面已經(jīng)把主要的準(zhǔn)備工作都介紹了，現(xiàn)在我們開始看看到底是如何監(jiān)聽泄漏的。

RefWatcher.java
 /**
   * Watches the provided references and checks if it can be GCed. This method is non blocking,
   * the check is done on the {@link WatchExecutor} this {@link RefWatcher} has been constructed
   * with.
   *
   * @param referenceName An logical identifier for the watched object.
   */
  public void watch(Object watchedReference, String referenceName) {
    if (this == DISABLED) {
      return;
    }
    checkNotNull(watchedReference, "watchedReference");
    checkNotNull(referenceName, "referenceName");
    final long watchStartNanoTime = System.nanoTime();
    String key = UUID.randomUUID().toString();
    retainedKeys.add(key);
    final KeyedWeakReference reference =
        new KeyedWeakReference(watchedReference, key, referenceName, queue);

    ensureGoneAsync(watchStartNanoTime, reference);
  }

1. 記錄當(dāng)前時(shí)間
2. 生成key，生成KeyedWeakReference，記錄弱引用和key

 private void ensureGoneAsync(final long watchStartNanoTime, final KeyedWeakReference reference) {
    watchExecutor.execute(new Retryable() {
      @Override public Retryable.Result run() {
        return ensureGone(reference, watchStartNanoTime);
      }
    });
  }

  @SuppressWarnings("ReferenceEquality") // Explicitly checking for named null.
  Retryable.Result ensureGone(final KeyedWeakReference reference, final long watchStartNanoTime) {
    long gcStartNanoTime = System.nanoTime();
    long watchDurationMs = NANOSECONDS.toMillis(gcStartNanoTime - watchStartNanoTime);

    removeWeaklyReachableReferences();

    if (debuggerControl.isDebuggerAttached()) {
      // The debugger can create false leaks.
      return RETRY;
    }
    if (gone(reference)) {
      return DONE;
    }
    gcTrigger.runGc();
    removeWeaklyReachableReferences();
    if (!gone(reference)) {
      long startDumpHeap = System.nanoTime();
      long gcDurationMs = NANOSECONDS.toMillis(startDumpHeap - gcStartNanoTime);

      File heapDumpFile = heapDumper.dumpHeap();
      if (heapDumpFile == RETRY_LATER) {
        // Could not dump the heap.
        return RETRY;
      }
      long heapDumpDurationMs = NANOSECONDS.toMillis(System.nanoTime() - startDumpHeap);
      heapdumpListener.analyze(
          new HeapDump(heapDumpFile, reference.key, reference.name, excludedRefs, watchDurationMs,
              gcDurationMs, heapDumpDurationMs));
    }
    return DONE;
  }

常見泄露場(chǎng)景

1. 匿名內(nèi)部類和非靜態(tài)內(nèi)部類 隱式持有外部類的引用
2. 注冊(cè)了引用，沒有解注冊(cè)

reference

開源項(xiàng)目之LeakCanary源碼分析
LeakCanary核心原理源碼淺析