LeakCanary - Android内存检测工具

LeakCanary背景

java.lang.OutOfMemoryError
        at android.graphics.Bitmap.nativeCreate(Bitmap.java:-2)
        at android.graphics.Bitmap.createBitmap(Bitmap.java:689)
        at com.squareup.ui.SignView.createSignatureBitmap(SignView.java:121)

大名鼎鼎的OOM,就是内存泄漏,那什么是内存泄漏呢?

一些对象有着有限的生命周期。当这些对象所要做的事情完成了,我们希望他们会被回收掉。但是如果有一系列对这个对象的引用,那么在我们期待这个对象生命周期结束的时候被收回的时候,它是不会被回收的。它还会占用内存,这就造成了内存泄露。持续累加,内存很快被耗尽。

举个例子,当 Activity.onDestroy被调用之后,activity以及它涉及到的view和相关的bitmap都应该被回收。但是,如果有一个后台线程持有这个activity的引用,那么activity对应的内存就不能被回收。这最终将会导致内存耗尽,然后因为OOM而崩溃,这个,就叫做内存泄漏。

所以,我们在写程序的时候,要捕捉到我们写的存在内存泄漏的代码修复掉,LeakCanary就应运而生!

LeakCanary简介

LeakCanary 是啥?它的说明是这样的:
A memory leak detection library for Android and Java./一个Android和java内存泄漏检测库。
很简单,就是捕获内存泄漏的

LeakCanary好处

它可以在我们的应用发生内存泄漏的时候发出提醒,提醒包括通知和Log。并且集成起来特别简单方便

LeakCanary缺点

有好处就会有缺点,LeakCanary也不是万能的。
它是在相应的问题页面回退之后才会分析是否存在内存泄漏,如果存在内存泄漏,将进行相应的分析并处理,若没有则不会。它不能做到MAT或者studio中相应的实时查看内存状态,并且检测具有很大的延时,最少10s。

LeakCanary使用

①在你的build.gradle中添加依赖:

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

②在你的Application中初始化

public class MyApplication extends Application {

  @Override public void onCreate() {
    super.onCreate();
    if (LeakCanary.isInAnalyzerProcess(this)) {
      // This process is dedicated to LeakCanary for heap analysis.
      // You should not init your app in this process.
      return;
    }
    LeakCanary.install(this);
    // Normal app init code...
  }
}

这样就可以了。
然后测试一下怎么样,我们自己弄出一个内存泄露看看它怎么工作的吧

public class ErrorTestActivity extends AppCompatActivity {

    private static ErrorTest mErrorTest;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        if (mErrorTest == null) {
            mErrorTest = new ErrorTest();
        }
        finish();
    }

    class ErrorTest {
    }
}

我们首先再来分析一下这个程序:
这个Activity中,存在一个静态的ErrorTest实例,并且这个实例在Activity初始化的时候也进行了初始化,接着我们在初始化完毕后finish掉这个Activity。
因为mErrorTest是一个静态的变量并且不为null,所以GC不会将其清理,而Activity因为持有这个静态变量,生命周期也不能正常执行,不能进行onDestroy()。这样这个Activity内存泄漏了!

安装我们的应用后,手机上会出现如下两个图标:
左侧的是自己应用的图标,右侧是自动给安装的LeakCanary的图标。


安装样式

打开我们的APP,跳转到我们的问题页面ErrorTestActivity,人为制造内存泄漏,之后Back出去,等一段时间,看情况,一般会大于10s,有些会更长(不清楚具体的触发条件,什么时候开始检测,作者也没具体说明)因为ErrorTestActivity存在内存泄漏,LeakCanary就会检测出来,Toast提示:


检测样式

OK,出现这样的Toast,你的代码就存在内存泄漏了,然后打开自动给你安装的LeakCanary小程序(这里需要点小耐心,因为需要一会才会更新到LeakCanary上面)


展示错误信息

OK,根据展示信息,ErrorTestActivity里面的的实例对象被泄漏了

LeakCanary进阶 - RefWatcher

RefWatcher的作用是监控那些本该被回收的对象
看上面我们在Application我们初始化LeakCanary的代码有这么一行:

LeakCanary.install(this);

它会返回一个预定义的RefWatcher,同时也会启用一个 ActivityRefWatcher,用于自动监控
调用了Activity.onDestroy()之后存在泄露的activity。我们也可以使用RefWatcher来监测我们关心的对象。
那这样我们可以这么写我们的Application

public class MyApplication extends Application {

  private static RefWatcher refWatcher;

  @Override 
  public void onCreate() {
    super.onCreate();
    if (LeakCanary.isInAnalyzerProcess(this)) {
      return;
    }
    //LEAK_ENABLE就是个开关,我是用来标识发包版本关闭LeakCanary工具的
    ifBuildConfig.LEAK_ENABLE){
      refWatcher = LeakCanary.install(this);
    }
  }

  public static RefWatcher getRefWatcher() {
      return refWatcher;
  }
}

这样我们就可以使用RefWatcher监控一些本该关掉(调用onDestroy了)的对象,比如使用RefWatcher监控自定义的Fragment:

public abstract class TLifeBaseFragment extends Fragment {

    ····

    @Override 
    public void onDestroy() {
        super.onDestroy();
        RefWatcher refWatcher = MyApplication.getRefWatcher();
        refWatcher.watch(this);
    }
}

最后附上GitHub的链接地址:GitHub

感谢成长过程中的大神们:
LeakCanary: 让内存泄露无所遁形
LeakCanary 中文使用说明

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

推荐阅读更多精彩内容