Android Handler leak 分析及解決辦法

 In Android, Handler classes should be static or leaks might occur, Messages enqueued on the application thread's MessageQueue also retain their target Handler. If the Handler is an inner class, its outer class will be retained as well. To avoid leaking the outer class, declare the Handler as a static nested class with a WeakReference to its outer class.

    在Android中，Handler類應該是靜態的，否則，可能發生泄漏。在應用程序線程的MessageQueue中排隊的Message對象 還保留他們的目標Handler。如果Handler是一個內部類（注：無論是匿名還是非匿名，匿名是比較常見用法），它的外部類將被保留（至於為什么， 請參考Java嵌套類相關說明）。為了避免泄漏外部類，聲明一個Handler子類為靜態內部類（注：這樣就避免了Handler對象對外部類實例的自動引用），其內部持有一個對外部類對象的WeakReference。

    上面是HandlerLeak的詳細解釋，同時下划線部分也提供了解決方案的思路。我們需要再分析一下幾個泄漏問題：（1） 排隊中的Message對象對Handler的持有導致泄漏；（2）Handler對象對外部類（如Activity或Service）實例的強引用持 有。是由於這兩個原因同時作用導致出現泄漏的可能。我們的解決方案可以從原因出發，清除這兩個原因，就會比較完整的解決這個問題。

    方案：（1）針對第1個原因，在使用Handler的組件生命周期結束前清除掉MessageQueue中的發送給Handler的Message對象（例如在Activity或Service的onDestroy()中調用Handler的remove*方法）；（2）針對第2個原因，Handler的實現類采用靜態內部類的方式，避免對外部類的強引用，在其內部聲明一個WeakReference引用到外部類的實例。

    關於Handler的remove*方法，這兒介紹一下（可以參考源碼或文檔）

removeCallbacks(Runnable r) ——清除r匹配上的Message。

removeCallbacks(Runnable r, Object token) ——清除r匹配且匹配token（Message.obj）的Message，token為空時，只匹配r。

removeCallbacksAndMessages(Object token) ——清除token匹配上的Message。

removeMessages(int what) ——按what來匹配

removeMessages(int what, Object object) ——按what來匹配

我們更多需要的是清除以該Handler為target的所有Message（包括Callback），那么調用如下方法即可

    handler.removeCallbacksAndMessages(null);

    最終代碼像下面這樣

package org.dragonboy.example;

import java.lang.ref.WeakReference;

import android.app.Activity;
import android.os.Bundle;
import android.os.Handler;
import android.os.Message;

/**
 * @author [e-mail]
 */
public class MyActivity extends Activity {
	private MyHandler mHandler;

	@Override
	protected void onCreate(Bundle savedInstanceState) {
		super.onCreate(savedInstanceState);

		mHandler = new MyHandler(this);
	}

	@Override
	protected void onDestroy() {
		// Remove all Runnable and Message.
		mHandler.removeCallbacksAndMessages(null);

		super.onDestroy();
	}

	static class MyHandler extends Handler {
		// WeakReference to the outer class's instance.
		private WeakReference<MyActivity> mOuter;

		public MyHandler(MyActivity activity) {
			mOuter = new WeakReference<MyActivity>(activity);
		}

		@Override
		public void handleMessage(Message msg) {
			MyActivity outer = mOuter.get();
			if (outer != null) {
				// Do something with outer as your wish.
			}
		}
	}
}