内存泄漏检测工具 LeakCanary 介绍

目录

  1. 简介
  2. 如何使用
  3. 如何实现
  4. 哪些需要监控
  5. 何时进行监控
  6. 解决方案
  7. 注意事项
  8. 其他工具
  9. LeakCanary源码

简介

LeakCanary是一个Square开源的内存泄漏分析工具,如果检测到某个activity有内存泄漏,LeakCanary就会自动显示一个通知。

如何使用

2.1)在app下的build.gradle中加入以下依赖

1
2
3
4
dependencies {
debugCompile 'com.squareup.leakcanary:leakcanary-android:1.5.4'
releaseCompile 'com.squareup.leakcanary:leakcanary-android-no-op:1.5.4'
}

2.2)在Application类中进行初始化,可以直接检测Activity的内存泄露情况

1
2
3
4
5
6
public class ExampleApplication extends Application {
@Override public void onCreate() {
super.onCreate();
LeakCanary.install(this);
}
}

2.3)需要检测更多object时,可以通过RefWatcher

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
public class ExApplication extends Application {
private RefWatcher mRefWatcher;
@Override
public void onCreate() {
super.onCreate();
mRefWatcher = setupLeakCanary();
}
private RefWatcher setupLeakCanary() {
if (LeakCanary.isInAnalyzerProcess(this)) {
return RefWatcher.DISABLED;
}
return LeakCanary.install(this);
}
public static RefWatcher getRefWatcher(Context context) {
ExApplication leakApplication = (ExApplication) context.getApplicationContext();
return leakApplication.mRefWatcher;
}
}
ExApplication.getRefWatcher(this).watch(obj);
// RefWatcher是线程安全的,可以从任何线程调用,但obj不能为null。

如何实现

3.1)在2.2中 直接install后即可检测Activity的原因

1
2
3
4
5
public static RefWatcher install(Application application) {
return refWatcher(application).listenerServiceClass(DisplayLeakService.class)
.excludedRefs(AndroidExcludedRefs.createAppDefaults().build())
.buildAndInstall();
}

在install的 buildAndInstall 方法中会根据application来创建ActivityRefWatch,以检测Activity的生命周期,在onActivityDestroyed时,依然是使用refWatcher.wath(activity),所以其实是一样的。

3.2)KeyedWeakReference 继承自 WeakReference,同时还会针对每个引用记录唯一的key。

3.3)DISABLED的定义:
public static final RefWatcher DISABLED = new RefWatcherBuilder<>().build();
debug中使用的源码在 leakcanary-android,release中使用的源码在 leakcanary-android-no-op. DISABLED中返回的方法

3.4)LeakCanary实际上就是在本机自动做Heap dump,然后对生成的hprof文件进行分析,进行结果展示,和手工分析MAT步骤基本一致。

  1. RefWatcher.watch() 方法中根据要监控的对象创建一个KeyedWeakReference
  2. 2.在后台线程中检查引用是否被清除,如果没有,则调用GC
  3. 如果引用仍未被清除,说明内存泄露了,则导出.hprof文件到app的文件系统目录下
  4. HeapAnalyzerService启动单独的进程,HeapAnalyzer使用HAHA来解析.hprof文件
  5. HeapAnalyzer根据唯一的reference key查找 KeyedWeakReference定位内存泄露
  6. HeapAnalyzer 计算 KeyedWeakReference 所引用对象的最短强引用路径,并确定是否泄露,构建导致泄露的对象引用链
  7. 将引用链传递回运行在APP进程中的 DisplayLeakService,并以通知的形式展示出来

哪些需要监控

Activity、Fragment、Bitmap、其他具有生命周期的对象、可能持有较大内存占用的对象等。

何时进行监控

内存泄漏就是某个对象在理应释放的时候却被其他对象持有,而没有被释放,因此造成内存泄漏。因此监控需要放在对象(很快)被释放的时候,比如Activity和Fragment的onDestroy方法中。

解决方案

  1. 使用Application的Context而不是Activity的
  2. 使用弱引用或软引用(弱引用:GC会来决定引用的对象何时回收并将对象从内存中移除,软引用:停留在内存的时间比弱引用较长,当内存不足时GC才会回收软引用可到达的对象,因此可以作为缓冲)
  3. 手动置空,解除引用关系
  4. 将内部类设置为static,因为非静态内部类会隐式持有外部类实例的引用
  5. 注册和取消注册首位成对,在对象合适的生命周期进行
  6. 资源性对象(比如Cursor、File等)往往都做了一些缓冲,在不使用时应该及时关闭,以便他们的缓冲对象能够被及时回收。这些缓冲不仅存在于Java虚拟机内,还存在于虚拟机外,如果我们仅仅将它的引用设置为null而不关闭它们,往往会造成内存泄漏。

注意事项

  1. release版本不能带,因为会带来更多的分析计算影响CPU等资源的占用
  2. 检测比较慢,涉及到I/O和大量计算,通常在20s~1min之间,和当前CPU占用情况有关
  3. 每次只能显示一条内存了泄漏的消息
  4. 如果最近有一个新的heap dump file被创建,还在分析中,那么就会在稍后再进行dump

其他工具

9.1)Lint (是Android Studio自带的静态代码分析工具,Analyze -> Inspect Code)
可以直接对单个文件或整个模块进行分析,以性能为例:

1
2
Android Lint: Performance
Do not place Android context classes in static fields; this is a memory leak (and also breaks instant Run)

LeakCanary源码

github.com/square/leakcanary


本站地址:http://nomasp.com/

欢迎交流,转载请联系本人,多谢🙏