Handler Thread 内部类引起内存泄露分析

Posted 2020-10-04 白乾涛

非静态内部类引起内存泄漏的原因

内部类的实现其实是通过编译器的语法糖（Syntactic sugar）实现的，通过生成相应的子类即以OutClassName$InteriorClassName命名的Class文件。并添加构造函数，在构造函数中【传入】外部类，这也是为什么内部类能使用外部类的方法与字段的原因。所以，当外部类与内部类生命周期不一致的时候很有可能发生内存泄漏。

Handler引起内存泄漏案例分析

例如，当使用内部类（包括匿名类）来创建Handler的时候，Handler对象会隐式地持有一个外部类对象（通常是一个Activity）的引用。而Handler通常会伴随着一个耗时的后台线程一起出现，这个后台线程在任务执行完毕之后，通过消息机制通知Handler，然后Handler把图片更新到界面。

然而，如果用户在网络请求过程中关闭了Activity，正常情况下，Activity不再被使用，它就有可能在GC检查时被回收掉，但由于这时线程尚未执行完，而该线程持有Handler的引用，这个Handler又持有Activity的引用，就导致该Activity无法被回收，直到网络请求结束。

另外，如果你执行了Handler的postDelayed()方法，该方法会将你的Handler装入一个Message，并把这条Message推到MessageQueue中，那么在你设定的delay到达之前，会有一条MessageQueue -> Message -> Handler -> Activity的链，导致你的Activity被持有引用而无法被回收。

Handler完整方案示例

首先：将内部类声明为静态内部类（通用方法）

在Java 中，非静态的内部类和匿名内部类都会隐式地持有其外部类的引用，静态的内部类不会持有外部类的引用。如果你想使用外部类的话，可以通过软引用或弱引用的方式保存外部类的引用。

静态类不持有外部类的对象，所以你的Activity可以随意被回收。由于Handler不再持有外部类对象的引用，导致程序不允许你在Handler中操作Activity中的对象了。所以你需要在Handler中增加一个对Activity的弱引用（WeakReference）。

对于Handler，还可以通过程序逻辑来进行保护

1、在关闭Activity的时候停掉你的后台线程。线程停掉了，就相当于切断了Handler和外部连接的线，Activity自然会在合适的时候被回收。

2、如果你的Handler是被delay的Message持有了引用，那么使用相应的Handler的removeCallbacks()方法，把消息对象从消息队列移除就行了。

public class MainActivity extends Activity {
    private Handler mHandler = new MyHandler(this);
    public TextView textView;
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        textView = new TextView(this);
        textView.setText("包青天");
        setContentView(textView);
        mHandler.sendMessageDelayed(Message.obtain(), 2000);
    }
    private static class MyHandler extends Handler {
        private WeakReference<MainActivity> mWeakReference;
        public MyHandler(MainActivity activity) {
            mWeakReference = new WeakReference<MainActivity>(activity);
        }
        @Override
        public void handleMessage(Message msg) {
            MainActivity activity = mWeakReference.get();
            if (activity != null) activity.textView.setText("静态内部类的Handler");
        }
    }
    @Override
    protected void onDestroy() {
        super.onDestroy();
        if (mHandler != null) mHandler.removeCallbacksAndMessages(null);
    }
}

Thread引起内存泄漏案例分析

例如在一个Activity启动一个Thread执行一个任务，因为Thread是内部类持有了Activity的引用，当Activity销毁的时候如果Thread的任务没有执行完成，造成Activity的引用不能被释放从而引起内存泄漏。

这种情况下可以通过声明一个静态内部类来解决问题，从反编译中可以看出，声明为static的内部类不会持有外部类的引用。此时，如果你想在静态内部类中使用外部类的话，可以通过软引用的方式保存外部类的引用。

在Activity里声明了一个匿名内部类，如果Activity在销毁之前，线程的任务还未完成， 那么将导致Activity的内存资源无法回收，造成内存泄漏。

/**
 * 测试非静态内部类导致内存泄漏的问题
 */
public class MemoryLeaksActivity extends Activity {
    TextView textView;
    
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        textView = new TextView(this);
        setContentView(textView);
        String startTime = new SimpleDateFormat("yyyy.MM.dd HH:mm:ss SSS", Locale.getDefault()).format(new Date());
        textView.setText("开始休息 " + startTime);
        
        new Thread(() -> {
            SystemClock.sleep(1000 * 5);
            String endTime = new SimpleDateFormat("yyyy.MM.dd HH:mm:ss SSS", Locale.getDefault()).format(new Date());
            Log.i("bqt", "【结束休息】" + endTime);//即使Activity【onDestroy被回调了】，这条日志仍会打出来
            //runOnUiThread(() -> textView.append("\n结束休息 " + endTime));
        }).start();
    }
    
    @Override
    protected void onDestroy() {
        super.onDestroy();
        Log.i("bqt", "【onDestroy被回调了】");
    }
}

Thread解决方案示例

解决办法就是使用静态内部类，如下：

/**
 * 测试使用静态内部类避免导致内存泄漏
 */
public class MemoryLeaksActivity extends Activity {
    TextView textView;
    
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        textView = new TextView(this);
        setContentView(textView);
        String startTime = new SimpleDateFormat("yyyy.MM.dd HH:mm:ss SSS", Locale.getDefault()).format(new Date());
        textView.setText("开始休息 " + startTime);
        
        new MyThread(this).start();
    }
    
    @Override
    protected void onDestroy() {
        super.onDestroy();
        Log.i("bqt", "【onDestroy被回调了】");
    }
    
    private static class MyThread extends Thread {
        SoftReference<Activity> context;
        
        MyThread(Activity activity) {
            context = new SoftReference<>(activity);
        }
        
        @Override
        public void run() {
            SystemClock.sleep(1000 * 15);
            String endTime = new SimpleDateFormat("yyyy.MM.dd HH:mm:ss SSS", Locale.getDefault()).format(new Date());
            Log.i("bqt", "【结束休息】" + endTime);//即使Activity【onDestroy被回调了】，这条日志仍会打出来
            if (context.get() != null) {
                context.get().runOnUiThread(() -> Toast.makeText(context.get(), "结束休息", Toast.LENGTH_SHORT).show());
            }
        }
    }
}

2017-8-24

来自为知笔记(Wiz)