前言
AsyncTask是一种轻量级的异步任务类,它可以在线程池中执行后台任务,然后把执行的进度和最终结果传递给主线程并在主线程中更新UI。从实现上来说,AsyncTask封装了Thread和Handler,通过AsyncTask可以更加方便地执行后台任务以及在主线程中访问UI,但是AsyncTask并不适合进行特别耗时的后台任务,对于特别耗时的任务来说,建议使用线程池。
AsyncTask 泛型参数
AsyncTask是一个抽象的泛型类,它提供了Params、Progress和Result这三个泛型参数。
- Params:表示参数的类型;
- Progress:表示后台任务的执行进度的类型;
- Result:表示后台任务的返回结果的类型;
如果AsyncTask确实不需要传递具体的参数,那么这三个泛型参数可以用Void来代替。AsyncTask这个类的声明如下所示。
public abstract class AsyncTask<Params, Progress, Result>
AsyncTask 核心方法
AsyncTask提供了5个核心方法,它们的含义如下所示。
- onPreExecute():在主线程中执行,在异步任务执行之前,此方法会被调用,一般可以用于做一些准备工作。
- doInBackground(Params... params):在线程池中执行,此方法用于执行异步任务,params参数表示异步任务的输入参数。在此方法中可以通过publishProgress方法来更新任务的进度,publishProgress方法会调用onProgressUpdate方法。另外此方法需要返回计算结果给onPostExecute方法。
- onProgressUpdate(Progress... values):在主线程中执行,当后台任务的执行进度发生改变时此方法会被调用。
- onPostExecute(Result result):在主线程中执行,在异步任务执行之后,此方法会被调用,其中result参数是后台任务的返回值,即doInBackground的返回值。
- Cancel(Boolean mayInterruptIfRunning):取消当前任务,mayInterruptIfRunning参数代表是否中断,true:中断,false:不中断。
上面这几个方法,onPreExecute先执行,接着是doInBackground,最后才是onPostExecute。除了上述四个方法以外,AsyncTask还提供了onCanceled()方法,它同样在主线程中执行,当异步任务被取消时,onCanceled()方法会被调用,这个时候onPostExecute则不会被调用。
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]);
// 更新进度,就是通过handler发送进度给主线程,会回调onProgressUpdate方法
publishProgress((int) (i / (float)count) * 100));
if(isCanceled()) {
break;
}
}
return totalSize;
}
protected void onProgressUpdate(Integer... progress) {
setProgressPercent(progress[0]);
}
protected void onPostExecute(Long result) {
showDialog("Download " + result + " bytes");
}
}
在上面的代码中,实现了一个具体的AsyncTask类,这个类主要用于模拟文件的下载过程,它的输入参数类型为URL,后台任务的进度参数为Integer,而后台任务的返回结果为Long参数。注意到doInBackground和onProgressUpdate方法它们的参数中均包含...的字样,在Java中...表示参数的数量不定,它是一种数组型参数,...的概念和C语言中的...是一致的。当要执行上述下载任务时,可以通过如下方式来完成:
new DownloadFilesTask().execute(url1, url2, url3);
在DownloadFilesTask中,doInBackground用来执行具体的下载任务并通过publishProgress方法来更新下载的进度,同时还要判断下载任务是否被外界取消了。当下载任务完成后,doInBackground会返回结果,即下载的总字节数。需要注意的是,doInBackground是在线程池中执行的。onProgressUpdate用于更新界面中下载的进度,它运行在主线程,当publishProgress被调用时,此方法就会被调用。当下载任务完成后,onPostExecute方法就会被调用,它也是运行在主线程中,这个时候我们就可以在界面上做出一些提示,比如弹出一个对话框告知用户下载已经完成。
AsyncTask 条件限制
AsyncTask在具体的使用过程中也是有一些条件限制的,主要有如下几点:- AsyncTask 的类必须在主线程中加载,这就意味着第一次访问AsyncTask必须发生在主线程,当然这个过程在Android 4.1及以上版本中已经被系统自动完成。
- AsyncTask的对象必须在主线程中创建。
- AsyncTask的ececute方法必须在UI线程调用。
- 不要在程序中直接调用onPreExecute()、onPostExecute()、doInBackground()和onProgressUpdate()方法。
- 一个AsyncTask对象只能执行一次,即只能调用一次execute()方法,否则会报运行时异常。
- 在Android 1.6之前,AsyncTask是串行执行任务的,Android 1.6的时候AsyncTask开始采用线程池处理并行任务,但是从Android 3.0 开始,为了避免AsyncTask所带来的并发错误,AsyncTask又采用一个线程来串行执行任务。尽管如此,在Android 3.0以及后续的版本中,我们仍然可以通过AsyncTask的executeOnExecutor方法来并行执行任务。
AsyncTask 工作原理
为了分析AsyncTask的工作原理,我们从它的execute方法开始分析,execute方法又会调用executeOnExecutor方法,它们的实现如下所示:
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方法,在主线程中执行
onPreExecute();
- // 把参数传递给mWorker工作线程
mWorker.mParams = params;
exec.execute(mFuture);
return this;
}
在上面的代码中,sDefaultExecutor实际上是一个串行的线程池,一个进程中所有的AsyncTask全部在这个串行的线程池中排队执行,这个排队执行的过程后面会再进程分析。在executeOnExecutor方法中,AsyncTask的onPreExecute方法最先执行,然后线程池开始执行。下面分析线程池的执行过程,如下所示:
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);
}
}
}
从SerialExecutor的实现可以分析AsyncTask的排队执行的过程。
1、首先系统会把AsyncTask的Params参数封装为FutureTask对象,FutureTask是一个并发类,在这里充当了Runnable的作用。
2、接着这个FutureTask会交给SeerialExecutor的execute方法去处理,SerialExecutor的execute方法首先会把FutureTask对象插入到任务队列mTasks中,
3、如果这个时候没有正在活动的AsyncTask任务,那么就会调用SerialExecutor的scheduleNext方法来执行下一个AsyncTask任务。
4、同时当一个AsyncTask任务执行完后,AsyncTask会继续执行其他任务直到所有的任务都被执行为止,从这一点可以看出,在默认情况下,AsyncTask是串行执行的。
AsyncTask中有两个线程池(SerialExecutor和THREAD_POOL_EXECUTOR)和一个Handler(InternalHandler),其中线程池SerialExecutor用于任务的排队,而线程池
THREAD_POOL_EXECUTOR用于真正地执行任务,
InternalHandler用于将执行环境从线程池切换到主线程。在AsyncTask的构造方法中有如下这么一段代码,由于FutureTask的run方法会调用mWork的call方法(FutureTask源码解析:
http://blog.csdn.net/xhbxhbsq/article/details/53608164
),因此mWorker的call方法最终会在线程池中执行。
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;
}
在mWorker的call方法中,首先将mTaskInvoked设为true,表示当前任务已经被调用过了,然后执行AsyncTask的doInBackground方法,接着将其返回值传递给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方法会通过getHandler发送一个MESSAGE_POST_RESULT的消息,这个getHandler的定义如下所示。
private static InternalHandler sHandler;
private static Handler getHandler() {
// 单例模式,饿汉式
synchronized (AsyncTask.class) {
if (sHandler == null) {
sHandler = new InternalHandler();
}
return sHandler;
}
}
private static class InternalHandler extends Handler {
public InternalHandler() {
//
Looper.getMainLooper()获取主线程的Loopersuper(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;
}
}
}
可以发现,sHandler是一个静态的Handler对象,为了能够将执行环境切换到主线程,这就要求sHandler这个对象必须在主线程中创建。由于静态成员会在加载类的时候进行初始化,因此这就变相要求AsyncTask的类必须在主线程中加载,否则同一个进程中的AsyncTask都将无法正常工作。sHandler收到
MESSAGE_POST_RESULT这个消息后会调用AsyncTask的finish方法,如下所示。
private void finish(Result result) {
// 是否设置了取消
if (isCancelled()) {
onCancelled(result);
} else {
onPostExecute(result);
}
// 设置状态为FINISHED
mStatus = Status.FINISHED;
}
public final boolean cancel(boolean mayInterruptIfRunning) {
// 设置取消
mCancelled.set(true);
//
mayInterruptIfRunning 是否中断true:中断,false:不中断return mFuture.cancel(mayInterruptIfRunning);
}
AsyncTask的finish方法的逻辑比较简单,如果AsyncTask被取消执行了,那么就调用onCanceled方法,否则就会调用onPostExecute方法,可以看到doInBackground的返回结果会传递给onPostExecute方法,到这里AsyncTask的整个工作过程就分析完毕了。