内存泄露检测工具——LeakCanary

很简单：我们不是创建服务不是为了赚钱；我们赚钱是为了提供更好的服务。我们认为这才是做事的态度。

学习使用Java的同学都应该知道，Java的JVM给我们提供的垃圾回收机制是极为好用的。但是我们也很清楚，垃圾回收机制不是万能的，使用不当很容易造成内存泄露。之前我们也介绍过Java中常用的内存泄露检测工具MAT，目前Java程序最常用的内存分析工具应该是MAT（Memory Analyzer Tool），它是一个Eclipse插件，同时也有单独的RCP客户端。

不熟悉MAT的同学，或者对Java垃圾回收机制不了解的同学，可以
看我的这篇文章：http://blog.csdn.net/yzzst/article/details/26621861

今天，这里我们不说MAT，我们说一个更有用的开源工具——LeakCanary。

LeakCanary本质上就是一个基于MAT进行Android应用程序内存泄漏自动化检测的的开源工具，通过集成这个工具代码到自己的Android工程当中就能够在程序调试开发过程中通过一个漂亮的界面。

随时发现和定位内存泄漏问题，而不用每次在开发流程中都抽出专人来进行内存泄漏问题检测，极大地方便了Android应用程序的开发。

总的来说，LeakCanary有如下几个明显优点：

1. 针对Android Activity组件完全自动化的内存泄漏检查。
2. 可定制一些行为（dump文件和leaktrace对象的数量、自定义例外、分析结果的自定义处理等）。
3. 集成到自己工程并使用的成本很低。（*主要）
4. 友好的界面展示和通知。

Github地址：https://github.com/square/leakcanary

具体怎么使用？应用一下官方的翻译文档入下：

---

LeakCanary

Android 和 Java 内存泄露检测。

“A small leak will sink a great ship.” - Benjamin Franklin

千里之堤， 毁于蚁穴。 – 《韩非子·喻老》

---

开始使用

在 build.gradle 中加入引用，不同的编译使用不同的引用：

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

在 Application 中：

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

这样，就万事俱备了！ 在 debug build 中，如果检测到某个 activity 有内存泄露，LeakCanary 就是自动地显示一个通知。

---

如何使用

使用 RefWatcher 监控那些本该被回收的对象。

RefWatcher refWatcher = {...};// 监控refWatcher.watch(schrodingerCat);

LeakCanary.install() 会返回一个预定义的 RefWatcher，同时也会启用一个 ActivityRefWatcher，用于自动监控调用 Activity.onDestroy() 之后泄露的 activity。

public class ExampleApplication extends Application {  public static RefWatcher getRefWatcher(Context context) {    ExampleApplication application = (ExampleApplication) context.getApplicationContext();    return application.refWatcher;  }  private RefWatcher refWatcher;  @Override public void onCreate() {    super.onCreate();    refWatcher = LeakCanary.install(this);  }}

使用 RefWatcher 监控 Fragment：

public abstract class BaseFragment extends Fragment {  @Override   public void onDestroy() {    super.onDestroy();    RefWatcher refWatcher = ExampleApplication.getRefWatcher(getActivity());    refWatcher.watch(this);  }}

---

工作机制

1. RefWatcher.watch() 创建一个 KeyedWeakReference 到要被监控的对象。
2. 然后在后台线程检查引用是否被清除，如果没有，调用GC。
3. 如果引用还是未被清除，把 heap 内存 dump 到 APP 对应的文件系统中的一个 .hprof 文件中。
4. 在另外一个进程中的 HeapAnalyzerService 有一个 HeapAnalyzer 使用HAHA 解析这个文件。
5. 得益于唯一的 reference key, HeapAnalyzer 找到 KeyedWeakReference，定位内存泄露。
6. HeapAnalyzer 计算 到 GC roots 的最短强引用路径，并确定是否是泄露。如果是的话，建立导致泄露的引用链。
7. 引用链传递到 APP 进程中的 DisplayLeakService， 并以通知的形式展示出来。

---

如何复制 leak trace？

在 Logcat 中，你可以看到类似这样的 leak trace：

In com.example.leakcanary:1.0:1 com.example.leakcanary.MainActivity has leaked:* GC ROOT thread java.lang.Thread.<Java Local> (named 'AsyncTask #1')* references com.example.leakcanary.MainActivity$3.this$0 (anonymous class extends android.os.AsyncTask)* leaks com.example.leakcanary.MainActivity instance* Reference Key: e71f3bf5-d786-4145-8539-584afaecad1d* Device: Genymotion generic Google Nexus 6 - 5.1.0 - API 22 - 1440x2560 vbox86p* Android Version: 5.1 API: 22* Durations: watch=5086ms, gc=110ms, heap dump=435ms, analysis=2086ms

你甚至可以通过分享按钮把这些东西分享出去。

---

SDK 导致的内存泄露

随着时间的推移，很多SDK 和厂商 ROM 中的内存泄露问题已经被尽快修复了。但是，当这样的问题发生时，一般的开发者能做的事情很有限。

LeakCanary 有一个已知问题的忽略列表，AndroidExcludedRefs.java，如果你发现了一个新的问题，请提一个 issue 并附上 leak trace, reference key, 机器型号和 SDK 版本。如果可以附带上 dump 文件的 链接那就再好不过了。

对于最新发布的 Android，这点尤其重要。你有机会在帮助在早期发现新的内存泄露，这对整个 Android 社区都有极大的益处。

开发版本的 Snapshots 包在这里： https://oss.sonatype.org/content/repositories/snapshots/

---

leak trace 之外

有时，leak trace 不够，你需要通过 MAT 或者 YourKit 深挖 dump 文件。

通过以下方法，你能找到问题所在：

1. 查找所有的 com.squareup.leakcanary.KeyedWeakReference 实例。
2. 检查 key 字段
3. Find the KeyedWeakReference that has a key field equal to the reference key reported by LeakCanary.
4. 找到 key 和 和 logcat 输出的 key 值一样的 KeyedWeakReference。
5. Referent 字段对应的就是泄露的对象。
6. 剩下的，就是动手修复了。最好是检查到 GC root 的最短强引用路径开始。

---

自定义

UI 样式

DisplayLeakActivity 有一个默认的图标和标签，你只要在你自己的 APP 资源中，替换以下资源就可。

res/  drawable-hdpi/    __leak_canary_icon.png  drawable-mdpi/    __leak_canary_icon.png  drawable-xhdpi/    __leak_canary_icon.png  drawable-xxhdpi/    __leak_canary_icon.png  drawable-xxxhdpi/    __leak_canary_icon.png<?xml version="1.0" encoding="utf-8"?><resources>  <string name="__leak_canary_display_activity_label">MyLeaks</string></resources>

---

保存 leak trace

DisplayLeakActivity saves up to 7 heap dumps & leak traces in the app directory. You can change that number by providing R.integer.__leak_canary_max_stored_leaks in your app:

在 APP 的目录中，DisplayLeakActivity 保存了 7 个 dump 文件和 leak trace。你可以在你的 APP 中，定义 R.integer.__leak_canary_max_stored_leaks 来覆盖类库的默认值。

<?xml version="1.0" encoding="utf-8"?><resources>  <integer name="__leak_canary_max_stored_leaks">20</integer></resources>

---

上传 leak trace 到服务器

你可以改变处理完成的默认行为，将 leak trace 和 heap dump 上传到你的服务器以便统计分析。

创建一个 LeakUploadService， 最简单的就是继承 DisplayLeakService ：

public class LeakUploadService extends DisplayLeakService {  @Override  protected void afterDefaultHandling(HeapDump heapDump, AnalysisResult result, String leakInfo) {    if (!result.leakFound || result.excludedLeak) {      return;    }    myServer.uploadLeakBlocking(heapDump.heapDumpFile, leakInfo);  }}

请确认 release 版本 使用 RefWatcher.DISABLED：

public class ExampleApplication extends Application {  public static RefWatcher getRefWatcher(Context context) {    ExampleApplication application = (ExampleApplication) context.getApplicationContext();    return application.refWatcher;  }  private RefWatcher refWatcher;  @Override public void onCreate() {    super.onCreate();    refWatcher = installLeakCanary();  }  protected RefWatcher installLeakCanary() {    return RefWatcher.DISABLED;  }}

自定义 RefWatcher：

public class DebugExampleApplication extends ExampleApplication {  protected RefWatcher installLeakCanary() {    return LeakCanary.install(app, LeakUploadService.class);  }}

别忘了注册 service：

<?xml version="1.0" encoding="utf-8"?><manifest         xmlns:android="http://schemas.android.com/apk/res/android"    xmlns:tools="http://schemas.android.com/tools"    >     <application android:name="com.example.DebugExampleApplication">           <service android:name="com.example.LeakUploadService" />     </application></manifest>

---

demo

一个非常简单的 LeakCanary demo: https://github.com/liaohuqiu/leakcanary-demo

---

/*
* @author zhoushengtao(周圣韬)
* @since 2015年9月13日 下午 15:11:00
* @weixin stchou_zst
* @blog http://blog.csdn.net/yzzst
* @交流学习QQ群：341989536
* @私人QQ：445914891
/