Android内存泄漏检测工具LeakCanary上手指南

LeakCanary官方Demo介绍

  • 首先可以去github上面downlaod它的官方开源Demo
  • 用Android Studio打开leakcanary项目后,在leakcanary-sample ->MainAvtivity目录下可以看到内存泄漏示例


  • 注释说明了此例子内存泄漏的原因:此AsyncTask是一个匿名的内部类,隐式的持有外部类(MainActivity)的引用,当activity被销毁的时候,如果AsyncTask(代码sleep 20秒,模拟了一个耗时操作)没有执行完成,则MainActivity将会泄漏。
  • 运行Demo,点击启动异步线程的Button,在20秒内我们点手机返回键(就是关闭MainActivity的意思,这会让GC回收MainActivity)。
    -大概过了10秒左右,将会在通知栏看到一个内存泄漏的提示:
  • 查看提示
    -总结:在这个例子中,可以看到是由于子线程的引用,导致GC无法回收MainActivity,引发了内存泄漏了(264KB)。

在项目中引入LeakCanary

  1. 配置 build.gradle文件,添加后我们点Sync Now ,或者build一下
dependencies {
//debugCompile是设置仅在我们开发Debug的时候,LeakCanary才会帮我们去检测内存泄漏
   debugCompile 'com.squareup.leakcanary:leakcanary-android:1.4-beta2'
// releaseCompile是打包的时候LeakCanary不生效
   releaseCompile 'com.squareup.leakcanary:leakcanary-android-no-op:1.4-beta2'
   testCompile 'com.squareup.leakcanary:leakcanary-android-no-op:1.4-beta2'
 }
  1. 在项目里添加一个类叫MyApplication 继承自Application ,并在其中“安装” LeakCannary:
public class MyApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        LeakCanary.install(this);
    }
}
  • 记得把它作为 android:name 配到 AndroidManifest.xml 的 Application 节点下

完成这些步骤后就已经把环境基本上配置好了,不添加任何代码,LeakCanary会默认帮我们去检测Activity的内存泄漏。

写一个内存泄漏的Demo

  • UI布局
  <?xml version="1.0" encoding="utf-8"?>
  <RelativeLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"    > 
  <Button        
    android:layout_centerHorizontal="true"
    android:id="@+id/button"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:text="开启异步线程"/>
</RelativeLayout>
  • 在MainActivity中添加代码
public class MainActivity extends AppCompatActivity implements View.OnClickListener {
    private TextView mTv;
    private Button mButton;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        mButton = (Button) findViewById(R.id.button);
        mButton.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                startAsyncTask();
            }
        });
    }

    public void startAsyncTask(){
        new AsyncTask<Void,Void,Void>(){
            @Override
            protected Void doInBackground(Void... params) {
                Log.v("家俊","doInBackground");
                SystemClock.sleep(10000);
                return null;
            }
        }.execute();
    }
  • 运行代码,点击button后等待10秒,LeakCanary提示内存泄漏。

  • 分析其中的原因:

  • AsyncTask是一个匿名的内部类,隐式的持有外部类(MainActivity)的引用,当activity被销毁的时候,如果AsyncTask(代码sleep 20秒,模拟了一个耗时操作)没有执行完成,则MainActivity将会泄漏

  • 关于隐式引用----内部类可以直接去调用外部类的成员(属性和方法),如果没有持有外部类的引用,内部类是没办法去调用外部类的成员,但是内部类又没有显示的去指定声明引用,所以称之为隐式引用。

LeakCanary使用方式

  1. 监控 Activity 泄露(默认)
    由于经常把 Activity 当作为 Context 对象使用,在不同场合由各种对象引用 Activity。所以,Activity 泄漏是一个重要的需要检查的内存泄漏之一。

  2. 监控Fragment泄漏
    -使用RefWatcher监控
    此类的对象的获取方式:RefWatcher refWatcher=LeakCanary.install(this);
    可以在刚才自定义的全局MyApplication 中去获取。代码如下:

public class MyApplication extends Application {
    public static RefWatcher refWatcher;

    @Override
    public void onCreate() {
        super.onCreate();
        refWatcher = LeakCanary.install(this);
    }
}

然后,在需要检测Fragment回收的地方,加入refWatcher.watch(this);
-代码如下

public abstract class BaseFragment extends Fragment {
    @Override 
    public void onDestroy() {
        super.onDestroy();
        RefWatcher refWatcher = MyApplication.refWatcher;
        refWatcher.watch(this);
    }
}

当 Fragment.ondestroy()被调用之后,如果这个 fragment 实例没有被销毁,那么就会从通知栏和 logcat 里看到相应的泄漏信息。

  1. 监控其他泄漏
  RefWatcher refWatcher = MyApplication.refWatcher;
  refWatcher.watch(someObjNeedGced);

someObjNeedGced标识我们需要监控的对象,当 someObjNeedGced 还在内存中时,就会在 logcat 里看到内存泄漏的提示。

原理

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

推荐阅读更多精彩内容