handler是一个Android SDK 提供给开发者方便进行异步消息处理的类,下面从handler类最常用的函数sendMessage讲起。sendMessage接受的参数是Message,调用到sendMessageDelayed,sendMessageDelayed的第二个参数delayMillis是0,表示立刻发送出去。如果需要延迟发送消息,使用参数delayMillis是不为0的函数sendMessageDelayed即可。
/frameworks/base/core/java/android/os/Handler.java
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);
}
来插一段关于handler的构造函数和同步异步消息的内容,直接使用new handler()的话,会调用到下面这一段。其中callback参数为null(当然也可以使用new handler(Callback)使callback参数不为null,用法后面再介绍),async为false,表示由该handler发出的消息同步的。一方面,可以修改handler的参数async为true使得该handler发出的消息都是异步的;另一方面,可以通过Message类的setAsynchronous函数设置一个消息是异步的。后面将提到同步消息和异步消息的作用。
/frameworks/base/core/java/android/os/Handler.java
public Handler(Callback callback, boolean async) {
if (FIND_POTENTIAL_LEAKS) {
//handler需要定义成静态内部类,否则会发生内存泄漏
final Class<? extends Handler> klass = getClass();
if ((klass.isAnonymousClass() || klass.isMemberClass() || klass.isLocalClass()) &&
(klass.getModifiers() & Modifier.STATIC) == 0) {
Log.w(TAG, "The following Handler class should be static or leaks might occur: " +
klass.getCanonicalName());
}
}
//Looper是一个线程专有的循环处理消息队列的类
mLooper = Looper.myLooper();
if (mLooper == null) {
throw new RuntimeException(
"Can't create handler inside thread that has not called Looper.prepare()");
}
//每个Looper关联一个MessageQueue,用来存储消息Message
mQueue = mLooper.mQueue;
mCallback = callback;
mAsynchronous = async;
}
/frameworks/base/core/java/android/os/Handler.java
private boolean enqueueMessage(MessageQueue queue, Message msg, long uptimeMillis) {
msg.target = this;
if (mAsynchronous) {
//设置成异步消息
msg.setAsynchronous(true);
}
return queue.enqueueMessage(msg, uptimeMillis);
}
enqueueMessage的when入参表示该消息应该被发送出去的时间点。mMessages记录了MessageQueue中第一个消息。实际上,所有的消息会组成一个按时间戳从早到晚排列单向链表,只是在插入元素时按时间戳来确定插入位置,处理消息的时候都是先对这个链表的第一个元素进行处理,因为这个消息的时间戳是最早的,使得这个链表的性质类似于先进先出的队列。
needWake是用来唤醒阻塞在MessageQueue类的函数next的线程的。在两种情况下,needWake为true,表示需要唤醒阻塞线程:1.Looper无事可做的时候拿到了被认为可以处理的消息。这个无事,是指没有空闲处理元素IdleHandler且消息队列没有可以处理的消息或者消息队列的消息还没到发送时间的时候,这时候,有消息过来了,要么消息队列不为空了,要么新来的消息时间戳比消息队列头的还要早,这就需要看下是否真正进行处理了。2.队列头是一个barrier且新来的消息是时间戳最早的异步消息且Looper无事可做的时候。异步消息不会受到barrier的影响,但为什么要是最早的才唤醒呢?因为这时候线程可能是出于等待时间到达或者阻塞状态,只有直接更新消息队列头的操作才能叫醒它:“嘿,看看但新来的那个,时间符不符合你要求,符合要求就拿走吧。什么?你没消息处理了??那直接拿走吧!”。后面将提到barrier的概念。
/frameworks/base/core/java/android/os/MessageQueue.java
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("MessageQueue", e.getMessage(), e);
msg.recycle();
return false;
}
msg.markInUse();
msg.when = when;
Message p = mMessages;
boolean needWake;
//消息队列为空或者时间戳为0或者时间戳早于消息队列第一个元素
if (p == null || when == 0 || when < p.when) {
// New head, wake up the event queue if blocked.
//插入消息到队列头,使mMessages指向队列头
msg.next = p;
mMessages = msg;
//后面会提到,mBlocked在Looper尚不能处理消息且空闲处理元素IdleHandler个数为0的时候为true
needWake = mBlocked;
} else {//按时间戳从早到晚的顺序安插消息到合适的位置
// Inserted within the middle of the queue. Usually we don't have to wake
// up the event queue unless there is a barrier at the head of the queue
// and the message is the earliest asynchronous message in the queue.
//p.target == null的情况在调用enqueueSyncBarrier安插barrier的情况会发生
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;
}
Looper堆消息队列的处理如下:通过MessageQueue#next()取得要处理的消息,交给handler,进而调用dispatchMessage分派消息。重点看看MessageQueue#next()。
/frameworks/base/core/java/android/os/Looper.java
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;
// Make sure the identity of this thread is that of the local process,
// and keep track of what that identity token actually is.
Binder.clearCallingIdentity();
final long ident = Binder.clearCallingIdentity();
for (;;) {
Message msg = queue.next(); // might block
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
Printer logging = me.mLogging;
if (logging != null) {
logging.println(">>>>> Dispatching to " + msg.target + " " +
msg.callback + ": " + msg.what);
}
msg.target.dispatchMessage(msg);
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();
}
}
nativePollOnce的第一个参数表示native层对应的MessageQueue指针,第二个参数表示等待时间,和epoll_wait的时间参数用法相同,0表示立刻返回,-1表示阻塞到有等待的事件发生,正数表示等待多长时间后返回。
Looper每次都是先对消息队列的第一个元素进行处理。如果是一个barrier,将会跳过后面的所有同步消息(即isAsynchronous返回false的Message),直到遍历完消息队列或者拿到一个异步消息。当然,在没有barrier的情况下,所有的同步消息和异步消息都是被同等地对待的。如果拿到了一个消息(可能是同步也可能是异步,取决于是否有barrier),如果当前时间还没到发送时间,则将nextPollTimeoutMillis设置为当前时间与发送时间的差值,下次调用nativePollOnce会等待这个差值的时间(前提是没有空闲处理元素)。如果当前时间已经到达发送时间,则将这个消息从队列中摘除返回。如果遍历消息队列没有消息可用(可能是空队列或者barrier后面全为同步消息),则将nextPollTimeoutMillis设置成-1,下次调用nativePollOnce会阻塞到有等待的事件发生(前提是没有空闲处理元素)。在消息队列为空或者头消息时间戳还没到达时,Looper会进行空闲事件处理。mIdleHandlers记录了这些空闲处理元素。空闲事件处理就是对这些空闲处理元素分别调用其实现的queueIdle()。若mIdleHandlers为空,重新执行循环,这时候可能会引发阻塞。若mIdleHandlers不为空,分别处理完这些些空闲处理元素后,将nextPollTimeoutMillis恢复为0,因为处理空闲元素时可能有可用消息过来了,没必要根据nextPollTimeoutMillis来阻塞线程,设置成0检查有没有可用消息过来了直接返回。
/frameworks/base/core/java/android/os/MessageQueue.java
Message next() {
// Return here if the message loop has already quit and been disposed.
// This can happen if the application tries to restart a looper after quit
// which is not supported.
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;
//队列头为barrier的情况。
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 (false) Log.v("MessageQueue", "Returning message: " + msg);
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 first time idle, then get the number of idlers to run.
// Idle handles only run if the queue is empty or if the first message
// in the queue (possibly a barrier) is due to be handled in the future.
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("MessageQueue", "IdleHandler threw exception", t);
}
if (!keep) {
synchronized (this) {
mIdleHandlers.remove(idler);
}
}
}
// Reset the idle handler count to 0 so we do not run them again.
pendingIdleHandlerCount = 0;
// While calling an idle handler, a new message could have been delivered
// so go back and look again for a pending message without waiting.
nextPollTimeoutMillis = 0;
}
}
由上面可以了解到,barrier是用来阻塞后面的同步消息的。安装barrier是通过enqueueSyncBarrier进行的。mNextBarrierToken记录了下一个可用的barrier编号。值得注意的是,通过Message.obtain()得到的Message关联的handler为null(即成员target为null)。所以,在消息队列中的消息target为null的都可视作是barrier。barrier也是一个消息,也按照时间戳的先后顺序放入到消息队列中,但是它的存在会使后面的同步消息在MessageQueue#next()时被忽略。
/frameworks/base/core/java/android/os/MessageQueue.java
int enqueueSyncBarrier(long when) {
// Enqueue a new sync barrier token.
// We don't need to wake the queue because the purpose of a barrier is to stall it.
synchronized (this) {
final int token = mNextBarrierToken++;
final Message msg = Message.obtain();
msg.markInUse();
msg.when = when;
msg.arg1 = token;
Message prev = null;
Message p = mMessages;
if (when != 0) {
while (p != null && p.when <= when) {
prev = p;
p = p.next;
}
}
if (prev != null) { // invariant: p == prev.next
msg.next = p;
prev.next = msg;
} else {
msg.next = p;
mMessages = msg;
}
return token;
}
}
移除barrier的函数是removeSyncBarrier。若移除的barrier在消息队列中间,直接移除即可。若移除的barrier在消息队列头部,mMessages设置为barrier的下一个消息,若这时mMessages为空或者mMessages不是barrier,则唤醒阻塞在MessageQueue#next()的线程,告诉线程没事干啦,可以执行下空闲处理了!或者告诉线程有活干了,可以处理消息了。如果mMessages是barrier,则不需要唤醒线程,毕竟一个barrier和两个连续的barrier的效果是相同的,等着新消息来再唤醒吧!
barrier的一个主要用法是让一个handler在一个时间段内只能处理异步消息。默认情况下,消息都是同步的,我们可以使用setAsynchronous将我们要处理的消息设置成异步。加入barrier后,就只能处理后面的异步消息了。当处理完异步消息后,使用removeSyncBarrier摘除这个barrier,又可以处理同步消息了。
/frameworks/base/core/java/android/os/MessageQueue.java
void removeSyncBarrier(int token) {
// Remove a sync barrier token from the queue.
// If the queue is no longer stalled by a barrier then wake it.
synchronized (this) {
Message prev = null;
Message p = mMessages;
while (p != null && (p.target != null || p.arg1 != token)) {
prev = p;
p = p.next;
}
if (p == null) {
throw new IllegalStateException("The specified message queue synchronization "
+ " barrier token has not been posted or has already been removed.");
}
final boolean needWake;
if (prev != null) {
prev.next = p.next;
needWake = false;
} else {
mMessages = p.next;
needWake = mMessages == null || mMessages.target != null;
}
p.recycleUnchecked();
// If the loop is quitting then it is already awake.
// We can assume mPtr != 0 when mQuitting is false.
if (needWake && !mQuitting) {
nativeWake(mPtr);
}
}
}
接下来看看MessageQueue#next()怎么阻塞在nativePollOnce的。Java层的Looper在native层也对应一个C++的Looper。接下来调用Looper::pollOnce。
/frameworks/base/core/jni/android_os_MessageQueue.cpp
static void android_os_MessageQueue_nativePollOnce(JNIEnv* env, jclass clazz,
jlong ptr, jint timeoutMillis) {
NativeMessageQueue* nativeMessageQueue = reinterpret_cast<NativeMessageQueue*>(ptr);
nativeMessageQueue->pollOnce(env, timeoutMillis);
}
void NativeMessageQueue::pollOnce(JNIEnv* env, int timeoutMillis) {
mInCallback = true;
mLooper->pollOnce(timeoutMillis);
mInCallback = false;
if (mExceptionObj) {
env->Throw(mExceptionObj);
env->DeleteLocalRef(mExceptionObj);
mExceptionObj = NULL;
}
}
这里插入一段关于Looper::addFd用法的介绍。addFd用于向Looper申请监听来自文件描述符fd的events事件,ident是表示符,当ident为POLL_CALLBACK(-2)时,表示监听到事件是会回调callback参数的回调函数,data参数为携带的额外数据。Request结构体是对上述信息的封装。
mRequests的mRequests记录了这些Request的集合。当要监听的fd已被包含在mRequests的时候,变成修改对应的Request的监听事件;否则,添加新的Request到mRequests中。
/system/core/libutils/Looper.cpp
int Looper::addFd(int fd, int ident, int events, const sp<LooperCallback>& callback, void* data) {
#if DEBUG_CALLBACKS
ALOGD("%p ~ addFd - fd=%d, ident=%d, events=0x%x, callback=%p, data=%p", this, fd, ident,
events, callback.get(), data);
#endif
if (!callback.get()) {
if (! mAllowNonCallbacks) {
ALOGE("Invalid attempt to set NULL callback but not allowed for this looper.");
return -1;
}
if (ident < 0) {
ALOGE("Invalid attempt to set NULL callback with ident < 0.");
return -1;
}
} else {
ident = POLL_CALLBACK;
}
int epollEvents = 0;
if (events & EVENT_INPUT) epollEvents |= EPOLLIN;
if (events & EVENT_OUTPUT) epollEvents |= EPOLLOUT;
{ // acquire lock
AutoMutex _l(mLock);
Request request;
request.fd = fd;
request.ident = ident;
request.callback = callback;
request.data = data;
struct epoll_event eventItem;
memset(& eventItem, 0, sizeof(epoll_event)); // zero out unused members of data field union
eventItem.events = epollEvents;
eventItem.data.fd = fd;
ssize_t requestIndex = mRequests.indexOfKey(fd);
if (requestIndex < 0) {
int epollResult = epoll_ctl(mEpollFd, EPOLL_CTL_ADD, fd, & eventItem);
if (epollResult < 0) {
ALOGE("Error adding epoll events for fd %d, errno=%d", fd, errno);
return -1;
}
mRequests.add(fd, request);
} else {
int epollResult = epoll_ctl(mEpollFd, EPOLL_CTL_MOD, fd, & eventItem);
if (epollResult < 0) {
ALOGE("Error modifying epoll events for fd %d, errno=%d", fd, errno);
return -1;
}
mRequests.replaceValueAt(requestIndex, request);
}
} // release lock
return 1;
}
在epoll_wait返回的时间数量eventCount大于0是,若时间发生的fd不是读端管道(后面会提到),那就是添加进去的fd发生了监听事件。于是生成一个Response,Response记录了这个fd发生的时间和对应的Request,添加到mResponses中。mResponses保存了所有监听请求和监听结果(除了管道)的信息。
当addFd的入参callback不为空时,Request的ident被设置为POLL_CALLBACK。在生成新的Response后,会检查mResponses每一个Response对应的Request是否带有callback。有的话,调用callback的handleEvent函数,然后清除这个callback。
/system/core/libutils/Looper.cpp
int Looper::pollInner(int timeoutMillis) {
...
for (int i = 0; i < eventCount; i++) {
int fd = eventItems[i].data.fd;
uint32_t epollEvents = eventItems[i].events;
if (fd == mWakeReadPipeFd) {
if (epollEvents & EPOLLIN) {
awoken();
} else {
ALOGW("Ignoring unexpected epoll events 0x%x on wake read pipe.", epollEvents);
}
} else {
ssize_t requestIndex = mRequests.indexOfKey(fd);
if (requestIndex >= 0) {
int events = 0;
if (epollEvents & EPOLLIN) events |= EVENT_INPUT;
if (epollEvents & EPOLLOUT) events |= EVENT_OUTPUT;
if (epollEvents & EPOLLERR) events |= EVENT_ERROR;
if (epollEvents & EPOLLHUP) events |= EVENT_HANGUP;
pushResponse(events, mRequests.valueAt(requestIndex));
} else {
ALOGW("Ignoring unexpected epoll events 0x%x on fd %d that is "
"no longer registered.", epollEvents, fd);
}
}
}
...
// Invoke all response callbacks.
for (size_t i = 0; i < mResponses.size(); i++) {
Response& response = mResponses.editItemAt(i);
if (response.request.ident == POLL_CALLBACK) {
int fd = response.request.fd;
int events = response.events;
void* data = response.request.data;
#if DEBUG_POLL_AND_WAKE || DEBUG_CALLBACKS
ALOGD("%p ~ pollOnce - invoking fd event callback %p: fd=%d, events=0x%x, data=%p",
this, response.request.callback.get(), fd, events, data);
#endif
int callbackResult = response.request.callback->handleEvent(fd, events, data);
if (callbackResult == 0) {
removeFd(fd);
}
// Clear the callback reference in the response structure promptly because we
// will not clear the response vector itself until the next poll.
response.request.callback.clear();
result = POLL_CALLBACK;
}
}
return result;
}
void Looper::pushResponse(int events, const Request& request) {
Response response;
response.events = events;
response.request = request;
mResponses.push(response);
}
回头看看Looper::pollOnce。如果有新生成的Response,则在while循环里,会先将每一个新生成的Response的相关信息输出到入参outFd,outEvents,outData中(在这些入参都不为null的情况下)。如果没有新生成的Response,则返回pollInner的结果。
/system/core/libutils/Looper.cpp
int Looper::pollOnce(int timeoutMillis, int* outFd, int* outEvents, void** outData) {
int result = 0;
for (;;) {
//每次进入一次for循环,mResponseIndex置为0,mResponses为pollInner生成的新的Response集合。
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 DEBUG_POLL_AND_WAKE
ALOGD("%p ~ pollOnce - returning signalled identifier %d: "
"fd=%d, events=0x%x, data=%p",
this, ident, fd, events, data);
#endif
if (outFd != NULL) *outFd = fd;
if (outEvents != NULL) *outEvents = events;
if (outData != NULL) *outData = data;
return ident;
}
}
if (result != 0) {
#if DEBUG_POLL_AND_WAKE
ALOGD("%p ~ pollOnce - returning result %d", this, result);
#endif
if (outFd != NULL) *outFd = 0;
if (outEvents != NULL) *outEvents = 0;
if (outData != NULL) *outData = NULL;
return result;
}
result = pollInner(timeoutMillis);
}
}
阻塞操作可能发生在epoll_wait中,阻塞的时间取决于Java传下来的timeoutMillis参数。epoll监听的文件描述符有管道读端和通过addFd添加的fd,Java层的nativeWake就是通过往管道写端写入内容来唤醒阻塞在epoll_wait的线程的。
/system/core/libutils/Looper.cpp
int result = POLL_WAKE;
mResponses.clear();
mResponseIndex = 0;
// We are about to idle.
mIdling = true;
struct epoll_event eventItems[EPOLL_MAX_EVENTS];
int eventCount = epoll_wait(mEpollFd, eventItems, EPOLL_MAX_EVENTS, timeoutMillis);
// No longer idling.
mIdling = false;
// Acquire lock.
mLock.lock();
// Check for poll error.
if (eventCount < 0) {
if (errno == EINTR) {
goto Done;
}
ALOGW("Poll failed with an unexpected error, errno=%d", errno);
result = POLL_ERROR;
goto Done;
}
// Check for poll timeout.
if (eventCount == 0) {
#if DEBUG_POLL_AND_WAKE
ALOGD("%p ~ pollOnce - timeout", this);
#endif
result = POLL_TIMEOUT;
goto Done;
}
// Handle all events.
#if DEBUG_POLL_AND_WAKE
ALOGD("%p ~ pollOnce - handling events from %d fds", this, eventCount);
#endif
for (int i = 0; i < eventCount; i++) {
int fd = eventItems[i].data.fd;
uint32_t epollEvents = eventItems[i].events;
if (fd == mWakeReadPipeFd) {
if (epollEvents & EPOLLIN) {
awoken();
} else {
ALOGW("Ignoring unexpected epoll events 0x%x on wake read pipe.", epollEvents);
}
}