LeakCanary原理解析，理解起来超简单！

以上面代码举例，如果GC时将mWeakReference指向的mActivity回收的话，同时也会向我们的mQueue中加入我们的mWeakReference。关于ReferenceQueue暂时我们就了解这么多就可以了，有兴趣的朋友可以自己去了解下。

2.LeakCanary.install(this);

关于LeakCanary的使用，一般我们都是在Application的onCreate的方法中，调用LeakCanary.install(this)，下面我们就来分析分析通过这一行代码，LeakCanary究竟为我们做了哪些事。

public static RefWatcher install(Application application) {

return refWatcher(application).listenerServiceClass(DisplayLeakService.class)

.excludedRefs(AndroidExcludedRefs.createAppDefaults().build())

.buildAndInstall();

}

（1）调用refWatcher()创建了一个AndroidRefWatcherBuilder。

public static AndroidRefWatcherBuilder refWatcher(Context context) {

return new AndroidRefWatcherBuilder(context);

}

（2）调用AndroidRefWathcerBuilder的listenerServiceClass方法注册一个回调。

public AndroidRefWatcherBuilder listenerServiceClass(

Class<? extends AbstractAnalysisResultService> listenerServiceClass) {

//包装了两层

return heapDumpListener(new ServiceHeapDumpListener(context, listenerServiceClass));

}

（3）调用AndroidRefWatcherBuilder的excludedRefs方法

@Override protected ExcludedRefs defaultExcludedRefs() {

return AndroidExcludedRefs.createAppDefaults().build();

}

这里主要是为了排除系统导致的内存泄漏。

（4）buildAndInstall（）

public RefWatcher buildAndInstall() {

//做了判断install方法只能被调用一次

if (LeakCanaryInternals.installedRefWatcher != null) {

throw new UnsupportedOperationException(“buildAndInstall() should only be called once.”);

}

//创建一个RefWacher观察对象

RefWatcher refWatcher = build();

if (refWatcher != DISABLED) {

if (watchActivities) {

ActivityRefWatcher.install(context, refWatcher);

}

if (watchFragments) {

FragmentRefWatcher.Helper.install(context, refWatcher);

}

}

LeakCanaryInternals.installedRefWatcher = refWatcher;

return refWatcher;

}

主要作用创建了一个RefWatcher对象并返回，这个方法里面有两个比较重要的方法我们看下

ActivityRefWatcher.install(context, refWatcher)和FragmentRefWatcher.Helper.install(context, refWatcher);

（5） ActivityRefWatcher.install(context, refWatcher);

public static void install(Context context, RefWatcher refWatcher) {

Application application = (Application) context.getApplicationContext();

ActivityRefWatcher activityRefWatcher = new ActivityRefWatcher(application, refWatcher);

//为当前Application注册了所有Activity的生命周期的回调

application.registerActivityLifecycleCallbacks(activityRefWatcher.lifecycleCallbacks);

}

private final Application.ActivityLifecycleCallbacks lifecycleCallbacks =

new ActivityLifecycleCallbacksAdapter() {

@Override public void onActivityDestroyed(Activity activity) {

//当Activity销毁时调用refWathcer的watch方法观察这个对象

refWatcher.watch(activity);

}

};

（6） FragmentRefWatcher.Helper.install(context, refWatcher);

public static void install(Context context, RefWatcher refWatcher) {

//创建一个集合

List fragmentRefWatchers = new ArrayList<>();

//如果当前API版本大于26，创建一个AndroidOFragmentRefWatcher对象加入到集合中

if (SDK_INT >= O) {

fragmentRefWatchers.add(new AndroidOFragmentRefWatcher(refWatcher));

}

try {

//找到SupportFragmentRefWatcher这个类

Class<?> fragmentRefWatcherClass = Class.forName(SUPPORT_FRAGMENT_REF_WATCHER_CLASS_NAME);

//找到它的构造方法

Constructor<?> constructor =

fragmentRefWatcherClass.getDeclaredConstructor(RefWatcher.class);

//创建SupportFragmentRefWatcher实例，并添加到集合中

FragmentRefWatcher supportFragmentRefWatcher =

(FragmentRefWatcher) constructor.newInstance(refWatcher);

fragmentRefWatchers.add(supportFragmentRefWatcher);

} catch (Exception ignored) {

}

if (fragmentRefWatchers.size() == 0) {

return;

}

Helper helper = new Helper(fragmentRefWatchers);

Application application = (Application) context.getApplicationContext();

application.registerActivityLifecycleCallbacks(helper.activityLifecycleCallbacks);

}

这个方法的作用是当当前API版本大于26的时候,在Activity销毁是它会调用AndroidOFragmentRefWatcher的watchFragments方法观察当前Activity中的所有销毁的Fragments。也就是说如果当前API版本是大于26的，我们不需要在在Fragment的onDestory方法中自己调用RefWatcher的watch方法了。

下面我们来分析RefWatcher的watch方法,这个方法是LeakCanary的核心逻辑所在，我们一起来看看吧。

3.RefWatcher.watch();

public void watch(Object watchedReference) {

watch(watchedReference, “”);

}

public void watch(Object watchedReference, String referenceName) {

if (this == DISABLED) {

return;

}

checkNotNull(watchedReference, “watchedReference”);

checkNotNull(referenceName, “referenceName”);

//获取时间，纳秒级别

final long watchStartNanoTime = System.nanoTime();

//生成一个随机数作为key

String key = UUID.randomUUID().toString();

//retainedKeys是一个Set集合，存储所有的key

retainedKeys.add(key);

//使用KeyedWeakReference包装当前传过来的引用，代指Activity和Fragment

//注意了这里传了一个queue，即ReferenceQueue,所以如果KeyedWeakReference引用的Activity或者

//Fragment即将被销毁时，就会向这个queue中添加reference这个引用对象。

final KeyedWeakReference reference =

new KeyedWeakReference(watchedReference, key, referenceName, queue);

ensureGoneAsync(watchStartNanoTime, reference);

}

4.ensureGoneAsync()

private void ensureGoneAsync(final long watchStartNanoTime, final KeyedWeakReference reference) {

watchExecutor.execute(new Retryable() {

@Override public Retryable.Result run() {

return ensureGone(reference, watchStartNanoTime);

}

});

}

这里主要就是调用watchExecutor的execute添加了一个Retryable任务，有点类似与线程池。这边的watchExecutor是通过RefWathcer的构造方法传过来的。通过上面的分析，我们知道在一开始创建了一个AndroidRefWatcherBuilder对象，它会调用的buildAndInstall方法，这个方法中我们调用了build()方法创建了RefWatcher对象，现在我们去看看这个RefWathcer是怎么创建的。

5.build（）

public final RefWatcher build() {

if (isDisabled()) {

return RefWatcher.DISABLED;

}

if (heapDumpBuilder.excludedRefs == null) {

heapDumpBuilder.excludedRefs(defaultExcludedRefs());

}

HeapDump.Listener heapDumpListener = this.heapDumpListener;

if (heapDumpListener == null) {

heapDumpListener = defaultHeapDumpListener();

}

DebuggerControl debuggerControl = this.debuggerControl;

if (debuggerControl == null) {

debuggerControl = defaultDebuggerControl();

}

HeapDumper heapDumper = this.heapDumper;

if (heapDumper == null) {

//调用的是AndroidRefWatcherBuilder中的方法。所以这里创建的是一个AndroidHeapDumper对象

heapDumper = defaultHeapDumper();

}

WatchExecutor watchExecutor = this.watchExecutor;

if (watchExecutor == null) {

//调用的是AndroidRefWatcherBuilder中的方法。所以这里创建的是一个AndroidWatchExecutor对象

watchExecutor = defaultWatchExecutor();

}

GcTrigger gcTrigger = this.gcTrigger;

if (gcTrigger == null) {

//创建的是GcTrigger DEFAULT这个对象

gcTrigger = defaultGcTrigger();

}

if (heapDumpBuilder.reachabilityInspectorClasses == null) {

heapDumpBuilder.reachabilityInspectorClasses(defaultReachabilityInspectorClasses());

}

return new RefWatcher(watchExecutor, debuggerControl, gcTrigger, heapDumper, heapDumpListener,

heapDumpBuilder);

}

这里注意了，AndroidRefWatcherBuilder类中没用实现build方法，所有是调用父类RefWatcherBuilder中的build方法，但是AndroidRefWatcherBuilder实现了defaultWatchExecutor，defaultHeapDumpListener这些方法，所以这些方法应该调用的是AndroidRefWatcherBuilder中的，而不是RefWatcherBuilder的。

6.AndroidWatchExecutor.execute()

通过5的分析我们知道RefWatcher中的watchExecutor对象其实是AndroidWatchExecutor类型的，下面我们来看看它的execute方法做了什么事。

@Override public void execute(Retryable retryable) {

//如果当前线程是主线程

if (Looper.getMainLooper().getThread() == Thread.currentThread()) {

waitForIdle(retryable, 0);

} else {

postWaitForIdle(retryable, 0);

}

}

我们看到，这里分了两种情况去做处理。如果当前线程是主线程调用 waitForIdle(retryable, 0);否则调用postWaitForIdle(retryable, 0);。其实不管怎么样最终调用的都是waitForIdle这个方法。

1.waitForIdle(retryable, 0);

private void waitForIdle(final Retryable retryable, final int failedAttempts) {

//向主线程的消息队列中里添加了一个对象

//当我们注册了IdleHandler的时候，当主线程空闲时，会发送一个空闲消息来执行IdleHandler中的回调

//注意了，queueIdle这个返回为false是，表示只会执行一次，如果为true代表，如果主线程每次空闲时都会

//执行这个方法

Looper.myQueue().addIdleHandler(new MessageQueue.IdleHandler() {

@Override public boolean queueIdle() {

//当主线程空闲时调用postToBackgroundWithDelay方法

postToBackgroundWithDelay(retryable, failedAttempts);

return false;

}

});

}

private void postToBackgroundWithDelay(final Retryable retryable, final int failedAttempts) {

long exponentialBackoffFactor = (long) Math.min(Math.pow(2, failedAttempts), maxBackoffFactor);

long delayMillis = initialDelayMillis * exponentialBackoffFactor;

//backgroundHandler是一个与异步线程绑定的Handler，我们可以看下AndroidWatchExecutor的构造方法中

//创建了一个HandlerThread，自己内部构建了一个异步的消息循环

//所以retryable.run()方法是执行在异步线程中的

backgroundHandler.postDelayed(new Runnable() {

@Override public void run() {

Retryable.Result result = retryable.run();

if (result == RETRY) {

postWaitForIdle(retryable, failedAttempts + 1);

}

}

}, delayMillis);

}

7.retryable.run() ->ensureGone

上面分析了那么多，其实这里才是我们的主要逻辑，我们先把涉及到的关键代码，贴出来，一步步来分析。

@SuppressWarnings(“ReferenceEquality”) // Explicitly checking for named null.

Retryable.Result ensureGone(final KeyedWeakReference reference, final long watchStartNanoTime) {

long gcStartNanoTime = System.nanoTime();

long watchDurationMs = NANOSECONDS.toMillis(gcStartNanoTime - watchStartNanoTime);

//如果对象GC时被回收了，就移除retainedKeys中对应的key值

removeWeaklyReachableReferences();

最后

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

因此我收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点！不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！
直到现在。**

深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

因此我收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

[外链图片转存中…(img-W7ludiRP-1715682152045)]

[外链图片转存中…(img-AdO6xRf5-1715682152057)]

[外链图片转存中…(img-NqX0mKJD-1715682152058)]

[外链图片转存中…(img-Eaza7zpm-1715682152059)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点！不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！