当我们通过线程去执行耗时的任务,并且子执行完之后更新UI时,通常我们采用Handler进行处理,但是如果有很多个任务同时执行时则会显得代码臃肿。Android为我们提供了AsyncTask,它使得异步任务实现起来更加简单,代码更简洁。
public abstract class AsyncTask<Params, Progress, Result> {
...
}
AsyncTask是一个抽象的泛型类,它有三个参数Params、Progress、Result。
- Params:为参数类型;
- Progress:后台任务执行进度的类型;
- Result:执行任务返回的结果的类型,如果不需要返回参数,可以将其设置Void类型;
AsyncTask的核心方法
- onPreExecute():一般在任务前做准备工作,在主线程中执行;
- doInBackground(Params… params):用来执行耗时操作,在AsyncTask内的线程池中执行,在执行的时候调用publishProgress(Progress… values)方法进行更新任务进度信息;
- onProgressUpdate(Progress… values):用于更新任务执行的进度,在主线程中执行,将publishProgress(Progress… values)发送的进度信息,在这里进行处理;
- onPostExecute(Result result):任务执行完毕,返回doInBackground方法得到的结果,一般用来任务执行完成,进行收尾工作,在主线程中执行;
AsyncTask源码分析
AsyncTask在Android3.0版本之前和3.0及以后版本有着较大的改动,本篇文章主要基于Android10版本进行的分析,Android3.0之前的主要区分点只做简单的归纳。
Android 3.0版本之前的AsyncTask
首先AsyncTask里面有一个ThreadPollExecutor,它的核心线程数为5个,线程池允许创建的最大线程数为128,线程存活时间为1s,采用容量为10的阻塞队列是LinkedBlockingQueue。Android 3.0版本之前有一个缺点,就是线程池最大的线程数为128,加上阻塞队列的10个任务,所以AsyncTask最多能同时容纳138个任务,当提交第139个任务是就会执行饱和策略。
Android 10.0版本的AsyncTask
首先我们先从AsyncTask的构造方法入手,代码如下所示:
public AsyncTask(@Nullable Looper callbackLooper) {
mHandler = callbackLooper == null || callbackLooper == Looper.getMainLooper()
? getMainHandler()
: new Handler(callbackLooper);
mWorker = new WorkerRunnable<Params, Result>() {
public Result call() throws Exception {
mTaskInvoked.set(true);
Result result = null;
try {
Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND);
//noinspection unchecked
result = doInBackground(mParams);
Binder.flushPendingCommands();
} catch (Throwable tr) {
mCancelled.set(true);
throw tr;
} finally {
postResult(result);
}
return 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);
}
}
};
}
从上面代码中可以看出,在创建AsyncTask的时候,同时初始化了mHandler、mWorker、mFuture三个成员变量。mHandler我们知道用于线程之间的消息处理,对于Handler原理不熟悉的可以参考《Handler的原理深度解析》,这里如何处理后面在做详细的说明。WorkerRunnable实现了Callable接口,并实现了call方法,在call方法中调用doInBackground(mParams)方法来处理任务并得到结果,最终调用postResult(result)将结果传递出去。FutureTask是一个可管理的异步任务,它实现RunnableFuture接口,而RunnableFuture继承了Runnable, Future两个接口,从FutureTask的构造方法可以看出,它可以封装了Runnable、Callable,并提供给Executor执行。在这里WorkerRunnable作为参数mWorker传递给了FutureTask。稍后将具体介绍用到的地方。
当执行AsyncTask的时候,需要调用它的execute方法,代码如下:
public final AsyncTask<Params, Progress, Result> execute(Params... params) {
return executeOnExecutor(sDefaultExecutor, params);
}
execute方法又调用了executeOnExecutor方法,代码如下:
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();
//注释1
mWorker.mParams = params;
exec.execute(mFuture);
return this;
}
这里发现首先判断当前任务的状态,如果是执行中或者执行结束就抛出异常。在这里发现我们熟悉的onPreExecute方法(由于executeOnExecutor方法必须在UI线程中执行,所以onPreExecute方法一定在UI线程中执行),此时任务还没有开始执行,所以onPreExecute方法可以做一些准备工作,比如更新UI设置loading等。
上面的代码注释1将AsyncTask的参数传递给WorkerRunnable,接下来调用exec的execute方法,将mFuture(也就是FutureTask)作为参数传进去,这里的exec也就是sDefaultExecutor,它是一个串行的线程池SerialExecutor,其代码如下:
private static class SerialExecutor implements Executor {
final ArrayDeque<Runnable> mTasks = new ArrayDeque<Runnable>();
Runnable mActive;
public synchronized void execute(final Runnable r) {
//注释2
mTasks.offer(new Runnable() {
public void run() {
try {
//注释3
r.run();
} finally {
scheduleNext();
}
}
});
if (mActive == null) {
scheduleNext();
}
}
protected synchronized void scheduleNext() {
if ((mActive = mTasks.poll()) != null) {
THREAD_POOL_EXECUTOR.execute(mActive);
}
}
}
从上面代码注释2,可以发现调用SerialExecutor的execute方法时,会创建一个Runnable添加到mTasks队列末尾,当任务执行完或者没有任务时都会执行scheduleNext()方法,它会从mTasks中取出第一个Runnable任务,并交由THREAD_POOL_EXECUTOR处理。从这里可以看出SerialExecutor是串行执行的。通过下面源码可知,THREAD_POOL_EXECUTOR是一个线程池(对线程池不熟悉可以参考《线程池的原理》)。根据线程池的原理可知,最终会走到执行注释3,执行FutureTask的run方法。
public static final Executor THREAD_POOL_EXECUTOR;
static {
ThreadPoolExecutor threadPoolExecutor = new ThreadPoolExecutor(
CORE_POOL_SIZE, MAXIMUM_POOL_SIZE, KEEP_ALIVE_SECONDS, TimeUnit.SECONDS,
new SynchronousQueue<Runnable>(), sThreadFactory);
threadPoolExecutor.setRejectedExecutionHandler(sRunOnSerialPolicy);
THREAD_POOL_EXECUTOR = threadPoolExecutor;
}
现在分析FutureTask的run方法,代码如下所示:
public void run() {
if (state != NEW ||
!U.compareAndSwapObject(this, RUNNER, null, Thread.currentThread()))
return;
try {
//注释4
Callable<V> c = callable;
if (c != null && state == NEW) {
V result;
boolean ran;
try {
//注释5
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);
}
}
从上面注解4可知,获取FutureTask中的callable,从FutureTask构造方法可以,这个callable就是传入的WorkerRunnable,通过注释5发现最终走到WorkerRunnable中的call方法中。前面我们提到call方法最终会调用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方法中会创建Message,通过getHandler()获得Handler,并通过Handler发送消息。此Handler即为AsyncTask构造函数初始化的mHandler,这里面mHandler通过getMainHandler()或者new Handler(callbackLooper)。
- 我们先看一下new Handler这种情况,通过AsyncTask的另一个构造函数可知,它是交给传入的Handler进行处理,这种情况需要我们自己去实现具体的逻辑。
public AsyncTask(@Nullable Handler handler) {
this(handler != null ? handler.getLooper() : null);
}
- 我们主要看一下getMainHandler()这种情况,getMainHandler方法的代码如下所示:
private static Handler getMainHandler() {
synchronized (AsyncTask.class) {
if (sHandler == null) {
sHandler = new InternalHandler(Looper.getMainLooper());
}
return sHandler;
}
}
在getMainHandler方法中创建了InternalHandler,InternalHandler的代码如下:
private static class InternalHandler extends Handler {
public InternalHandler(Looper looper) {
super(looper);
}
@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;
}
}
}
在接受到postResult方法发送的 MESSAGE_POST_RESULT 消息后会调用AsyncTask的finish方法,代码如下所示:
private void finish(Result result) {
if (isCancelled()) {
onCancelled(result);
} else {
onPostExecute(result);
}
mStatus = Status.FINISHED;
}
如果AsyncTask任务被取消了,则执行onCancelled方法,否则调用onPostExecute方法,这样我们才能够得到一部任务执行的结果。
之前我们讲过在doInBackground方法中,调用publishProgress方法,可以更新任务信息。publishProgress方法的代码如下所示:
protected final void publishProgress(Progress... values) {
if (!isCancelled()) {
getHandler().obtainMessage(MESSAGE_POST_PROGRESS,
new AsyncTaskResult<Progress>(this, values)).sendToTarget();
}
}
发现publishProgress方法也是通过获取Handler,发送MESSAGE_POST_PROGRESS消息。通过上面Handler中源码发现,最终走到AsyncTask的onProgressUpdate方法中,所以onProgressUpdate可以在UI线程更新任务进度。
通过上面源码分析归纳,AsyncTask其实一种集合线程池+Handler的异步任务处理机制。它能解决多任务重复创建线程代理的损耗,统一管理线程,使我们的代码更加简洁。
注意:不同API版本的源码,可能存在微小的差异,但是整体逻辑都是差不多,本文是基于API 29进行分析的。