(转)LeakCanary 中文使用说明

原文链接(http://www.liaohuqiu.net/cn/posts/leak-canary-read-me/)

LeakCanary

Android 和 Java 内存泄露检测。

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

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

demo

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

开始使用

在build.gradle中加入引用,不同的编译使用不同的引用:

dependencies {

debugCompile 'com.squareup.leakcanary:leakcanary-android:1.3'

releaseCompile 'com.squareup.leakcanary:leakcanary-android-no-op:1.3'

}

在Application中:

publicclassExampleApplicationextendsApplication{@OverridepublicvoidonCreate(){super.onCreate();LeakCanary.install(this);}}

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

为什么需要使用 LeakCanary?

问得好,看这个文章LeakCanary: 让内存泄露无所遁形

如何使用

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

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

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

publicclassExampleApplicationextendsApplication{publicstaticRefWatchergetRefWatcher(Contextcontext){ExampleApplicationapplication=(ExampleApplication)context.getApplicationContext();returnapplication.refWatcher;}privateRefWatcherrefWatcher;@OverridepublicvoidonCreate(){super.onCreate();refWatcher=LeakCanary.install(this);}}

使用RefWatcher监控 Fragment:

publicabstractclassBaseFragmentextendsFragment{@OverridepublicvoidonDestroy(){super.onDestroy();RefWatcherrefWatcher=ExampleApplication.getRefWatcher(getActivity());refWatcher.watch(this);}}

工作机制

RefWatcher.watch()创建一个KeyedWeakReference到要被监控的对象。

然后在后台线程检查引用是否被清除,如果没有,调用GC。

如果引用还是未被清除,把 heap 内存 dump 到 APP 对应的文件系统中的一个.hprof文件中。

在另外一个进程中的HeapAnalyzerService有一个HeapAnalyzer使用HAHA解析这个文件。

得益于唯一的 reference key,HeapAnalyzer找到KeyedWeakReference,定位内存泄露。

HeapAnalyzer计算到 GC roots 的最短强引用路径,并确定是否是泄露。如果是的话,建立导致泄露的引用链。

引用链传递到 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. (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 包在这里:Sonatype'ssnapshotsrepository

leak trace 之外

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

通过以下方法,你能找到问题所在:

查找所有的com.squareup.leakcanary.KeyedWeakReference实例。

检查key字段

Find theKeyedWeakReferencethat has akeyfield equal to the reference key reported by LeakCanary.

找到 key 和 和 logcat 输出的 key 值一样的KeyedWeakReference。

referent字段对应的就是泄露的对象。

剩下的,就是动手修复了。最好是检查到 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

MyLeaks

保存 leak trace

DisplayLeakActivitysaves up to 7 heap dumps & leak traces in the app directory. You can change that number by providingR.integer.__leak_canary_max_stored_leaksin your app:

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

20

上传 leak trace 到服务器

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

创建一个LeakUploadService, 最简单的就是继承DisplayLeakService:

publicclassLeakUploadServiceextendsDisplayLeakService{@OverrideprotectedvoidafterDefaultHandling(HeapDumpheapDump,AnalysisResultresult,StringleakInfo){if(!result.leakFound||result.excludedLeak){return;}myServer.uploadLeakBlocking(heapDump.heapDumpFile,leakInfo);}}

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

publicclassExampleApplicationextendsApplication{publicstaticRefWatchergetRefWatcher(Contextcontext){ExampleApplicationapplication=(ExampleApplication)context.getApplicationContext();returnapplication.refWatcher;}privateRefWatcherrefWatcher;@OverridepublicvoidonCreate(){super.onCreate();refWatcher=installLeakCanary();}protectedRefWatcherinstallLeakCanary(){returnRefWatcher.DISABLED;}}

自定义RefWatcher:

publicclassDebugExampleApplicationextendsExampleApplication{protectedRefWatcherinstallLeakCanary(){returnLeakCanary.install(app,LeakUploadService.class);}}

别忘了注册 service:

demo

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

推荐阅读更多精彩内容

  • 前两天,Square开源了一个内存泄露自动探测神器——LeakCanary,它是一个Android和Java的内存...
    cfanr阅读 14,986评论 6 16
  • 内存管理的目的就是让我们在开发中怎么有效的避免我们的应用出现内存泄漏的问题。内存泄漏大家都不陌生了,简单粗俗的讲,...
    宇宙只有巴掌大阅读 2,172评论 0 12
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 167,323评论 24 705
  • 被文同时发布在CSDN上,欢迎查看。 APP内存的使用,是评价一款应用性能高低的一个重要指标。虽然现在智能手机的内...
    大圣代阅读 4,458评论 2 54
  • 每次取快递我都带着轻快的步子,小跑冲向收发室,这次也不例外,因为几天前买的汽车防尘罩到了。 大学毕业以后,我妈就给...
    美也的日常阅读 141评论 0 0
  • “敢问将军尊姓大名,何以到我这荒野山村里来了?” “将军?” 李小花很是惊讶,有些不确定道:“你叫我将军?” 钟黎...
    鄢小文阅读 115评论 0 0
  • 如果这部剧出现在我的学生时代,会是什么样?如果几个月前,我追了这部剧,会是怎么样?看不懂!因为我的元认知还没有被激...
    hebe214阅读 373评论 0 0
  • 对于接受中国古代传统文化长大的我们,那些传统文化已经或多或少的流淌在我们的血液里。儒家讲仁爱,君主以德治天下,...
    微笑的雨林阅读 617评论 0 0