[译] 探索 Android 大杀器——Handler

原文链接:https://github.com/xitu/gold-miner/blob/master/TODO/android-handler-internals.md

由浅入深,带你认识 Handler 的内部实现原理。 —— 由 Jamweak 分享

如果你想要让一个 Android 应用程序反应灵敏,那么你必须防止它的 UI 线程被阻塞。同样地,将这些阻塞的或者计算密集型的任务转到工作线程去执行也会提高程序的响应灵敏性。然而,这些任务的执行结果通常需要更新UI组件的显示,但该操作只能在UI线程中去执行。有一些方法解决了 UI 线程的阻塞问题,例如阻塞队列,共享内存以及管道技术。在 Android 中,为解决这个问题,提供了一种自有的消息传递机制——Handler。Handler 是 Android Framework 架构中的一个基础组件,它实现了一种非阻塞的消息传递机制,在消息转换的过程中,消息的生产者和消费者都不会阻塞。

虽然 Handler 被使用的频率非常高,它的工作原理却很容易被忽视。本篇文章深入地剖析 Handler 众多内部组件的实现,它将会向您揭示 Handler 的强大之处,而不仅仅作为一个工作线程和 UI 线程通信的工具。

图片浏览示例

让我们从一个例子开始了解如何在应用中使用 Handler。设想一个 Activity 需要从网络上获取图片并显示。有几种方式来做这件事,在下面的例子中,我们创建了一个新的工作线程去执行网络请求以获取图片。

public class ImageFetcherActivity extends AppCompactActivity {
    class WorkerThread extends Thread {
        void fetchImage(String url) {
            // network logic to create and execute request
            handler.post(new Runnable() {
                @Override
                public void run() {
                    imageView.setImageBitmap(image);
                }
            });
        }
    }
    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        // prepare the view, maybe setContentView, etc
        new WorkerThread().fetchImage(imageUrl);
    }
}

另一种方法则是使用 Handler Messages 来代替 Runnable 类。

public class ImageFetcherAltActivity extends AppCompactActivity {
    class WorkerThread extends Thread {
        void fetchImage(String url) {
            handler.sendEmptyMessage(MSG_SHOW_LOADER);
            // network call to load image
            handler.obtainMessage(MSG_SHOW_IMAGE, imageBitmap).sendToTarget();
        }
    }
    class UIHandler extends Handler {
        @Override
        public void handleMessage(Message msg) {
            switch (msg.what) {
                case MSG_SHOW_LOADER: {
                    progressIndicator.setVisibility(View.VISIBLE);
                    break;
                }
                case MSG_HIDE_LOADER: {
                    progressIndicator.setVisibility(View.GONE);
                    break;
                }
                case MSG_SHOW_IMAGE: {
                    progressIndicator.setVisibility(View.GONE);
                    imageView.setImageBitmap((Bitmap) msg.obj);
                    break;
                }
            }
        }
    }
    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        // prepare the view, maybe setContentView, etc
        new WorkerThread().fetchImage(imageUrl);
    }
}

在第二个例子中,工作线程从网络获取到一张图片,一旦下载完成,我们需用使用下载好的 bitmap 去更新 ImageView 显示内容。我们知道不能在非 UI 线程中更新 UI 组件,因此我们使用 Handler。Handler 扮演了工作线程和 UI 线程的中间人的角色。消息在工作线程中被 Handler 加入队列,随后在 UI 线程中被 Handler 处理。

深入了解 Handler

Handler 由以下部分组成:

  • Handler

  • Message

  • Message Queue

  • Looper

我们接下来将学习各个组件以及他们之间的交互。

Handler

Handler[2] 是线程间传递消息的即时接口,生产线程和消费线程调用以下操作来使用 Handler:

  • 在消息队列中创建、插入或移除消息

  • 在消费线程中处理消息

android.os.Handler 组件

每个 Handler 都有一个与之关联的 Looper 和消息队列。有两种创建 Handler 的方式:

  • 通过默认的构造方法,使用当前线程中关联的 Looper

  • 显式地指定使用的 Looper

没有指定 Looper 的 Handler 是无法工作的,因为它无法将消息放到消息队列中。同样地,它无法获取要处理的消息。

public Handler(Callback callback, boolean async) {
    // code removed for simplicity
    mLooper = Looper.myLooper();
    if (mLooper == null) {
        throw new RuntimeException( “Can’t create handler inside thread that has not called Looper.prepare()”);
    }
    mQueue = mLooper.mQueue;
    mCallback = callback;
    mAsynchronous = async;
}

上面的代码段展示了创建一个新的 Handler 的逻辑。Handler 在创建时检查了当前的线程有没有可用的 Looper 对象,如果没有,它会抛出一个运行时的异常。如果正常的话,Handler 则会持有 Looper 中消息队列对象的引用。

注意: 同一线程中的多个 Handler 分享一个同样的消息队列,因为他们分享的是同一个 Looper 对象。

Callback 参数是一个可选参数,如果提供的话,它将会处理由 Looper 分发过来的消息。

Message

Message[3] 是容纳任意数据的容器。生产线程发送消息给 Handler,Handler 将消息加入到消息队列中。消息提供了三种额外的信息,以供 Handler 和消息队列处理时使用:

  • what ——一种标识符,Handler 能使用它来区分不同消息,从而采取不同的处理方法

  • time ——告知消息队列何时处理消息

  • target —— 表示哪一个 Handler 应当处理消息

android.os.Message 组件

消息一般是通过 Handler 中以下方法来创建的:

public final Message obtainMessage()
public final Message obtainMessage(int what)
public final Message obtainMessage(int what, Object obj)
public final Message obtainMessage(int what, int arg1, int arg2)
public final Message obtainMessage(int what, int arg1, int arg2, Object obj)

消息从消息池中获取得到,方法中提供的参数会放到消息体的对应字段中。Handler 同样可以设置消息的目标为其自身,这允许我们可以进行链式调用,比如:

mHandler.obtainMessage(MSG_SHOW_IMAGE, mBitmap).sendToTarget();

消息池是一个消息体对象的 LinkedList 集合,它的最大长度是 50。在 Handler 处理完这条消息之后,消息队列把这个对象返回到消息池中,并且重置其所有字段。

当使用 Handler 调用 post 方法来执行一个 Runnable 时,Handler 隐式地创建了一个新的消息,并且设置 callback 参数来存储这个 Runnable。

Message m = Message.obtain();
m.callback = r;

生产线程发送消息给 Handler 的交互

在上图中,我们能看到生产线程和 Handler 的交互。生产者创建了一个消息,并且发送给了 Handler,随后 Handler 将这个消息加入消息队列中,在未来的某个时间,Handler 会在消费线程中处理这个消息。

Message Queue

Message Queue[4] 是一个消息体对象的无界的 LinkedList 集合。它按时序将消息插入队列,最小的时间戳将会被首先处理。

android.os.MessageQueue 组件

消息队列也通过 SystemClock.uptimeMillis 获取当前时间,维护着一个阻塞阈值(dispatch barrier)。当一个消息体的时间戳低于这个值的时候,消息就会被分发给 Handler 进行处理。

Handler 提供了三种方式来发送消息:

public final boolean sendMessageDelayed(Message msg, long delayMillis)
public final boolean sendMessageAtFrontOfQueue(Message msg)
public boolean sendMessageAtTime(Message msg, long uptimeMillis)

以延迟的方式发送消息,是设置了消息体的 time 字段为SystemClock.uptimeMillis() + delayMillis 。

延迟发送的消息设置了其时间字段为 SystemClock.uptimeMillis() + delayMillis。然而,通过 sendMessageAtFrontOfQueue() 方法把消息插入到队首,会将其时间字段设置为 0,消息会在下一次轮询时被处理。需要谨慎使用这个方法,因为它可能会影响消息队列,造成顺序问题,或是其它不可预料的副作用。

Handler 常与一些 UI 组件相关联,而这些 UI 组件通常持有对 Activity 的引用。Handler 持有的对这些组件的引用可能会导致潜在的 Activity 泄露。考虑如下场景:

public class MainActivity extends AppCompatActivity {
    private static final String IMAGE_URL = "https://www.android.com/static/img/android.png";
    private static final int MSG_SHOW_PROGRESS = 1;
    private static final int MSG_SHOW_IMAGE = 2;
    private ProgressBar progressIndicator;
    private ImageView imageView;
    private Handler handler;
    class ImageFetcher implements Runnable {
        final String imageUrl;
        ImageFetcher(String imageUrl) {
            this.imageUrl = imageUrl;
        }
        @Override
        public void run() {
            handler.obtainMessage(MSG_SHOW_PROGRESS).sendToTarget();
            InputStream is = null;
            try {
                // Download image over the network
                URL url = new URL(imageUrl);
                HttpURLConnection conn = (HttpURLConnection) url.openConnection();
                conn.setRequestMethod("GET");
                conn.setDoInput(true);
                conn.connect();
                is = conn.getInputStream();
                // Decode the byte payload into a bitmap
                final Bitmap bitmap = BitmapFactory.decodeStream(is);
                handler.obtainMessage(MSG_SHOW_IMAGE, bitmap).sendToTarget();
            } catch (IOException ignore) {
            } finally {
                if (is != null) {
                    try {
                        is.close();
                    } catch (IOException ignore) {
                    }
                }
            }
        }
    }
    class UIHandler extends Handler {
        @Override
        public void handleMessage(Message msg) {
            switch (msg.what) {
                case MSG_SHOW_PROGRESS: {
                    imageView.setVisibility(View.GONE);
                    progressIndicator.setVisibility(View.VISIBLE);
                    break;
                }
                case MSG_SHOW_IMAGE: {
                    progressIndicator.setVisibility(View.GONE);
                    imageView.setVisibility(View.VISIBLE);
                    imageView.setImageBitmap((Bitmap) msg.obj);
                    break;
                }
            }
        }
    }
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        progressIndicator = (ProgressBar) findViewById(R.id.progress);
        imageView = (ImageView) findViewById(R.id.image);
        handler = new UIHandler();
        final Thread workerThread = new Thread(new ImageFetcher(IMAGE_URL));
        workerThread.start();
    }
}

在这个例子中,Activity 开启了一个新的工作线程去下载并且在 ImageView 中展示图片。工作线程通过 UIHandler 去通知 UI 更新,这样就会持有了对 View 的引用,以便更新这些 View 的状态(切换可见性、设置图片等)。

让我们假设工作线程由于网络差,需要很长的时间去下载图片。在工作线程下载完成之前销毁这个 Activity 会导致 Activity 泄露。在本例中,有两个强引用关系,一个在工作线程和 UIHandler 之间,另一个在 UIHandler 和 View 之间。这就阻止了垃圾回收机制回收 Activity 的引用。

现在,让我们来看看另一个例子:

public class MainActivity extends AppCompatActivity {
    private static final String TAG = "Ping";
    private Handler handler;
    class PingHandler extends Handler {
        @Override
        public void handleMessage(Message msg) {
            Log.d(TAG, "Ping message received");
        }
    }
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        handler = new PingHandler();
        final Message msg = handler.obtainMessage();
        handler.sendEmptyMessageDelayed(0, TimeUnit.MINUTES.toMillis(1));
    }
}

在这个例子中,将按顺序发生如下事件:

  • PingHandler 被创建

  • Activity 发送了一个带延迟的消息给 Handler,随后消息加入到消息队列中

  • Activity 在消息到达之前被销毁

  • 消息被分发,并被 UIHandler 处理,输出一条日志

虽然起初看起来不那么明显,但本例中的 Activity 也存在着泄露。

在销毁 Activity 之后,Handler 应当可以被垃圾回收,然而当创建了一个消息对象之后,它也会持有对 Handler 的引用:

private boolean enqueueMessage(MessageQueue queue, Message msg, long uptimeMillis) {
    msg.target = this;
    if (mAsynchronous) {
        msg.setAsynchronous(true);
    }
    return queue.enqueueMessage(msg, uptimeMillis);
}

上面的 Android 代码段表明,所有被发送到 Handler 的消息最终都会触发 enqueueMessage 方法。注意到 Handler 的引用被显式地赋给了 msg.target,以此来告诉 Looper 对象当消息从消息队列出队时,选择哪一个 Handler 来对其进行处理。

消息加入消息队列后,消息队列就获得了对消息的引用。它同样有一个与之关联的 Looper。一个自定义的 Looper 对象的生命周期一直持续到它被结束,然而主线程中的 Looper 对象在程序的生命周期内一直存在。因此,消息中持有的对 Handler 的引用会一直维持到该消息被消息队列回收之前,一旦消息被回收,它内部的各字段,包括目标 target 的引用都会被清空。

虽然 Handler 能存活很长时间,但是当 Activity 发生泄露时,Handler 不会被清空。为了检查是否发生泄露,我们必须检查 Handler 是否在本类范围内持有 Activity 的引用。在本例中,它确实持有:非静态内部类持有一个对其外部类的隐式引用。明确一点来说,PingHandler 没有定义成一个静态类,所以它持有一个隐式的 Activity 引用。

通过结合使用弱引用和静态类修饰符可以阻止 Handler 导致的 Activity 泄露。当 Activity 被销毁时,弱引用允许垃圾回收器去回收你想要留存的对象(通常来说是 Activity)。在 Handler 内部类前加入静态修饰符可以阻止对外部类持有隐式引用。

让我们来修改上例中的 UIHandler 来解决这个烦恼:

static class UIHandler extends Handler {
    private final WeakReference<imagefetcheractivity> mActivityRef;
    UIHandler(ImageFetcherActivity activity) {
        mActivityRef = new WeakReference(activity);
    }
    @Override
    public void handleMessage(Message msg) {
        final ImageFetcherActivity activity = mActivityRef.get();
        if (activity == null) {
            return
        }
        switch (msg.what) {
            case MSG_SHOW_LOADER: {
                activity.progressIndicator.setVisibility(View.VISIBLE);
                break;
            }
            case MSG_HIDE_LOADER: {
                activity.progressIndicator.setVisibility(View.GONE);
                break;
            }
            case MSG_SHOW_IMAGE: {
                activity.progressIndicator.setVisibility(View.GONE);
                activity.imageView.setImageBitmap((Bitmap) msg.obj);
                break;
            }
        }
    }
}

现在,UIHandler 的构造方法中需要传入 Activity,而这个引用会被弱引用包装。这样就允许垃圾回收器在 Activity 销毁时回收这个引用。当与 Activity 中的 UI 组件交互时,我们需要从 mActivityRef 中获得一个 Activity 的强引用。由于我们正在使用一个弱引用,我们必须小心翼翼地去访问 Activity。如果仅仅能通过弱引用的方式去访问 Activity,垃圾回收器也许已经将其回收了,因此我们需要检查回收是否发生。如果确实被回收,Handler 实际上已经与 Activity 无关了,那么这条消息就应该被丢弃。

虽然这个逻辑解决了内存泄露问题,但仍旧存在一个问题。Activity 已经被销毁,但垃圾回收器还没来得及回收引用,依赖于操作系统运行时的状况,这可能会使你的程序导致潜在的崩溃。为解决这个问题,我们需要获取 Activity 当前的状态。

让我们更新 UIHandler 的逻辑来解决如上场景的问题:

static class UIHandler extends Handler {
    private final WeakReference<imagefetcheractivity> mActivityRef;
    UIHandler(ImageFetcherActivity activity) {
        mActivityRef = new WeakReference(activity);
    }
    @Override
    public void handleMessage(Message msg) {
        final ImageFetcherActivity activity = mActivityRef.get();
        if (activity == null || activity.isFinishing() || activity.isDestroyed()) {
            removeCallbacksAndMessages(null);
            return
        }
        switch (msg.what) {
            case MSG_SHOW_LOADER: {
                activity.progressIndicator.setVisibility(View.VISIBLE);
                break;
            }
            case MSG_HIDE_LOADER: {
                activity.progressIndicator.setVisibility(View.GONE);
                break;
            }
            case MSG_SHOW_IMAGE: {
                activity.progressIndicator.setVisibility(View.GONE);
                activity.imageView.setImageBitmap((Bitmap) msg.obj);
                break;
            }
        }
    }
}

现在,我们可以概括消息队列、Handler、生产线程的交互:

消息队列、Handler、生产线程的交互

在上图中,多个生产线程提交消息到不同的 Handler 中。然而,不同的 Handler 都与同一个 Looper 对象关联,因此所有的消息都加入到同一个消息队列中。这一点非常重要,Android 中创建的许多不同 Handler 都关联到主线程的 Looper:

  • The Choreographer: 处理垂直同步与帧更新

  • The ViewRoot: 处理输入和窗口事件,配置修改等等

  • The InputMethodManager: 处理键盘触摸事件及其它

小贴士:确保生产线程不会大量生成消息,因为这可能会抑制处理系统生成消息。

主线程 Looper 分发消息的小示例

调试帮助: 你可以通过附加一个 LogPrinter 到 Looper 上来 debug/dump 被 Looper 分发的消息:

final Looper looper = getMainLooper();
looper.setMessageLogging(new LogPrinter(Log.DEBUG, "Looper"));

同样地,你可以 debug/dump 所有在消息队列中等待的消息,通过在与消息队列相关联的 Handler 上附加一个 LogPrinter 来实现:

handler.dump(new LogPrinter(Log.DEBUG, "Handler"), "");

Looper

Looper[5] 从消息队列中读取消息,然后分发给对应的 Handler 处理。一旦消息超过阻塞阈,那么 Looper 就会在下一轮读取过程中读取到它。Looper 在没有消息分发的时候会变为阻塞状态,当有消息可用时会继续轮询。

每个线程只能关联一个 Looper,给线程附加另外的 Looper 会导致运行时的异常。通过使用 Looper 类中的 ThreadLocal 对象可以保证每个线程只关联一个 Looper 对象。

调用 Looper.quit() 方法会立即终止 Looper,并且会丢弃消息队列中已经通过阻塞阈的所有消息。调用 Looper.quitSafely() 方法能够保证所有待分发的消息在列队中等待的消息被丢弃前得到处理。

Handler 与消息队列和 Looper 直接交互的整体流程

Looper 应在线程的 run 方法中初始化。调用静态方法 Looper.prepare() 会检查线程是否与一个已存在的 Looper 关联。这个过程的实现是通过 Looper 类中的 ThreadLocal 对象来检查 Looper 对象是否存在。如果 Looper 不存在,将会创建一个新的 Looper 对象和一个新的消息队列。Android 代码 中的如下片段展示了这个过程。

注意:公有的 prepare 方法会默认会调用 prepare(true)

private static void prepare(boolean quitAllowed) {
    if (sThreadLocal.get() != null) {
        throw new RuntimeException(“Only one Looper may be created per thread”);
    }
    sThreadLocal.set(new Looper(quitAllowed));
}

Handler 现在能接收到消息并加入消息队列中,执行静态方法 Looper.loop() 方法会开始将消息从队列中出队。每次轮询迭代器指向下一条消息,接着分发消息到对应目标的 Handler,然后回收消息到消息池中。Looper.loop() 方法会循环执行这个过程,直到 Looper 终止。 Android 代码 中的如下片段展示了这个过程:

public static void loop() {
    if (me == null) {
        throw new RuntimeException("No Looper; Looper.prepare() wasn't called on this thread.");
    }
    final MessageQueue queue = me.mQueue;
    for (;;) {
        Message msg = queue.next(); // might block
        if (msg == null) {
            // No message indicates that the message queue is quitting.
            return;
        }
        msg.target.dispatchMessage(msg);
        msg.recycleUnchecked();
    }
}

并没有必要自己去创建关联 Looper 的线程。Android 提供了一个简便的类做这件事——HandlerThread。它继承 Thread 类,并且提供对 Looper 创建的管理。下面的代码描述了它的一般使用过程:

private final Handler handler;
private final HandlerThread handlerThread;
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate();
    handlerThread = new HandlerThread("HandlerDemo");
    handlerThread.start();
    handler = new CustomHandler(handlerThread.getLooper());
}
@Override
protected void onDestroy() {
    super.onDestroy();
    handlerThread.quit();
}

onCreate() 方法构造了一个 HandlerThread,当 HandlerThread 启动后,它准备创建 Looper 与它的线程关联,随后 Looper 开始处理 HandlerThread 的消息队列中的消息。

注意:当 Activity 被销毁时,结束 HandlerThread 是很重要的,这个动作也会终止关联的 Looper。

总结

Android 中的 Handler 在应用的生命周期中扮演着不可缺少的角色。它是构成半同步/半异步模式架构的基础。许多内部和外部的代码都依赖 Handler 去异步地分发事件,它能以最小的代价去维持线程安全。

更深入地理解组件的工作方式能够帮助解决疑难杂症。这也能让我们以最佳的方法使用组件的 API。我们通常将 Handler 作为工作线程和UI线程间的通信机制,但 Handler 并不仅限于此。它出现在 IntentService[6], 和 Camera2[7]和许多其它的 API 中。在这些 API 调用中,Handler 更多情形下是被用作任意线程间的通信工具。

在深入理解了 Handler 的原理后,我们能运用其构建更有效率、更简洁、更健壮的应用程序。