Android 和 Java 記憶體洩露檢測工具——LeakCanary

android 和 java 記憶體洩露檢測。

“a small leak will sink a great ship.” - benjamin franklin 千裡之堤， 毀于蟻穴。 -- 《韓非子·喻老》

一個非常簡單的 leakcanary demo: https://github.com/liaohuqiu/leakcanary-demo

在 <code>build.gradle</code> 中加入引用，不同的編譯使用不同的引用：

在 <code>application</code> 中：

這樣，就萬事俱備了！ 在 debug build 中，如果檢測到某個 activity 有記憶體洩露，leakcanary 就是自動地顯示一個通知。

問得好，看這個文章leakcanary: 讓記憶體洩露無所遁形

使用 <code>refwatcher</code> 監控那些本該被回收的對象。

<code>leakcanary.install()</code> 會傳回一個預定義的 <code>refwatcher</code>，同時也會啟用一個 <code>activityrefwatcher</code>，用于自動監控調用<code>activity.ondestroy()</code> 之後洩露的

activity。

使用 <code>refwatcher</code> 監控

fragment：

<code>refwatcher.watch()</code> 建立一個 keyedweakreference 到要被監控的對象。

然後在背景線程檢查引用是否被清除，如果沒有，調用gc。

如果引用還是未被清除，把 heap 記憶體 dump 到 app 對應的檔案系統中的一個 <code>.hprof</code> 檔案中。

在另外一個程序中的 <code>heapanalyzerservice</code> 有一個 <code>heapanalyzer</code> 使用haha 解析這個檔案。

得益于唯一的 reference key, <code>heapanalyzer</code> 找到 <code>keyedweakreference</code>，定位記憶體洩露。

<code>heapanalyzer</code> 計算 到

gc roots 的最短強引用路徑，并确定是否是洩露。如果是的話，建立導緻洩露的引用鍊。

引用鍊傳遞到 app 程序中的 <code>displayleakservice</code>，

并以通知的形式展示出來。

在 logcat 中，你可以看到類似這樣的 leak trace：

你甚至可以通過分享按鈕把這些東西分享出去。

随着時間的推移，很多sdk 和廠商 rom 中的記憶體洩露問題已經被盡快修複了。但是，當這樣的問題發生時，一般的開發者能做的事情很有限。

leakcanary 有一個已知問題的忽略清單，androidexcludedrefs.java，如果你發現了一個新的問題，請提一個

issue 并附上 leak trace, reference key, 機器型号和 sdk 版本。如果可以附帶上 dump 檔案的 連結那就再好不過了。

對于最新釋出的 android，這點尤其重要。你有機會在幫助在早期發現新的記憶體洩露，這對整個 android 社群都有極大的益處。

開發版本的 snapshots 包在這裡： sonatype's <code>snapshots</code> repository。

有時，leak trace 不夠，你需要通過 mat 或者 yourkit 深挖 dump 檔案。

通過以下方法，你能找到問題所在：

查找所有的 <code>com.squareup.leakcanary.keyedweakreference</code> 執行個體。

檢查 <code>key</code> 字段

find the <code>keyedweakreference</code> that

has a <code>key</code> field

equal to the reference key reported by leakcanary.

找到 key 和 和 logcat 輸出的 key 值一樣的 <code>keyedweakreference</code>。

<code>referent</code> 字段對應的就是洩露的對象。

剩下的，就是動手修複了。最好是檢查到 gc root 的最短強引用路徑開始。

<code>displayleakactivity</code> 有一個預設的圖示和标簽，你隻要在你自己的

app 資源中，替換以下資源就可。

<code>displayleakactivity</code> saves

up to 7 heap dumps &amp; leak traces in the app directory. you can change that number by providing<code>r.integer.__leak_canary_max_stored_leaks</code> in

your app:

在 app 的目錄中，<code>displayleakactivity</code> 儲存了

7 個 dump 檔案和 leak trace。你可以在你的 app 中，定義<code>r.integer.__leak_canary_max_stored_leaks</code> 來覆寫類庫的預設值。

你可以改變處理完成的預設行為，将 leak trace 和 heap dump 上傳到你的伺服器以便統計分析。

建立一個 <code>leakuploadservice</code>，

最簡單的就是繼承 <code>displayleakservice</code> ：

請确認 release 版本 使用 <code>refwatcher.disabled</code>：

自定義 <code>refwatcher</code>：

别忘了注冊 service：

轉自：http://www.liaohuqiu.net/cn/posts/leak-canary-read-me/