LeakCanary-帮助你检测Android所有的内存泄漏

平时我们在写Android代码的时候会经常遇到非常多的Out Of Memory异常,可以通过leakcanary这个第三方库帮助我们定位出现问题的地方

LeakCanary是什么

  • LeakCanary是一个能够帮助Android和Java开发者检查内存泄露的第三方库

LeakCanary的配置

  • 在你的build.gradle文件的dependencies中添加如下代码 :
debugCompile 'com.squareup.leakcanary:leakcanary-android:1.4-beta2'
releaseCompile 'com.squareup.leakcanary:leakcanary-android-no-op:1.4-beta2'
testCompile 'com.squareup.leakcanary:leakcanary-android-no-op:1.4-beta2'
添加依赖
  • 新建一个MyApplication类继承Application初始化LeakCanary
package com.android.oz.myleakactiviy;
import android.app.Application;
import com.squareup.leakcanary.LeakCanary;
/** * @author O.z Young 
* @date 16/8/29 
*/
public class MyApplication extends Application {    
    @Override    
    public void onCreate() {        
        super.onCreate();
        // 安装LeakCanary
        LeakCanary.install(this);
    }}
}
  • 在你的AndroidManifest.xml中配置刚才写好的MyApplication
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"    package="com.android.oz.myleakactiviy">    
  <application
        android:name=".MyApplication"
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>
</manifest>
配置MyApplication

好了,到此为止你的App已经添加上了LeakCanary下面写一个例子用来展示一下LeeakCanary的实力


使用例子

我们在使用多线程Handler + Thread进行交互的的时候经常会出现Out of Memory的情况,下面通过一个例子来进行分析,以及修正这个例子

  • 首先确认布局activity_main.xml
<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"    xmlns:tools="http://schemas.android.com/tools"    android:layout_width="match_parent"    android:layout_height="match_parent"    android:paddingBottom="@dimen/activity_vertical_margin"    android:paddingLeft="@dimen/activity_horizontal_margin"    android:paddingRight="@dimen/activity_horizontal_margin"    android:paddingTop="@dimen/activity_vertical_margin"    tools:context="com.android.oz.myleakactiviy.MainActivity">
    <ImageView
        android:id="@+id/iv_image"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content" />
</RelativeLayout>

这是一个很简单的布局,在一个相对布局中包含一个ImageView.

  • 编写onCreate方法
@Overrideprotected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    iv_image = (ImageView) findViewById(R.id.iv_image);
    new Thread(new Runnable() {
        @Override
        public void run() {
            for (int i = 0; i < 20; i++) {
                Log.v("Oz", "运行-->" + i + "次");
                SystemClock.sleep(2000);
                Message message = mHandler.obtainMessage();
                message.what = 0;
                mHandler.sendMessageDelayed(message, 5000);
            }
        }
    }).start();
}

onCreate方法中,定义了一个Thread,这个子线程要运行20次,每运行一次都要发送一个消息给Handler去处理,这里使用了SystemClock.sleep(time)方法,是为了模拟网络请求的等待

  • 编写成员变量Handler
private Handler mHandler = new Handler() {
    @Override
    public void handleMessage(Message msg) {
        switch (msg.what) {
            case 1:
                iv_image.setImageResource(R.mipmap.ic_launcher);
                break;
        }
    }
};

这里就是处理刚才接受到消息的地方啦,接收到消息之后给iv_image设置一个图片

  • 运行这个app

在app被成功安装到手机上之后,我们看到这里除了我们自己的app还多了一个应用,另外一个应用就是LeakCanary

安装成功

在运行的时候我们不要等待两秒钟的时间,一进入到程序之后就点击返回键,退出程序,发现有LeakCanary的消息推送,点开以后内容如下

LeakCanary中的内容
  • 问题分析

可以很清楚的看到,这里的问题是这个Thread导致的,那么为什么会出现这个问题呢,原因就是我们在Thread中sleep了两秒,然后在还没有到两秒的时间中,我们点击了返回键,此时这个MainActivity就已经被销毁了,但是在MainActivity中,这个Thread还是存在的,所以导致了最终的内存溢出问题

  • 改造Thread

由于产生问题的原因在于,MainActivity已经销毁了,但是我们的Thread还没有销毁,那么我们可以自定义一个静态的MyThread类去继承Thread类,让MyThread与MainActivity的关系脱离,除此以外我们在MyThread中使用MainActivity的弱引用,这样当GC扫描到我们的Thread类的时候,发现有弱应用就会自动回收了,这样进一步提高内存的利用率.

  • 定义一个MyThread继承Thread并且声明MainActivity的弱引用

重写后的MyThread,因为将MyThread声明成一个静态的类,所以在里面使用mHandler的时候需要绕一下弯子,通过弱引用weakReference获取到MainActivity里面的mHandler对象

private static class MyThread extends Thread {
    private WeakReference<MainActivity> weakReference;
    public MyThread(MainActivity mainActivity) {
        weakReference = new WeakReference<MainActivity>(mainActivity);
    }
    @Override
    public void run() {
        for (int i = 0; i < 20; i++) {
            Log.v("Oz", "运行-->" + i + "次");
            SystemClock.sleep(2000);
            if (weakReference != null && weakReference.get() != null) {
                //Message message = mHandler.obtainMessage();
                //message.what = 0;
                //mHandler.sendMessageDelayed(message, 5000);
                Message message =
 weakReference.get().mHandler.obtainMessage();
                message.what = 0;
                weakReference.get().mHandler.sendMessageDelayed(message, 5000);
            }
        }
    }
}
  • 再次运行

还是跟刚才一样,进入程序之后,不到两秒的时间点击返回键,过一会以后,LeakCanary又报错了

第二次报错

如果你有看过Handler和Message的源码,Message.target实际上指的就是Handler.这里的Handler报错的原因跟刚才Thread报错的原因是一样的,这里就不再重复说明了,接下来我们就要对Handler进行改造.

  • Handler进行改造

改造后的Handler

private static class MyHandler extends Handler {
    private WeakReference<MainActivity> weakReference;
    public MyHandler(MainActivity mainActivity) {
        weakReference = new WeakReference<MainActivity>(mainActivity);    }
    @Override
    public void handleMessage(Message msg) {
        switch (msg.what) {
            case 1:
                if (weakReference != null && weakReference.get() != null) {
                    weakReference.get().iv_image.setImageResource(R.mipmap.ic_launcher);
                }
                break;
        }
    }
}

这个时候再去运行app已经不提示错误了,但是此时我们又发现了一个新的问题,当我们退出app的时候,我们MyThread却还在一直运行,后台的日志里也在不断的输出内容

后台打印的内容

如何处理这个问题呢?

  • 后台一直在输出Log日志的原因分析

我们在退出app之后并没有将MyThread的停止,所以导致了后台一直在输出打印语句,那么我们该如何解决这个问题呢?

  • 停止MyThread线程

首先我们需要明确,停止掉一个线程不能使用Thread.stop()方法,查看了源码发现已经是过时了的方法,并且在注释里面也明确说明,调用这个方法是不安全的,如果调用了这个方法会导致一个不可预知的状态.

原因分析

其实,我们可以使用一个标识位来判断一下是否要继续执行MyThread里面的循环方法,如果标识位的判断结果为false我们直接跳出循环就可以了.在MainActivity销毁的时候将这个标识位设置成false即可.

新增标识位

/**
 * 定义的标识位,判断MyThread中的循环是否执行
 **/
private static boolean mIsRunning = false;
/**
 * 将标识位设置成false跳出循环
 **/
public void setmIsRunning() {
    mIsRunning = false;
}

修改MyThread

private static class MyThread extends Thread {
    private WeakReference<MainActivity> weakReference;
    public MyThread(MainActivity mainActivity) {
        weakReference = new WeakReference<MainActivity>(mainActivity);
    }
    @Override
    public void run() {
        mIsRunning = true;
        for (int i = 0; i < 20; i++) {
            if (!mIsRunning) {
                break;
            }
            Log.v("Oz", "运行-->" + i + "次");
            SystemClock.sleep(2000);
            if (weakReference != null && weakReference.get() != null) {
                //Message message = mHandler.obtainMessage();
                //message.what = 0;
                //mHandler.sendMessageDelayed(message, 5000);
                Message message = weakReference.get().myHandler.obtainMessage();
                message.what = 0; 
               weakReference.get().myHandler.sendMessageDelayed(message, 5000);
            }
        }
    }
}

新增onDestory方法

@Override
protected void onDestroy() {
    super.onDestroy();
    // 将标识位设置成false
    setmIsRunning();
    // 清空message中的消息
    myHandler.removeCallbacksAndMessages(null);
}

到这里问题就已经解决啦~

最后本次Demo的源码已经上传到github上了,便于大家查看

MyLeakActivity

转载请注明出处


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

推荐阅读更多精彩内容