AsyncTask与HandlerThread源码分析
在Android中我们会经常遇到异步任务的使用需求,因此Android也提供了一些用于异步任务的支持。AsyncTask和HandlerThread就是Android提供的轻量级的异步类,它能让我们更方便的执行异步任务。
AsyncTask
AsyncTask是一个抽象的泛型类,它是Handler与线程池的结合,通过AsyncTask,我们能很方便的在子线程中访问UI线程。我们就从AsyncTask的execute方法开始分析:
public final AsyncTask<Params, Progress, Result> execute(Params... params) {
return executeOnExecutor(sDefaultExecutor, params);
}
public final AsyncTask<Params, Progress, Result> executeOnExecutor(Executor exec,
Params... params) {
if (mStatus != Status.PENDING) {
switch (mStatus) {
case RUNNING:
throw new IllegalStateException("Cannot execute task:"
+ " the task is already running.");
case FINISHED:
throw new IllegalStateException("Cannot execute task:"
+ " the task has already been executed "
+ "(a task can be executed only once)");
}
}
mStatus = Status.RUNNING;
onPreExecute();
mWorker.mParams = params;
exec.execute(mFuture);
return this;
}
execute方法简单的调用了executeOnExecutor,并将输入的参数以及sDefaultExecutor传给executeOnExecutor方法。executeOnExecutor方法首先判断mStatus,如果该AsyncTask不是初始的PENDING状态,那么将抛出异常,因此execute方法只能被调用一次。然后直接执行onPreExecute方法,通过这里可以知道onPreExecute方法将在调用execute方法的线程里执行。之后再将参数包装到mWorker中,并在sDefaultExecutor线程池中执行mFuture。下面我们看一下mWorker、mFuture和sDefaultExecutor:
public AsyncTask() {
mWorker = new WorkerRunnable<Params, Result>() {
public Result call() throws Exception {
mTaskInvoked.set(true);
Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND);
//noinspection unchecked
Result result = doInBackground(mParams);
Binder.flushPendingCommands();
return postResult(result);
}
};
mFuture = new FutureTask<Result>(mWorker) {
@Override
protected void done() {
try {
postResultIfNotInvoked(get());
} catch (InterruptedException e) {
android.util.Log.w(LOG_TAG, e);
} catch (ExecutionException e) {
throw new RuntimeException("An error occurred while executing doInBackground()",
e.getCause());
} catch (CancellationException e) {
postResultIfNotInvoked(null);
}
}
};
}
private static abstract class WorkerRunnable<Params, Result> implements
Callable<Result> {
Params[] mParams;
}
//在FutureTask中的run方法
public void run() {
if (state != NEW ||
!U.compareAndSwapObject(this, RUNNER, null, Thread.currentThread()))
return;
try {
Callable<V> c = callable;
if (c != null && state == NEW) {
V result;
boolean ran;
try {
result = c.call();
ran = true;
} catch (Throwable ex) {
result = null;
ran = false;
setException(ex);
}
if (ran)
set(result);
}
} finally {
// runner must be non-null until state is settled to
// prevent concurrent calls to run()
runner = null;
// state must be re-read after nulling runner to prevent
// leaked interrupts
int s = state;
if (s >= INTERRUPTING)
handlePossibleCancellationInterrupt(s);
}
}
可以看到,mWorker和mFuture都是在AsyncTask的构造方法中被初始化,mWorker是一个WorkerRunnable对象,WorkerRunnable是一个Callable的抽象子类,也仅仅在Callable接口中添加了Params[]数据域。然后使用该mWorker作为参数来创建mFuture对象,mFuture是一个FutureTask,在FutureTask的run方法中会调mWorker的call方法。再看一下mWorker的call方法,发现doInBackGround方法就是在mWorker的call方法中被调用的,这样,doInBackGround方法就被放到了执行mFuture的线程中执行了,也即由sDefaultExecutor线程池来执行。下面看一下sDefaultExecutor:
public static final Executor SERIAL_EXECUTOR = new SerialExecutor();
private static volatile Executor sDefaultExecutor = SERIAL_EXECUTOR;
private static class SerialExecutor implements Executor {
final ArrayDeque<Runnable> mTasks = new ArrayDeque<Runnable>();
Runnable mActive;
public synchronized void execute(final Runnable r) {
mTasks.offer(new Runnable() {
public void run() {
try {
r.run();
} finally {
scheduleNext();
}
}
});
if (mActive == null) {
scheduleNext();
}
}
protected synchronized void scheduleNext() {
if ((mActive = mTasks.poll()) != null) {
THREAD_POOL_EXECUTOR.execute(mActive);
}
}
}
public static final Executor THREAD_POOL_EXECUTOR;
static {
ThreadPoolExecutor threadPoolExecutor = new ThreadPoolExecutor(
CORE_POOL_SIZE, MAXIMUM_POOL_SIZE, KEEP_ALIVE_SECONDS, TimeUnit.SECONDS,
sPoolWorkQueue, sThreadFactory);
threadPoolExecutor.allowCoreThreadTimeOut(true);
THREAD_POOL_EXECUTOR = threadPoolExecutor;
}
sDefaultExecutor是一个SerialExecutor对象,但是SerialExecutor的execute方法并没有直接执行参数Runnable的run方法, 而是将Runnable的run方法和scheduleNext方法包装成一个新的Runnable,并将新的Runnable插入到mTasks中(mTask是一个ArrayDeque,用来存储待执行的Runnable),然后执行scheduleNext方法。而在scheduleNext方法中,会从mTasks中取出一个Runnable,然后将其在THREAD_POOL_EXECUTOR线程池中执行。
这样,当我们调用execute方法时,会入队一个Runnable,然后调用sceduleNext方法执行该Runnable,执行该Runnable时又会再调用sceduleNext方法, 直到mTasks队列中没有Runnable。这样,我们可以发现AsyncTask默认的工作方式为串行执行(较早的版本可能会并行执行)。
现在我们可以知道,AsyncTask中使用了两个线程池,sDefaultExecutor线程池(SerialExecutor对象)仅仅用来进行任务排队,而THREAD_POOL_EXECUTOR(ThreadPoolExecutor对象)用来真正的执行任务。
总的来说,当我们创建一个AsyncTask对象并调用execute方法时,会发生如下过程:
- 创建mWorker(mWorker的call方法会执行doInBackGround方法),并使用mWork创建FutureTask对象mFuture;
- 判断mState,如果mState != PENDING,则抛出异常;
- 执行onPreExecute,未使用线程池,因此onPreExecute方法在调用execute的线程中执行;
- 将参数包装到mWorker中,并调用sDefaultExecutor.execute(mFuture);
- sDefaultExecutor.execute(mFuture)方法将mFuture包装成一个新的Runnable(也即在之前Runnable的run方法之后添加scheduleNext方法),并插入到mTasks队列中;
- 然后sDefaultExecutor.execute(mFuture)方法会调用scheduleNext方法(初始mActive == null,因此执行execute时调用scheduleNext);
- scheduleNext方法中会从mTasks队列中取出一个Runnable并在THREAD_POOL_EXECUTOR线程池中执行,由于该Runnable内封装了scheduleNext方法,因此执行该Runnable时又会调用scheduleNext方法,直到mTasks队列为空。
现在,我们对AsyncTask有了进一步了解,但是,说好的Handler呢?onPostExecute呢?还有onProgressUpdate呢?它们在哪个被调用?执行在哪个线程呢?
首先看一下我们如何使用AsyncTask的示例(摘自文档):
private class DownloadFilesTask extends AsyncTask<URL, Integer, Long> {
protected Long doInBackground(URL... urls) {
int count = urls.length;
long totalSize = 0;
for (int i = 0; i < count; i++) {
totalSize += Downloader.downloadFile(urls[i]);
publishProgress((int) ((i / (float) count) * 100));
// Escape early if cancel() is called
if (isCancelled()) break;
}
return totalSize;
}
protected void onProgressUpdate(Integer... progress) {
setProgressPercent(progress[0]);
}
protected void onPostExecute(Long result) {
showDialog("Downloaded " + result + " bytes");
}
}
可以看到,我们可以在doInBackGround方法中,根据任务实际完成情况来调用publishProgress方法来更新进度,并实现onProgressUpdate方法来相应进度更新。我们看一下publishProgress方法:
protected final void publishProgress(Progress... values) {
if (!isCancelled()) {
getHandler().obtainMessage(MESSAGE_POST_PROGRESS,
new AsyncTaskResult<Progress>(this, values)).sendToTarget();
}
}
private static Handler getHandler() {
synchronized (AsyncTask.class) {
if (sHandler == null) {
sHandler = new InternalHandler();
}
return sHandler;
}
}
可以看到publishProgress方法只是简单的将values包装到Message的obj中,然后将该Message发送给一个实现类为InternalHandler的Handler,也即更新进度的任务交给了Handler。
在前面可以看到,mWorker的call方法中执行完doInBackground之后会执行postResult来传递doInbackGround返回的结果,并且mFuture的done方法中也会判断该任务是否被调用过,否则(也即如果mWork中没用执行postResult)也会执行postResult方法,现在看一下postResult方法:
private Result postResult(Result result) {
@SuppressWarnings("unchecked")
Message message = getHandler().obtainMessage(MESSAGE_POST_RESULT,
new AsyncTaskResult<Result>(this, result));
message.sendToTarget();
return result;
}
postResult也是简单的将result包装到Message中,然后将Message发送给Handler。
也就是说,onProgressUpdate以及onPostExecute的执行都与getHandler返回的Handler有关,我们看一下getHandler方法:
private static Handler getHandler() {
synchronized (AsyncTask.class) {
if (sHandler == null) {
sHandler = new InternalHandler();
}
return sHandler;
}
}
private static class InternalHandler extends Handler {
public InternalHandler() {
super(Looper.getMainLooper());
}
@SuppressWarnings({"unchecked", "RawUseOfParameterizedType"})
@Override
public void handleMessage(Message msg) {
AsyncTaskResult<?> result = (AsyncTaskResult<?>) msg.obj;
switch (msg.what) {
case MESSAGE_POST_RESULT:
// There is only one result
result.mTask.finish(result.mData[0]);
break;
case MESSAGE_POST_PROGRESS:
result.mTask.onProgressUpdate(result.mData);
break;
}
}
}
private void finish(Result result) {
if (isCancelled()) {
onCancelled(result);
} else {
onPostExecute(result);
}
mStatus = Status.FINISHED;
}
getHandler方法返回的是一个InternalHandler对象,InternalHandler是Handler的子类,它实现为AsyncTask的内部类,在InternalHandler的handleMessage方法中,我们可以看到,前面发送的publishProgress方法以及postResult方法发送的Message都在此处处理,他们分别对应了onProgressUpdate方法,和finish方法,而finish方法中又会根据执行情况选择执行onCancelled或者onPostExecute方法。
现在我们找到了onProgressUpdate方法和onPostExecute方法实际执行的位置,但是它们在哪个线程环境执行呢?由InternalHandler的构造方法可以看出,该Handler是通过Looper.getMainLooper()构造的,也即Message会被发送到主线程的Looper中,因此,onProgressUpdate方法和onPostExecute方法的执行环境也就被切换到了主线程中。
下面我们看一段代码:
new Thread(new Runnable(){
public void run(){
new AsyncTask<Integer, Integer, Integer>(){
@Override
protected Integer doInBackground(Integer... params) {
publishProgress(10);
Log.e("AsyncTask", "doInBackground: \t" + Thread.currentThread());
return 0;
}
@Override
protected void onPreExecute() {
Log.e("AsyncTask", "onPreExecute: \t" + Thread.currentThread());
super.onPreExecute();
}
@Override
protected void onPostExecute(Integer integer) {
Log.e("AsyncTask", "onPostExecute: \t" + Thread.currentThread());
super.onPostExecute(integer);
}
@Override
protected void onProgressUpdate(Integer... values) {
Log.e("AsyncTask", "onProgressUpdate: \t" + Thread.currentThread());
super.onProgressUpdate(values);
}
}.execute(1);
Log.e("AsyncTask", "Thread: \t\t" + Thread.currentThread());
}
}).start();
Log.e("AsyncTask", "onCreate: \t\t" + Thread.currentThread());
在Activity的onCreate中(也即UI线程中)执行上述代码,我们会看到下面的输出:
![屏幕快照 2017-02-22 下午9.34.08](/Users/iyl2uw/Desktop/屏幕快照 2017-02-22 下午9.34.08.png)
HandlerThread
跟AsyncTask相比,HandlerThread就显得简单多了。HandlerThread是Thread的子类,并且实现了run方法。简单的说,HandlerThread就是一个具有Looper的Thread,可以在HandlerThread中使用Handler。首先看一下HandlerThread的使用:
HandlerThread handlerThread = new HandlerThread("ThreadName");
handlerThread.start();
Looper looper = handlerThread.getLooper();
Handler handler = new Handler(looper){
@Override
public void handleMessage(Message msg) {
//handler message
}
};
handler.sendMessage(handler.obtainMessage());
首先我们构建一个HandlerThread对象,然后调用其start方法,此时会调用HandlerThread的run方法,之后我们再通过HandlerThread中getLooper返回的Looper对象来构建一个Handler,然后,我们就可以通过这个Handler将任务切换到HandlerThread执行了。
下面,我们看一下HandlerThread中的run方法:
public void run() {
mTid = Process.myTid();
Looper.prepare();
synchronized (this) {
mLooper = Looper.myLooper();
notifyAll();
}
Process.setThreadPriority(mPriority);
onLooperPrepared();
Looper.loop();
mTid = -1;
}
run方法中初始化了该线程中的Looper,并调用onLooperPrepared方法(该方法实现为空,可以在子类中覆盖该方法),然后调用Looper.loop()开启消息循环。
而getLooper方法中会阻塞等待线程开启,并且Looper被初始化,之后返回该线程关联的Looper对象。
public Looper getLooper() {
if (!isAlive()) {
return null;
}
// If the thread has been started, wait until the looper has been created.
synchronized (this) {
while (isAlive() && mLooper == null) {
try {
wait();
} catch (InterruptedException e) {
}
}
}
return mLooper;
}
这样,HandlerThread的原理就很清晰了,也即:
- 通过start方法启动run方法,在run方法中初始化Looper对象,并开启消息循环;
- 通过getLooper获得该线程的Looper对象,并使用该Looper创建Handler;
- 通过Handler将任务切换到该线程内部执行。
关于Handler、Looper以及MessageQueue可以看这里。