Leakcanary浅析

本文主要分析内存泄漏的检测原理和如何实现生产环境应用,代码分析基于Leakcanary 1.6版本。

如何检测内存泄漏

要想搞懂如何检测内存泄漏,有一个基本知识点需要知道:

引用类型 被垃圾回收时间 用途 用途
强引用 从来不会 对象的一般状态 JVM停止运行时终止
软引用 当内存不足时 对象缓存 内存不足时终止
弱引用 正常垃圾回收时 对象缓存 垃圾回收后终止
虚引用 正常垃圾回收时 跟踪对象的垃圾回收 垃圾回收后终止

这里我们需要用到弱引用,因为弱引用符合我们检测的场景,就是当内存充足的时候触发的系统gc,弱引用对象也能被回收,这样有利于我们观察对象回收情况,并且弱引用在初始化的时候,有如下构造方法:

WeakReference(T referent, ReferenceQueue<? super T> q)

其中第二个参数是个队列,当对象被回收后会被放入该队列中,我们就可以通过在activity或者fragment onDestroy的时候,主动触发系统gc,然后查看队列中是否有该对象,如果没有,我们就认为发生了一次内存泄漏。我们看下leakcanry的具体实现:

public static void install(Context context, RefWatcher refWatcher) {
  Application application = (Application) context.getApplicationContext();
  ActivityRefWatcher activityRefWatcher = new ActivityRefWatcher(application, refWatcher);

  application.registerActivityLifecycleCallbacks(activityRefWatcher.lifecycleCallbacks);
}

private final Application.ActivityLifecycleCallbacks lifecycleCallbacks = new ActivityLifecycleCallbacksAdapter() {
  @Override public void onActivityDestroyed(Activity activity) {
    refWatcher.watch(activity);
  }
};

通过application的registerActivityLifecycleCallbacks监听所有activity的生命周期。接下去再看下在onActivityDestoryed中做了什么:

public void watch(Object watchedReference, String referenceName) {
    .....
    final long watchStartNanoTime = System.nanoTime();
    // 随机生成一个key
    String key = UUID.randomUUID().toString();
    // key放入Set<String>
    retainedKeys.add(key);
    // new 一个包含key信息的弱引用对象
    final KeyedWeakReference reference = new KeyedWeakReference(watchedReference, key, referenceName, queue);

    // 异步监测
    ensureGoneAsync(watchStartNanoTime, reference);
  }
// 启动异步监测
private void ensureGoneAsync(final long watchStartNanoTime, final KeyedWeakReference reference) {
  watchExecutor.execute(new Retryable() {
    @Override public Retryable.Result run() {
      return ensureGone(reference, watchStartNanoTime);
    }
  });
}
Retryable.Result ensureGone(final KeyedWeakReference reference, final long watchStartNanoTime) {

    // 更新retainedKeys,把存在queue中回收掉的key在retainedKeys去除掉
    removeWeaklyReachableReferences();

    // 如果当前应用的key已经不在retainedKeys中,说明引用在之前就被gc了
    if (gone(reference)) {
      return DONE;
    }
    // gc
    gcTrigger.runGc();
    // 再次更新retainedKeys
    removeWeaklyReachableReferences();
    // 这个时候引用的key还在retainedKeys,说明引用已经内存泄漏
    if (!gone(reference)) {
      ......dump操作
    }
    return DONE;
  }

以上是acitivty的监测方法,接下去我们看下fragment的相关流程。

// 1、install
public static void install(Context context, RefWatcher refWatcher) {
    List<FragmentRefWatcher> fragmentRefWatchers = new ArrayList<>();

    if (SDK_INT >= O) {
      // os包下面的Fragment
      fragmentRefWatchers.add(new AndroidOFragmentRefWatcher(refWatcher));
    }

    try {
      // v4包下面的Fragment,这边用反射因为类放在另外一个module下
      Class<?> fragmentRefWatcherClass = Class.forName(SUPPORT_FRAGMENT_REF_WATCHER_CLASS_NAME);
      Constructor<?> constructor = fragmentRefWatcherClass.getDeclaredConstructor(RefWatcher.class);
      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();
    // 添加Activity的生命周期回调
    application.registerActivityLifecycleCallbacks(helper.activityLifecycleCallbacks);
}

// 2、在activity的onActivityCreated生命周期调用的时候添加检测fragment逻辑
private final Application.ActivityLifecycleCallbacks activityLifecycleCallbacks = new ActivityLifecycleCallbacksAdapter() {
    @Override public void onActivityCreated(Activity activity, Bundle savedInstanceState) {
    // 遍历os包和v4包下所有的watcher
    for (FragmentRefWatcher watcher : fragmentRefWatchers) {
      // 在onActivityCreated的时候给这个activity添加检测fragment逻辑
      watcher.watchFragments(activity);
    }
  }
};

// 3、给activity添加检测fragment的逻辑
@Override public void watchFragments(Activity activity) {
  FragmentManager fragmentManager = activity.getFragmentManager();
  // 添加递归回调
  fragmentManager.registerFragmentLifecycleCallbacks(fragmentLifecycleCallbacks, true);
}

// 4、 在fragment的生命周期中检测
private final FragmentManager.FragmentLifecycleCallbacks fragmentLifecycleCallbacks = new FragmentManager.FragmentLifecycleCallbacks() {
  @Override
  public void onFragmentDestroyed(FragmentManager fm, Fragment fragment) {
    // 在fragment的生命周期中检测
    refWatcher.watch(fragment);
  }
};

接下去具体的watch逻辑就和activity的一模一样,这里就不多赘述了。

生产环境应用

如果把leakcanary直接搬到线上的话有有以下几个问题需要解决:

  • dump出来的文件有100M左右甚至更大
  • Debug.dumpHprofData(heapDumpFile.getAbsolutePath());dump方法会冻结应用所有进程,持续数秒到数十秒的卡顿

基于以上两个问题,我们可以参考下几家大厂的解决方案:

微信开源的 Martix 中的Matrix-Android-ResourceCanary

Martix 把分析过程需要用到的部分字符串数据和Bitmap的buffer数组外,其余的buffer数据都直接剔除,这样处理之后的Hprof文件通常能比原始文件小1/10以上。

其他主要增加了一些误报的优化。

美团的 Probe:Android线上OOM问题定位组件

通过 native hook 了虚拟机写入 hprof 文件的操作,在这里先过滤了某些数据,最终生成的 hprof 文件就是裁剪后的了。在不考虑可能会有的兼容性问题,这个方案要比其他的方案要高效,因为它解决了 hprof 加载的内存问题。

但是Probe是闭源的。

快手的 KOOM——高性能线上内存监控方案

快手最近开源的KOOM有这几个亮点:

  • 实现了Probe中提出 hook 生成 hprof 的 native 方法
  • 解决了 dumpHprofData 方法阻塞问题
  • 使用了 LeakCanary2 中使用的 hprof 分析库 shark

对于 dumpHprofData 方法阻塞问题,koom的解决方式是fork新进程来执行dump操作,这样对父进程的正常执行没有影响。以下是耗时对比:

fork dump normal dump
耗时(ms) 139.5 19962.5

综上对比,只有koom解决了线上应用的两大痛点。

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

推荐阅读更多精彩内容

  • LeakCanary原理浅析 1.LeakCanary简介 LeakCanary是一个Android和Java的内...
    chewbee阅读 6,785评论 2 38
  • 在Android开发中最让人们头疼的就是内存泄漏了,今天来介绍一个查看内存是否泄漏的工具LeakCanary,并通...
    猩程变阅读 308评论 1 0
  • LeakCanary 是由 Square 开源的针对 Android 和 Java 的内存泄漏检测工具。 使用 L...
    小小的coder阅读 353评论 0 1
  • 说到内存泄漏,就必须提到LeakCanary. 这个利器,很方便的显示出内存泄漏的地方。在用到的过程中好奇怎...
    David_zhou阅读 1,184评论 0 0
  • 前提:LeakCanary 版本v2.4; Android 8.0LeakCanary相信很多开发者都用过,也是目...
    baifanger阅读 517评论 0 0