LeakCanary内存泄露检测原理

LeakCanary代码量比较多,阅读源码容易把人绕晕,提取主干代码,精简后的代码只有200行,看完这200行代码,LeakCanary检测内存泄露原理应该就清楚了,回头再看LeakCanary完整源码就不再神秘。

精简后的源代码已发布在Github上:https://github.com/andev009/LearnLeakCanary

LeakCanary是安卓开发中分析内存泄露的工具。源代码内容很多,总结起来主要分三个部分:1.检测泄露,2,分析泄露,3,通知泄露。分析泄露用到了HAHA这个工具,有兴趣的可以单独分析,通知泄露,利用安卓自身消息机制,Service, Notification, Activity这些,按流程走就行了。本文分析内存泄露检测这块,这块才是LeakCanary原理的核心。

LeakCanary检测内存泄露分两个部分:
1.监听Activity生命周期,在Activity销毁的时候通知LeakCanary。
2.内存泄露检测.

监听Activity生命周期

public class LearnLeakCanaryApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();

        ActivityRefWatcher.install(this, new RefWatcher());
    }
}

首先看入口,在Application完成注册工作,和LeakCanary源码注册不一样,用的ActivityRefWatcher完成注册,其实LeakCanary也差不多,不过多了各种配置。

注册主要做两件事,一是Application绑定Activity生命周期,Activity销毁的时候都能监听到。二是new了个RefWatcher对象,RefWatcher就做了一件事,检测泄露,如果泄露就捕捉给HAHA处理。这样看,这一句代码就完成了两件重要的工作。

ActivityRefWatcher注册时最后的调用watchActivities,在这个函数里完成Application和生命周期的监听注册。

public static void install(Application application, RefWatcher refWatcher) {
        new ActivityRefWatcher(application, refWatcher).watchActivities();
    }
public void watchActivities() {
        // Make sure you don't get installed twice.
        stopWatchingActivities();
        application.registerActivityLifecycleCallbacks(lifecycleCallbacks);
    }

lifecycleCallbacks就是生命周期回调,Activity销毁时,会被Application监听,然后走onActivityDestroyed回调。在onActivityDestroyed里,把自己交给RefWatcher,让RefWatcher去检测自己是否真的被回收。

private final Application.ActivityLifecycleCallbacks lifecycleCallbacks =
            new Application.ActivityLifecycleCallbacks() {
                @Override public void onActivityCreated(Activity activity, Bundle savedInstanceState) {
                }

                @Override public void onActivityStarted(Activity activity) {
                }

                @Override public void onActivityResumed(Activity activity) {
                }

                @Override public void onActivityPaused(Activity activity) {
                }

                @Override public void onActivityStopped(Activity activity) {
                }

                @Override public void onActivitySaveInstanceState(Activity activity, Bundle outState) {
                }

                @Override public void onActivityDestroyed(Activity activity) {
                    Log.d(TAG, activity.getLocalClassName() + " onActivityDestroyed");

                    ActivityRefWatcher.this.onActivityDestroyed(activity);
                }
            };

内存泄露判断

内存泄露判断主要是用到了WeakReference和ReferenceQueue,他们俩的关系很简单,弱引用对象回收了,弱引用对象就会在ReferenceQueue里,如果ReferenceQueue里没有,就说明可能泄露。至于为什么会这样,看Reference源码这里入队列这段注释。

/**
     * Adds this reference object to the queue with which it is registered,
     * if any.
     *
     * <p> This method is invoked only by Java code; when the garbage collector
     * enqueues references it does so directly, without invoking this method.
     *
     * @return   <code>true</code> if this reference object was successfully
     *           enqueued; <code>false</code> if it was already enqueued or if
     *           it was not registered with a queue when it was created
     */
    public boolean enqueue() {
       return queue != null && queue.enqueue(this);
    }

上面说可能泄露是因为GC不一定及时,所以LeakCanary会再调一次GC,然后再检测ReferenceQueue是否存在回收的对象。如果这次还没有就是泄露了,后面的逻辑就是给HAHA分析,Notification通知。

void ensureGone(final KeyedWeakReference reference, String referenceName, final long watchStartNanoTime) {
        long gcStartNanoTime = System.nanoTime();
        long watchDurationMs = NANOSECONDS.toMillis(gcStartNanoTime - watchStartNanoTime);

        removeWeaklyReachableReferences();

        if (gone(reference)) {
            return;
        }
        gcTrigger.runGc();
        removeWeaklyReachableReferences();
        if (!gone(reference)) {
            //do HeapDump, HeapAnalyzer
            Log.d("RefWatcher", Thread.currentThread().getName());
            Log.d("RefWatcher",referenceName + " leaked!");
        }
        return;
    }

整个流程很简单,精简后的代码只有不到200行。需要说明的是,LeakCanary在新线程里检测,这里为了代码简单,用Handle postDelayed 5秒后在主线程检测,原理都一样。跑Demo时,看ensureGone里泄露时的Log。SecondActivity,ThirdActivity之所以内存泄露是因为里面的内部类持有外部引用。仔细看看Log,应该就理解原理了。


Log.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,132评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,802评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,566评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,858评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,867评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,695评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,064评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,705评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,915评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,677评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,796评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,432评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,041评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,992评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,223评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,185评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,535评论 2 343