Android LeakCanary的使用和原理

最新推荐文章于 2025-07-26 10:57:54 发布

一朵白山茶

最新推荐文章于 2025-07-26 10:57:54 发布

阅读量523

点赞数

CC 4.0 BY-SA版权

分类专栏： Android 文章标签：经验分享面试 android

本文链接：https://blog.csdn.net/m0_70082867/article/details/124684884

本文详细介绍了LeakCanary的使用方法及其内存泄露检测的原理。从SDK初始化开始，逐步剖析了RefWatcher的构建过程，包括设置监听服务、添加排除列表以及创建和安装RefWatcher。此外，还讲解了LeakCanary如何通过Activity生命周期监听来检测内存泄露，以及当Activity销毁时，如何执行分析任务，判断是否存在内存泄露。文章深入浅出地展示了LeakCanary在内存管理中的重要作用。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

myProcess = process;
break;
}
}
}
if (myProcess == null) {
CanaryLog.d(“Could not find running process for %d”, myPid);
return false;
}

return myProcess.processName.equals(serviceInfo.processName);
}

源码分析

SDK初始化

mRefWatcher = LeakCanary.install(this);

这个是SDK向外暴露的方法，我们以此为入口进行源码的分析

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

public static AndroidRefWatcherBuilder refWatcher(Context context) {
return new AndroidRefWatcherBuilder(context);
}

install方法首先初始化了一个AndroidRefWatcherBuilder类,然后通过listenerServiceClass方法设置了DisplayLeakService,这个类主要用于分析内存泄露的结果信息，然后发送通知给用户

public final class AndroidRefWatcherBuilder extends RefWatcherBuilder {

/**

Sets a custom {@link AbstractAnalysisResultService} to listen to analysis results. This
overrides any call to {@link #heapDumpListener(HeapDump.Listener)}.
*/
public AndroidRefWatcherBuilder listenerServiceClass(
Class<? extends AbstractAnalysisResultService> listenerServiceClass) {
return heapDumpListener(new ServiceHeapDumpListener(context, listenerServiceClass));
}
…
}

public class RefWatcherBuilder<T extends RefWatcherBuilder> {
…
/** @see HeapDump.Listener */
public final T heapDumpListener(HeapDump.Listener heapDumpListener) {
this.heapDumpListener = heapDumpListener;
return self();
}
…
}

然后调用excludedRefs方法添加白名单，在AndroidExcludedRefs枚举类中定义了忽略列表信息，如果这些列表中的类发生了内存泄露，并不会显示出来，同时HeapAnalyzer计算GCRoot强引用路径，也会忽略这些类，如果你希望自己项目中某个类泄露的，但是不希望他显示，就可以把类添加到这个上面

public enum AndroidExcludedRefs {

// ######## Android SDK Excluded refs ########

ACTIVITY_CLIENT_RECORD__NEXT_IDLE(SDK_INT >= KITKAT && SDK_INT <= LOLLIPOP) {
@Override void add(ExcludedRefs.Builder excluded) {
excluded.instanceField(“android.app.ActivityThread$ActivityClientRecord”, “nextIdle”)
.reason(“Android AOSP somet