什么是handler?
熟悉Android开发的一定都知道Handler对于Android开发的重要性吧,Android主线程(UI线程)阻塞5s以上就会ANR,所以通常情况下耗时操作都是在子线程完成,当子线程完成耗时操作后,在通过Handler通知主线程去更新UI,最常见的使用场景就是在网络请求完成的时候,将网络请求的数据传给主线程,所以Handler的作用就是完成线程间通信。
最简单的线程间通信
我们想一下Android中Handler的使用步骤吧。
- 主线程中定义一个Handler,并覆写它的handlerMessage方法。
private Handler mHandler = new Handler() {
@Override
public void handleMessage(Message msg) {
super.handleMessage(msg);
//update UI
}
};
复制代码
- 在子线程耗时操作完成后创建一个message对象,并通过调用handler.sendMessage方法将这个message发送给主线程
new Thread(new Runnable() {
@Override
public void run() {
// do someting
Message message = Message.obtain();
mHandler.sendMessage(message);
}
}).start();
复制代码
Java程序中要实现线程间通信要如何做呢?
- 先定义一个Message对象,这里我们只在Message中定义一个字符串
public class Message {
public String msg;
}
复制代码
- 再定义一个IHandler接口
public interface IHandler {
void handleMessage(Message msg);
}
复制代码
- 下面我们写一段普通的java代码
public class Main {
public static void main(String[] args) {
IHandler handler = new IHandler() {
@Override
public void handleMessage(Message message) {
System.out.println("main thread receive a message: " + message.msg);
}
};
new SubThread(handler).start();
}
private static class SubThread extends Thread {
private IHandler mHandler;
public SubThread(IHandler handler) {
mHandler = handler;
}
@Override
public void run() {
super.run();
while (true) {
try {
Thread.sleep(1000);
Message message = new Message();
message.msg = "hello";
mHandler.handleMessage(message);
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
}
}
复制代码
运行结果:
main thread receive a message: hello
main thread receive a message: hello
main thread receive a message: hello
······
······
复制代码
这就是最简单的线程通信,通过接口回调将子线程中的Message传递给主线程去处理。Android中的Handler当然不是用这种方式实现的了,但是对于类与类之间的通信,接口回调是最简单最通用的方法了
下面我们参照Android中的方式实现一个Handler工具吧。Android的Handler在Java层包括了Handler,Looper,Message和MessageQueue四个类。其中Handler的主要作用是发送和处理消息,sendMessage会将新的Message加入到MessageQueue中。Looper是一个轮询器,检查MessageQueue中是否有Message,如果有Message就取出来分发给对应的Handler去处理。
- Message不用多做处理,只需要增加一个目标Handler就可以了
public class Message {
public Handler target;
public String msg;
}
复制代码
- MessageQueue是一个先进先出的队列,为了方便实现我们使用java提供的LinkedBlockingQueue来实现
public class MessageQueue {
private LinkedBlockingQueue<Message> messageList;
public MessageQueue() {
messageList = new LinkedBlockingQueue<>();
}
public void enqueueMessage(Message msg) {
messageList.add(msg);
}
public Message next() {
return messageList.poll();
}
}
复制代码
- Looper是和线程绑定的,一个线程里只能有一个Looper,所以Looper应该保存在ThreadLocal中。Looper的初始化应该放到Looper.prepare中去完成。
public class Looper {
private static ThreadLocal<Looper> sThreadLocal = new ThreadLocal<>();
final MessageQueue mQueue;
final Thread mThread;
public Looper() {
mQueue = new MessageQueue();
mThread = Thread.currentThread();
}
public static void prepare() {
if (sThreadLocal.get() != null) {
throw new RuntimeException("Only one Looper may be created per thread");
}
sThreadLocal.set(new Looper());
}
public static Looper myLooper() {
return sThreadLocal.get();
}
public static void loop() {
final Looper me = myLooper();
final MessageQueue queue = me.mQueue;
for (; ; ) {
Message msg = queue.next();
if (msg == null) {
continue;
}
msg.target.dispatchMessage(msg);
}
}
}
复制代码
- 最后看一下Handler的实现
public class Handler {
private Looper mLooper;
private MessageQueue mQueue;
public Handler() {
mLooper = Looper.myLooper();
mQueue = mLooper.mQueue;
}
public void sendMessage(Message msg) {
msg.target = this;
mQueue.enqueueMessage(msg);
}
public void dispatchMessage(Message msg) {
handleMessage(msg);
}
public void handleMessage(Message msg) {
}
}
复制代码
我们依然用之前例子里的代码来测试
public class Main {
public static void main(String[] args) {
Looper.prepare();
Handler handler = new Handler() {
@Override
public void handleMessage(Message message) {
super.handleMessage(message);
System.out.println("main thread receive a message: " + message.msg);
}
};
new SubThread(handler).start();
Looper.loop();
}
private static class SubThread extends Thread {
private Handler mHandler;
public SubThread(Handler handler) {
mHandler = handler;
}
@Override
public void run() {
super.run();
while (true) {
try {
Thread.sleep(1000);
Message message = new Message();
message.msg = "hello";
mHandler.handleMessage(message);
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
}
}
复制代码
输出结果
main thread receive a message: hello
main thread receive a message: hello
main thread receive a message: hello
······
······
复制代码
一个简单的Handler模拟程序就这样完成了。
深入分析
上面我们用几十行代码实现的那个玩具Handler只是为了让我们更好的理解Handler机制,Android实际中的Handler要复杂的多,更重要的是Android中Handler的实现不止包含了java代码,还包含了native调用
private native static long nativeInit();
private native static void nativeDestroy(long ptr);
private native void nativePollOnce(long ptr, int timeoutMillis); /*non-static for callbacks*/
private native static void nativeWake(long ptr);
private native static boolean nativeIsPolling(long ptr);
private native static void nativeSetFileDescriptorEvents(long ptr, int fd, int events);
复制代码
这几个native方法主要的作用是什么呢?在之前的Demo程序我们的loop方法实现是如果Message为空的时候就continue,这就造成了明明消息队列里没有消息,Looper依然在那里空转浪费cpu资源。native方法就是解决这个问题的。
MessageQueue的创建
这几个native方法都是在MessageQueue中定义,所以我们就先来研究一下MessageQueue创建。
构造方法
MessageQueue(boolean quitAllowed) {
mQuitAllowed = quitAllowed;
mPtr = nativeInit();
}
复制代码
mQuitAllowed表示这个消息队列能不能退出,除了主线程外,其他线程的消息队列都是可以退出的。
mPtr保存了native方法nativeInit()方法的返回值,这个值我们后面会用到,先看下nativeInit()做了什么吧。
nativeInit调用的是android_os_MessageQueue.cpp里面的方法
static jlong android_os_MessageQueue_nativeInit(JNIEnv* env, jclass clazz) {
NativeMessageQueue* nativeMessageQueue = new NativeMessageQueue();
if (!nativeMessageQueue) {
jniThrowRuntimeException(env, "Unable to allocate native queue");
return 0;
}
nativeMessageQueue->incStrong(env);
return reinterpret_cast<jlong>(nativeMessageQueue);
}
复制代码
从上面的代码我们知道,nativeInit创建了一个NativeMessageQueue对象,并将它的指针强转成了Java中的long类型保存在mPtr中,我们可以这样理解,MessageQueue.java中保存了一份NativeMessageQueue的指针,在需要的时候,mPtr可以传给native方法并转换成NativeMessageQueue对象。
NativeMessageQueue的构造方法
NativeMessageQueue::NativeMessageQueue() :
mPollEnv(NULL), mPollObj(NULL), mExceptionObj(NULL) {
mLooper = Looper::getForThread();
if (mLooper == NULL) {
mLooper = new Looper(false);
Looper::setForThread(mLooper);
}
}
复制代码
上面的代码的作用很简单,如果ThreadLocal中有Looper对象就返回。如果没有就new一个Looper对象,并将其保存在ThreadLocal中。
Looper.cpp的构造函数
Looper::Looper(bool allowNonCallbacks) :
mAllowNonCallbacks(allowNonCallbacks), mSendingMessage(false),
mPolling(false), mEpollFd(-1), mEpollRebuildRequired(false),
mNextRequestSeq(0), mResponseIndex(0), mNextMessageUptime(LLONG_MAX) {
mWakeEventFd = eventfd(0, EFD_NONBLOCK | EFD_CLOEXEC);
LOG_ALWAYS_FATAL_IF(mWakeEventFd < 0, "Could not make wake event fd: %s",
strerror(errno));
AutoMutex _l(mLock);
rebuildEpollLocked();
}
复制代码
上面的代码有一个关键的方法eventfd,这个具体的作用可参看Linux进程间通信-eventfd,简单讲的话这个就是linux进程间通信的一种方式,Linux内核空间维护了一个64位的计数器,可以一个进程调用write写入一个数,另一个进程调用read读出来。
最后一个函数
void Looper::rebuildEpollLocked() {
// Close old epoll instance if we have one.
if (mEpollFd >= 0) {
close(mEpollFd);
}
// Allocate the new epoll instance and register the wake pipe.
mEpollFd = epoll_create(EPOLL_SIZE_HINT);
LOG_ALWAYS_FATAL_IF(mEpollFd < 0, "Could not create epoll instance: %s", strerror(errno));
struct epoll_event eventItem;
memset(& eventItem, 0, sizeof(epoll_event)); // zero out unused members of data field union
eventItem.events = EPOLLIN;
eventItem.data.fd = mWakeEventFd;
int result = epoll_ctl(mEpollFd, EPOLL_CTL_ADD, mWakeEventFd, & eventItem);
LOG_ALWAYS_FATAL_IF(result != 0, "Could not add wake event fd to epoll instance: %s",
strerror(errno));
for (size_t i = 0; i < mRequests.size(); i++) {
const Request& request = mRequests.valueAt(i);
struct epoll_event eventItem;
request.initEventItem(&eventItem);
int epollResult = epoll_ctl(mEpollFd, EPOLL_CTL_ADD, request.fd, & eventItem);
if (epollResult < 0) {
ALOGE("Error adding epoll events for fd %d while rebuilding epoll set: %s",
request.fd, strerror(errno));
}
}
}
复制代码
这个里面也有两个关键的方法epoll_create和epoll_ctl,epoll的具体讲解可以看这个。简单说就是epoll可以监控很多个文件描述符,并注册想要监控的事件。mWakeEventFd是之前我们创建的那个eventfd的文件描述符,EPOLLIN表示写事件。所以
int result = epoll_ctl(mEpollFd, EPOLL_CTL_ADD, mWakeEventFd, & eventItem)
复制代码
这行代码的含义就是当eventfd有写入事件时触发。
sendMessage的流程
我们先来看一下Handler中sendMessage大致的时序图
- Handler调用自身的方法
public final boolean sendMessage(Message msg)
{
return sendMessageDelayed(msg, 0);
}
public final boolean sendMessageDelayed(Message msg, long delayMillis)
{
if (delayMillis < 0) {
delayMillis = 0;
}
return sendMessageAtTime(msg, SystemClock.uptimeMillis() + delayMillis);
}
public boolean sendMessageAtTime(Message msg, long uptimeMillis) {
MessageQueue queue = mQueue;
if (queue == null) {
RuntimeException e = new RuntimeException(
this + " sendMessageAtTime() called with no mQueue");
Log.w("Looper", e.getMessage(), e);
return false;
}
return enqueueMessage(queue, msg, uptimeMillis);
}
private boolean enqueueMessage(MessageQueue queue, Message msg, long uptimeMillis) {
msg.target = this;
if (mAsynchronous) {
msg.setAsynchronous(true);
}
return queue.enqueueMessage(msg, uptimeMillis);
}
复制代码
- MessageQueue调用enqueueMessage方法
boolean enqueueMessage(Message msg, long when) {
if (msg.target == null) {
throw new IllegalArgumentException("Message must have a target.");
}
if (msg.isInUse()) {
throw new IllegalStateException(msg + " This message is already in use.");
}
synchronized (this) {
if (mQuitting) {
IllegalStateException e = new IllegalStateException(
msg.target + " sending message to a Handler on a dead thread");
Log.w(TAG, e.getMessage(), e);
msg.recycle();
return false;
}
msg.markInUse();
msg.when = when;
Message p = mMessages;
boolean needWake;
if (p == null || when == 0 || when < p.when) {
// 第一个消息;需要唤醒Looper
msg.next = p;
mMessages = msg;
needWake = mBlocked;
} else {
// 按照时间排序找到合适的插入点,这种情况通常不需要唤醒Looper,但是如果同步分隔栏且是第一个异步消息就需要唤醒Looper
needWake = mBlocked && p.target == null && msg.isAsynchronous();
Message prev;
for (;;) {
prev = p;
p = p.next;
if (p == null || when < p.when) {
break;
}
if (needWake && p.isAsynchronous()) {
needWake = false;
}
}
msg.next = p; // invariant: p == prev.next
prev.next = msg;
}
// We can assume mPtr != 0 because mQuitting is false.
if (needWake) {
nativeWake(mPtr);
}
}
return true;
}
复制代码
上面代码是Message加入队列的过程,Message入队过程并不像我们Demo里写的那样先进先出的,而是按照执行时间进行排序,如果这个Message是队列里面的第一个Message,则需要唤醒Looper。我们假设我们发送的Message就是第一个,那么就会触发nativeWake方法,传入的参数就是我们在MessageQueue构造函数中保存的指针mPtr,这个指针指向NativeMessageQueue。
- android_os_MessageQueue.cpp中的android_os_MessageQueue_nativeWake
static void android_os_MessageQueue_nativeWake(JNIEnv* env, jclass clazz, jlong ptr) {
NativeMessageQueue* nativeMessageQueue = reinterpret_cast<NativeMessageQueue*>(ptr);
nativeMessageQueue->wake();
}
复制代码
- NativeMessageQueue调用wake方法
void NativeMessageQueue::wake() {
mLooper->wake();
}
复制代码
- Looper.cpp调用wake方法
void Looper::wake() {
#if DEBUG_POLL_AND_WAKE
ALOGD("%p ~ wake", this);
#endif
uint64_t inc = 1;
// 向eventfd中写入1
ssize_t nWrite = TEMP_FAILURE_RETRY(write(mWakeEventFd, &inc, sizeof(uint64_t)));
if (nWrite != sizeof(uint64_t)) {
if (errno != EAGAIN) {
LOG_ALWAYS_FATAL("Could not write wake signal to fd %d: %s",
mWakeEventFd, strerror(errno));
}
}
}
复制代码
mWakeEventFd就是在Looper的构造方法中创建的eventfd的文件描述符。上述代码的作用就是向eventfd中写入一个1。还记得Looper构造方法中的epoll吗?epoll正在监听eventfd的写事件,现在已经触发了。触发了什么事呢?我们接着往下分析。
handleMessage的流程
我们先来看一下Handler中handleMessage大致的时序图
- Looper中的loop
public static void loop() {
final Looper me = myLooper();
if (me == null) {
throw new RuntimeException("No Looper; Looper.prepare() wasn't called on this thread.");
}
final MessageQueue queue = me.mQueue;
Binder.clearCallingIdentity();
final long ident = Binder.clearCallingIdentity();
for (;;) {
//消息队列为空的时候会阻塞
Message msg = queue.next();
if (msg == null) {
// No message indicates that the message queue is quitting.
return;
}
// This must be in a local variable, in case a UI event sets the logger
final Printer logging = me.mLogging;
if (logging != null) {
logging.println(">>>>> Dispatching to " + msg.target + " " +
msg.callback + ": " + msg.what);
}
final long traceTag = me.mTraceTag;
if (traceTag != 0) {
Trace.traceBegin(traceTag, msg.target.getTraceName(msg));
}
try {
msg.target.dispatchMessage(msg);
} finally {
if (traceTag != 0) {
Trace.traceEnd(traceTag);
}
}
if (logging != null) {
logging.println("<<<<< Finished to " + msg.target + " " + msg.callback);
}
// Make sure that during the course of dispatching the
// identity of the thread wasn't corrupted.
final long newIdent = Binder.clearCallingIdentity();
if (ident != newIdent) {
Log.wtf(TAG, "Thread identity changed from 0x"
+ Long.toHexString(ident) + " to 0x"
+ Long.toHexString(newIdent) + " while dispatching to "
+ msg.target.getClass().getName() + " "
+ msg.callback + " what=" + msg.what);
}
msg.recycleUnchecked();
}
}
复制代码
无限循环取Message,取到Message后调用msg.target.dispatchMessage(msg)分发给对应的Handler处理,看着似乎跟我们Demo里是一样的,但关键点就在于
Message msg = queue.next();
复制代码
这个操作是会阻塞的,还记得Looper.cpp里面的wake有个唤醒操作吗?这个唤醒操作就是为了唤醒queue.next()的。
- MessageQueue的next方法
Message next() {
final long ptr = mPtr;
if (ptr == 0) {
return null;
}
int pendingIdleHandlerCount = -1; // -1 only during first iteration
int nextPollTimeoutMillis = 0;
for (;;) {
if (nextPollTimeoutMillis != 0) {
Binder.flushPendingCommands();
}
nativePollOnce(ptr, nextPollTimeoutMillis);
synchronized (this) {
// Try to retrieve the next message. Return if found.
final long now = SystemClock.uptimeMillis();
Message prevMsg = null;
Message msg = mMessages;
if (msg != null && msg.target == null) {
// Stalled by a barrier. Find the next asynchronous message in the queue.
do {
prevMsg = msg;
msg = msg.next;
} while (msg != null && !msg.isAsynchronous());
}
if (msg != null) {
if (now < msg.when) {
// Next message is not ready. Set a timeout to wake up when it is ready.
nextPollTimeoutMillis = (int) Math.min(msg.when - now, Integer.MAX_VALUE);
} else {
// Got a message.
mBlocked = false;
if (prevMsg != null) {
prevMsg.next = msg.next;
} else {
mMessages = msg.next;
}
msg.next = null;
if (DEBUG) Log.v(TAG, "Returning message: " + msg);
msg.markInUse();
return msg;
}
} else {
// No more messages.
nextPollTimeoutMillis = -1;
}
// Process the quit message now that all pending messages have been handled.
if (mQuitting) {
dispose();
return null;
}
if (pendingIdleHandlerCount < 0
&& (mMessages == null || now < mMessages.when)) {
pendingIdleHandlerCount = mIdleHandlers.size();
}
if (pendingIdleHandlerCount <= 0) {
// No idle handlers to run. Loop and wait some more.
mBlocked = true;
continue;
}
if (mPendingIdleHandlers == null) {
mPendingIdleHandlers = new IdleHandler[Math.max(pendingIdleHandlerCount, 4)];
}
mPendingIdleHandlers = mIdleHandlers.toArray(mPendingIdleHandlers);
}
// Run the idle handlers.
// We only ever reach this code block during the first iteration.
for (int i = 0; i < pendingIdleHandlerCount; i++) {
final IdleHandler idler = mPendingIdleHandlers[i];
mPendingIdleHandlers[i] = null; // release the reference to the handler
boolean keep = false;
try {
keep = idler.queueIdle();
} catch (Throwable t) {
Log.wtf(TAG, "IdleHandler threw exception", t);
}
if (!keep) {
synchronized (this) {
mIdleHandlers.remove(idler);
}
}
}
pendingIdleHandlerCount = 0;
nextPollTimeoutMillis = 0;
}
}
复制代码
当MessageQueue里面没有消息时nativePollOnce(ptr, nextPollTimeoutMillis)会阻塞
- android_os_MessageQueue.cpp中的nativePollOnce
static void android_os_MessageQueue_nativePollOnce(JNIEnv* env, jobject obj,
jlong ptr, jint timeoutMillis) {
NativeMessageQueue* nativeMessageQueue = reinterpret_cast<NativeMessageQueue*>(ptr);
nativeMessageQueue->pollOnce(env, obj, timeoutMillis);
}
复制代码
- NativeMessageQueue中的pollOnce方法
void NativeMessageQueue::pollOnce(JNIEnv* env, jobject pollObj, int timeoutMillis) {
mPollEnv = env;
mPollObj = pollObj;
mLooper->pollOnce(timeoutMillis);
mPollObj = NULL;
mPollEnv = NULL;
if (mExceptionObj) {
env->Throw(mExceptionObj);
env->DeleteLocalRef(mExceptionObj);
mExceptionObj = NULL;
}
}
复制代码
- Looper.cpp中的pollOnce方法
int Looper::pollOnce(int timeoutMillis, int* outFd, int* outEvents, void** outData) {
int result = 0;
for (;;) {
while (mResponseIndex < mResponses.size()) {
const Response& response = mResponses.itemAt(mResponseIndex++);
int ident = response.request.ident;
if (ident >= 0) {
int fd = response.request.fd;
int events = response.events;
void* data = response.request.data;
if (outFd != NULL) *outFd = fd;
if (outEvents != NULL) *outEvents = events;
if (outData != NULL) *outData = data;
return ident;
}
}
if (result != 0) {
if (outFd != NULL) *outFd = 0;
if (outEvents != NULL) *outEvents = 0;
if (outData != NULL) *outData = NULL;
return result;
}
result = pollInner(timeoutMillis);
}
}
复制代码
- Looper.cpp中的pollInner方法
int Looper::pollInner(int timeoutMillis) {
// Poll.
int result = POLL_WAKE;
mResponses.clear();
mResponseIndex = 0;
// We are about to idle.
mPolling = true;
struct epoll_event eventItems[EPOLL_MAX_EVENTS];
// 等待eventfd中的写事件触发
int eventCount = epoll_wait(mEpollFd, eventItems, EPOLL_MAX_EVENTS, timeoutMillis);
for (int i = 0; i < eventCount; i++) {
int fd = eventItems[i].data.fd;
uint32_t epollEvents = eventItems[i].events;
if (fd == mWakeEventFd) {
if (epollEvents & EPOLLIN) {
awoken();
} else {
ALOGW("Ignoring unexpected epoll events 0x%x on wake event fd.", epollEvents);
}
}
}
return result;
}
复制代码
pollInner中代码很长,我删去了一些不相关的代码,主要就是这行代码
struct epoll_event eventItems[EPOLL_MAX_EVENTS];
int eventCount = epoll_wait(mEpollFd, eventItems, EPOLL_MAX_EVENTS, timeoutMillis);
复制代码
epoll_wait会一直等待eventfd中的写事件触发,如果没有就会阻塞。
- 最后的awoken
void Looper::awoken() {
uint64_t counter;
TEMP_FAILURE_RETRY(read(mWakeEventFd, &counter, sizeof(uint64_t)));
}
复制代码
读取eventfd中保存的数据,read操作后eventfd会置0,重新陷入阻塞
总结
- Looper调用prepare方法创建MessageQueue
- MessageQueue创建的时候同时调用jni方法创建了eventfd和epoll,epoll监听eventfd上的写事件。
- Looper调用loop方法进入循环。
- 执行到nativePollOnce时,由于eventfd计数器的值为0陷入阻塞。
- Handler调用sendMessage发送消息。
- message加入到MessageQueue,同时执行nativeWake方法向eventfd写入一个数字1。
- nativePollOnce阻塞解除,分发Message给对应的Handler。
- 读取eventfd中的数据,eventfd置0。nativePollOnce继续阻塞。