Handler 机制 源码+图+常见问题+Demo 详细记录(本文内容略长,但内容较为详细,推荐Android开发者可深入观看.如有问题,欢迎指正)
android的消息处理有三个核心类:Looper,Handler和Message。还有一个MessageQueue(消息队列,以下简称MQ),但是MQ被封装到Looper里面。
首先从ActivityThread类的Main函数开始:
1public static void main(String[] args) {
2 ......//篇幅问题,内容已删减
3 Looper.prepareMainLooper();
4
5 // Find the value for {@link #PROC_START_SEQ_IDENT} if provided on the command line.
6 // It will be in the format "seq=114"
7 long startSeq = 0;
8 if (args != null) {
9 for (int i = args.length - 1; i >= 0; --i) {
10 if (args[i] != null && args[i].startsWith(PROC_START_SEQ_IDENT)) {
11 startSeq = Long.parseLong(
12 args[i].substring(PROC_START_SEQ_IDENT.length()));
13 }
14 }
15 }
16 ActivityThread thread = new ActivityThread();
17 thread.attach(false, startSeq);
18 if (sMainThreadHandler == null) {
19 sMainThreadHandler = thread.getHandler();
20 }
21 ......//篇幅问题,内容已删减
22 // End of event ActivityThreadMain.
23 Looper.loop();
24
25 throw new RuntimeException("Main thread loop unexpectedly exited");
26 }
ActivityThread main函数中的第三行 Looper.prepareMainLooper();这里看下源码内容:
1/**
2 * Initialize the current thread as a looper, marking it as an
3 * application's main looper. The main looper for your application
4 * is created by the Android environment, so you should never need
5 * to call this function yourself. See also: {@link #prepare()}
6 */
7public static void prepareMainLooper() {
8 prepare(false);//调用该方法在ThreadLocal中创建Looper对象
9 synchronized (Looper.class) {
10 if (sMainLooper != null) {
11 throw new IllegalStateException("The main Looper has already been prepared.");
12 }
13 sMainLooper = myLooper();
14 }
如上代码内容调用了prepare(false);方法.这里我们分析下handler机制中Looper的作用。
01
一. Looper
Looper的字面意思是“循环者”,它被设计用来使一个普通线程变成Looper线程。所谓Looper线程就是循环工作的线程。在程序开发中(尤其是GUI开发中),我们经常会需要一个线程不断循环,一旦有新任务则执行,执行完继续等待下一个任务,这就是Looper线程。使用Looper类创建Looper线程很简单:
1public class LooperThread extends Thread {
2 @Override
3 public void run() {
4 // 将当前线程初始化为Looper线程
5 Looper.prepare();
6
7 // ...其他处理,如实例化handler
8
9 // 开始循环处理消息队列
10 Looper.loop();
11 }
12}
以上类似在ActivityThread中的使用.prepareMainLooper()中也是调用的 Looper.prepare();通过上面两行核心代码,你的线程就升级为Looper线程了!!!是不是很神奇?让我们放慢镜头,看看这两行代码各自做了什么。
1)Looper.prepare()
通过下图可以看到,现在你的线程中有一个Looper对象,它的内部维护了一个消息队列MQ。注意,一个Thread只能有一个Looper对象
1public class Looper {
2 // 每个线程中的Looper对象其实是一个ThreadLocal,即线程本地存储(ThreadLocal)对象
3 private static final ThreadLocal sThreadLocal = new ThreadLocal();
4 // Looper内的消息队列
5 final MessageQueue mQueue;
6 // 当前线程
7 Thread mThread;
8 // 。。。其他属性
9
10 // 每个Looper对象中有它的消息队列,和它所属的线程
11 private Looper() {
12 mQueue = new MessageQueue();
13 mRun = true;
14 mThread = Thread.currentThread();
15 }
16
17 // 我们调用该方法会在调用线程的ThreadLocal中创建Looper对象
18 public static void prepare() {
19 prepare(true);
20 }
21
22 private static void prepare(boolean quitAllowed) {
23 if (sThreadLocal.get() != null) {
24 throw new RuntimeException("Only one Looper may be created per thread");
25 }
26 sThreadLocal.set(new Looper(quitAllowed));
27 }
28 //ThreadActivity中使用,初始化UI线程为Looper线程
29 public static void prepareMainLooper() {
30 prepare(false);
31 synchronized (Looper.class) {
32 if (sMainLooper != null) {
33 throw new IllegalStateException("The main Looper has already been prepared.");
34 }
35 sMainLooper = myLooper();
36 }
37 }
38 // 其他方法
39}
如果你还不清楚什么是ThreadLocal,请参考《多线程之ThreadLocal简析》
2)Looper.loop()
ActivityThread中也调用了Looper.loop() 1)中我们初始化先成为Looper线程.使用looper.loop()后looper线程就真的开始工作了。它不断从自己的MQ中取出队头的消息(也叫任务)执行
1public static final void loop() {
2 Looper me = myLooper(); //得到当前线程Looper
3 MessageQueue queue = me.mQueue; //得到当前looper的MQ
4
5 // 清除远程Binder调用端uid和pid信息,并保存到ident变量
6 Binder.clearCallingIdentity();
7 final long ident = Binder.clearCallingIdentity();
8 // 开始循环
9 while (true) {
10 Message msg = queue.next(); // 取出message
11 if (msg != null) {
12 if (msg.target == null) {
13 // message没有target为结束信号,退出循环
14 return;
15 }
16 // 日志。。。
17 if (me.mLogging!= null) me.mLogging.println(
18 ">>>>> Dispatching to " + msg.target + " "
19 + msg.callback + ": " + msg.what
20 );
21 // 非常重要!将真正的处理工作交给message的target,即后面要讲的handler
22 msg.target.dispatchMessage(msg);
23 // 还是日志。。。
24 if (me.mLogging!= null) me.mLogging.println(
25 "<<<<< Finished to " + msg.target + " "
26 + msg.callback);
27
28 //清除远程Binder调用端uid和pid信息,并保存到newIdent变量
29 final long newIdent = Binder.clearCallingIdentity();
30 if (ident != newIdent) {
31 Log.wtf("Looper", "Thread identity changed from 0x"
32 + Long.toHexString(ident) + " to 0x"
33 + Long.toHexString(newIdent) + " while dispatching to "
34 + msg.target.getClass().getName() + " "
35 + msg.callback + " what=" + msg.what);
36 }
37 // 回收message资源
38 msg.recycle();
39 }
40 }
41 }
这里我们看到,mLooper()方法里我们取出了当前线程的looper对象,然后从looper对象开启了一个死循环
不断地从looper内的MessageQueue中取出Message,只要有Message对象,就会通过Message的target调用
dispatchMessage去分发消息,通过代码可以看出target就是我们创建的handler。Message的分发调用dispatchMessage(msg)方法,接下分析Handler中我们会提到。
除了prepare()和loop()方法,Looper类还提供了一些有用的方法
1//Looper.myLooper()得到当前线程looper对象
2public static final Looper myLooper() {
3 // 在任意线程调用Looper.myLooper()返回的都是那个线程的looper
4 return (Looper)sThreadLocal.get();
5 }
6//getThread()得到looper对象所属线程
7public Thread getThread() {
8 return mThread;
9 }
10//quit()方法结束looper循环
11public void quit() {
12 // 创建一个空的message,它的target为NULL,表示结束循环消息
13 Message msg = Message.obtain();
14 // 发出消息
15 mQueue.enqueueMessage(msg, 0);
16 }
上述的注释写的很清楚,
Looper总结:
大家可能注意到Looper.loop()方法中第22行msg.target.dispatchMessage(msg);上文中的注释提到是用于消息分发,处理Message。如何向往MQ上添加消息和处理消息是Handler的职责。下面介绍异步大师handler
02
二. Handler
什么是handler?简单来说:handler扮演了往MQ上添加消息和处理消息的角色(只处理由自己发出的消息),即通知MQ它要执行一个任务(sendMessage),并在loop到自己的时候执行该任务(handleMessage),整个过程是异步的。handler创建时会关联一个looper,默认的构造方法将关联当前线程的looper,不过这也是可以set的。构造方法如下:
1public class handler {
2
3 final MessageQueue mQueue; // 关联的MQ
4 final Looper mLooper; // 关联的looper
5 final Callback mCallback;
6 // 其他属性
7
8 public Handler() {
9 this(null, false);
10 }
11 public Handler(Callback callback) {
12 this(callback, false);
13 }
14
15 public Handler(Looper looper) {
16 this(looper, null, false);
17 }
18
19 public Handler(Looper looper, Callback callback) {
20 this(looper, callback, false);
21 }
22 /**
23 * Use the {@link Looper} for the current thread with the specified callback interface
24 * and set whether the handler should be asynchronous.
25 *
26 * Handlers are synchronous by default unless this constructor is used to make
27 * one that is strictly asynchronous.
28 *
29 * Asynchronous messages represent interrupts or events that do not require global ordering
30 * with respect to synchronous messages. Asynchronous messages are not subject to
31 * the synchronization barriers introduced by {@link MessageQueue#enqueueSyncBarrier(long)}.
32 *
33 * @param callback The callback interface in which to handle messages, or null.
34 * @param async If true, the handler calls {@link Message#setAsynchronous(boolean)} for
35 * each {@link Message} that is sent to it or {@link Runnable} that is posted to it.
36 *
37 * @hide
38 */
39 public Handler(Callback callback, boolean async) {
40 if (FIND_POTENTIAL_LEAKS) {
41 final Class<? extends Handler> klass = getClass();
42 if ((klass.isAnonymousClass() || klass.isMemberClass() || klass.isLocalClass()) &&
43 (klass.getModifiers() & Modifier.STATIC) == 0) {
44 Log.w(TAG, "The following Handler class should be static or leaks might occur: " +
45 klass.getCanonicalName());
46 }
47 }
48 // 默认将关联当前线程的looper
49 mLooper = Looper.myLooper();
50 // looper不能为空,即该默认的构造方法只能在looper线程中使用
51 if (mLooper == null) {
52 throw new RuntimeException(
53 "Can't create handler inside thread " + Thread.currentThread()
54 + " that has not called Looper.prepare()");
55 }
56 // 重要!!!直接把关联looper的MQ作为自己的MQ,因此它的消息将发送到关联looper的MQ上
57 mQueue = mLooper.mQueue;
58 mCallback = callback;
59 mAsynchronous = async;
60 }
61 /**
62 * Use the provided {@link Looper} instead of the default one and take a callback
63 * interface in which to handle messages. Also set whether the handler
64 * should be asynchronous.
65 *
66 * Handlers are synchronous by default unless this constructor is used to make
67 * one that is strictly asynchronous.
68 *
69 * Asynchronous messages represent interrupts or events that do not require global ordering
70 * with respect to synchronous messages. Asynchronous messages are not subject to
71 * the synchronization barriers introduced by conditions such as display vsync.
72 *
73 * @param looper The looper, must not be null.
74 * @param callback The callback interface in which to handle messages, or null.
75 * @param async If true, the handler calls {@link Message#setAsynchronous(boolean)} for
76 * each {@link Message} that is sent to it or {@link Runnable} that is posted to it.
77 *
78 * @hide
79 */
80 public Handler(Looper looper, Callback callback, boolean async) {
81 mLooper = looper;
82 mQueue = looper.mQueue;
83 mCallback = callback;
84 mAsynchronous = async;
85 }
86}
Handler提供了多种构造方法,默认的构造方法中Looper默认关联当前线程,把关联Looper的MQ作为自己的MQ。三个参数的构造方法中需要传入Looper对象,Callback接口(这里简要提下)
1 /**
2 * Callback interface you can use when instantiating a Handler to avoid
3 * having to implement your own subclass of Handler.
4 */
5 //意思大概就是使用这个接口可以避免自己去写一个Handler的子类
6 public interface Callback {
7 /**
8 * @param msg A {@link android.os.Message Message} object
9 * @return True if no further handling is desired
10 */
11 public boolean handleMessage(Message msg);
12 }
在使用Handler时如果直接使用匿名内部类的方式创建Handler对象ide会发出警告,提示内存泄漏风险。这时可以通过创建继承Handler的静态内部类或使用弱引用来避免Handler对象持有外部类对象的强引用。但是官方还提供了一个Handler.Callback接口。
注意:handler会持有匿名对象的引用,匿名对象会持有外部类对象的引用,虽然ide不再警告但是内存泄漏问题并没有解决。所以要在onDestroy方法中调用handler.removeCallbacksAndMessages(null); 来清空消息。或者用弱引用,如下所示,具体使用可见Demo:
1 Handler handler = new Handler(new WeakReference<Handler.Callback>(new Handler.Callback() {
2 @Override
3 public boolean handleMessage(Message msg) {
4 return false;
5 }
6 }).get());
接下来继续Handler,我们把一)中的Looper线程加入Handler
1public class LooperThread extends Thread {
2 private Handler handler1;
3 private Handler handler2;
4
5 @Override
6 public void run() {
7 // 将当前线程初始化为Looper线程
8 Looper.prepare();
9
10 // 实例化两个handler
11 handler1 = new Handler();
12 handler2 = new Handler();
13
14 // 开始循环处理消息队列
15 Looper.loop();
16 }
17}
加入handler后的效果如下图:
可以看到,一个线程可以有多个Handler,但是只能有一个Looper(ThreadLocal对象)!
Handler发送消息
有了handler之后,我们就可以使用 post(Runnable)
, postAtTime(Runnable, long)
,postDelayed(Runnable,long)
, sendEmptyMessage(int)
, sendMessage(Message)
,sendMessageAtTime(Message,long)
和sendMessageDelayed(Message, long)
这些方法向MQ上发送消息了。光看这些API你可能会觉得handler能发两种消息,一种是Runnable对象,一种是message对象,这是直观的理解,但其实post发出的Runnable对象最后都被封装成message对象了,见源码:
1// 此方法用于向关联的MQ上发送Runnable对象,它的run方法将在handler关联的looper线程中执行
2 public final boolean post(Runnable r)
3 {
4 // 注意getPostMessage(r)将runnable封装成message
5 return sendMessageDelayed(getPostMessage(r), 0);
6 }
7
8 private final Message getPostMessage(Runnable r) {
9 Message m = Message.obtain(); //得到空的message
10 m.callback = r; //将runnable设为message的callback,
11 return m;
12 }
13
14 public boolean sendMessageAtTime(Message msg, long uptimeMillis)
15 {
16 boolean sent = false;
17 MessageQueue queue = mQueue;
18 if (queue != null) {
19 msg.target = this; // message的target必须设为该handler!
20 sent = queue.enqueueMessage(msg, uptimeMillis);
21 }
22 else {
23 RuntimeException e = new RuntimeException(
24 this + " sendMessageAtTime() called with no mQueue");
25 Log.w("Looper", e.getMessage(), e);
26 }
27 return sent;
28 }
其他方法就不罗列了,总之通过handler发出的message有如下特点:
1.message.target为该handler对象,这确保了looper执行到该message时能找到处理它的handler,即loop()方法中的关键代码,即上文中提到的Message分发:
1msg.target.dispatchMessage(msg);
2.post发出的message,其callback为Runnable对象
Handler处理消息
说完了消息的发送,再来看下handler如何处理消息。消息的处理是通过核心方法dispatchMessage(Message msg)与钩子方法handleMessage(Message msg)完成的,见源码:
1// 处理消息,该方法由looper调用
2 public void dispatchMessage(Message msg) {
3 if (msg.callback != null) {
4 // 如果message设置了callback,即runnable消息,处理callback!
5 handleCallback(msg);
6 } else {
7 // 如果handler本身设置了callback,则执行callback
8 if (mCallback != null) {
9 /* 这种方法允许让activity等来实现Handler.Callback接口,避免了自己编写handler重写handleMessage方法。见http://alex-yang-xiansoftware-com.iteye.com/blog/850865 */
10 if (mCallback.handleMessage(msg)) {
11 return;
12 }
13 }
14 // 如果message没有callback,则调用handler的钩子方法handleMessage
15 handleMessage(msg);
16 }
17 }
18
19 // 处理runnable消息
20 private final void handleCallback(Message message) {
21 message.callback.run(); //直接调用run方法!
22 }
23 // 由子类实现的钩子方法
24 public void handleMessage(Message msg) {
25 }
dispatchMessage(Message msg)方法为Public提供给Looper进行消息传递,这里一般情况下不需要重写,目前也没见到过重写场景,如有,请指教...
可以看到,除了handleMessage(Message msg)和Runnable对象的run方法由开发者实现外(实现具体逻辑),handler的内部工作机制对开发者是透明的。这正是handler API设计的精妙之处!
Handler的用处
Android异步任务处理大师Handler拥有下面两个重要的特点:
1. handler可以在任意线程发送消息,这些消息会被添加到关联的MQ上。
2. handler是在它关联的looper线程中处理消息的。
这就解决了android最经典的不能在其他非主线程中更新UI的问题。android的主线程也是一个looper线程(looper在android中运用很广),我们在其中创建的handler默认将关联主线程MQ。因此,利用handler的一个solution就是在activity中创建handler并将其引用传递给worker thread,worker thread执行完任务后使用handler发送消息通知activity更新UI。(过程如图)
具体Demo及Handler使用方法请移步:github(同性交友社区):
https://github.com/AnyMarvel/HandlerDemo
WorkDemo Activity工作内容如下:
1public class HandlerWorkDemo extends AppCompatActivity {
2 TextView textView;
3
4 @Override
5 protected void onCreate(@Nullable Bundle savedInstanceState) {
6 super.onCreate(savedInstanceState);
7 setContentView(R.layout.handler_work);
8 textView = findViewById(R.id.workText);
9 // 创建并启动工作线程
10 Thread workerThread = new Thread(new SampleTask(new MyHandler()));
11 workerThread.start();
12 }
13
14 public void appendText(String msg) {
15 textView.setText(textView.getText() + "\n" + msg);
16 }
17 //内部类,实现MyHandler
18 class MyHandler extends Handler {
19
20 @Override
21 public void handleMessage(Message msg) {
22 super.handleMessage(msg);
23 String result = msg.getData().getString("message");
24 // 更新UI
25 appendText(result);
26
27 }
28 }
29
30 private class SampleTask implements Runnable {
31 private Handler handler;
32
33 public SampleTask(MyHandler myHandler) {
34 this.handler = myHandler;
35 }
36
37 @Override
38 public void run() {
39 try { // 模拟执行某项任务,下载等
40 Thread.sleep(5000);
41 // 任务完成后通知activity更新UI
42 Message msg = prepareMessage("task completed!");
43 // message将被添加到主线程的MQ中
44 handler.sendMessage(msg);
45 } catch (InterruptedException e) {
46 Log.d("SampleTask", "interrupted!");
47 }
48
49 }
50
51 private Message prepareMessage(String str) {
52 Message result = handler.obtainMessage();
53 Bundle data = new Bundle();
54 data.putString("message", str);
55 result.setData(data);
56 return result;
57 }
58 }
59}
当然,handler能做的远远不仅如此,由于它能post Runnable对象,它还能与Looper配合实现经典的Pipeline Thread(流水线线程)模式。Handler作为Android异步任务大师,还有一些比较经典的用法,这里不再一一赘述,有遇到handler坑的欢迎留言
03
三 .Message
对于稍有经验的开发人员来说我们在使用Handler发送异步消息获取Message的时候都会使用如下代码获取一个Message对象:
1Message msg = mHandler.obtainMessage();
而不是直接new一个:
1Message msg = new Message();
二者的主要区别就是上面的用到缓存池概念,如果池中有闲着的则拿来用,没有则new一个Message。后者则没有这个机制,直接new一个拿来用。
接下来我们分析一下这个缓存池是怎么实现的。
Message缓存池源码分析
Handler中obtainMessage()方法实质还是调用的Message中obtain()方法,这里就直接看Message中obtain()方法源码了:
1 //锁对象,只读不写,final修饰
2 public static final Object sPoolSync = new Object();
3 private static Message sPool;
4 private static int sPoolSize = 0;
5
6 private static final int MAX_POOL_SIZE = 50;
7
8 private static boolean gCheckRecycle = true;
9
10 /**
11 * Return a new Message instance from the global pool. Allows us to
12 * avoid allocating new objects in many cases.
13 */
14 public static Message obtain() {
15 synchronized (sPoolSync) {
16 //判断sPool是否为空,为空则New Message对象,不为空则获取缓存中的Message对象
17 if (sPool != null) {
18 //单链表的结构,将sPool指向当前Message,Message的next指向下一个Message。
19 Message m = sPool;
20 sPool = m.next;
21 m.next = null;
22 m.flags = 0; // clear in-use flag
23 sPoolSize--;
24 return m;
25 }
26 }
27 return new Message();
28 }
代码很简单,给sPoolSync加锁后,判断sPool是否为null,不为null则将sPool引用指向一个新的Message,并将新的Message的next的引用指向sPool,随即将next置空,标记重置,sPoolSize--,返回一个Message;如果sPool为null的话,直接new出一个Message。
obtain()主要逻辑就是先判断缓存池中是否存在空闲message,如果存在则返回头部message,并且指针指向下一个空闲message,然后头部的message与之后链表 断开连接。如果不存在空闲message则直接new一个直接返回。
上面的逻辑都是从缓存池中获取的操作,那什么时候向缓存池中存放呢?我们继续向下分析。
Message类中recycle()方法是用于回收用完的mesage,将此message会收到缓存池中,是这样的吗?我们看下源码就知道了:
1 public void recycle() {
2 if (isInUse()) {
3 if (gCheckRecycle) {
4 throw new IllegalStateException("This message cannot be recycled because it "
5 + "is still in use.");
6 }
7 return;
8 }
9 recycleUnchecked();
10 }
recycle方法中主要判断当前message是否正在使用中,如果正在使用则抛出异常,没被使用则调用recycleUnchecked()方法,接下来看下recycleUnchecked():
1/**
2 * Recycles a Message that may be in-use.
3 * Used internally by the MessageQueue and Looper when disposing of queued Messages.
4 */
5 void recycleUnchecked() {
6 // Mark the message as in use while it remains in the recycled object pool.
7 // Clear out all other details.
8 flags = FLAG_IN_USE;
9 what = 0;
10 arg1 = 0;
11 arg2 = 0;
12 obj = null;
13 replyTo = null;
14 sendingUid = -1;
15 when = 0;
16 target = null;
17 callback = null;
18 data = null;
19
20 synchronized (sPoolSync) {
21 if (sPoolSize < MAX_POOL_SIZE) {
22 next = sPool;
23 sPool = this;
24 sPoolSize++;
25 }
26 }
27 }
判断当前缓存池sPoolSize是否小于设定的最大缓冲池大小,如果小于这个值,则将sPool指向下一个Message,当前Message指向sPool,sPoolSize++,相当于回收了这个使用过的Message。
message的用法比较简单,这里不做总结了,但需要注意以下几点:
恭喜看到这里,完事了
总结:
一. Android Handler使用流程
以上步骤看着很是简单,但还是出现了各种问题
二. 注意事项总结
(完)以上是对Android Handler机制的总结,(Handler使用过程中容易造成内容溢出的问题这里没有做说明,demo中有解决方法,详情见demo,持续更新handler触发问题)
具体Demo及Handler使用方法请移步:github(同性交友社区):
https://github.com/AnyMarvel/HandlerDemo