本文很多资料基于Google Developer官方对AsyncTask的最新介绍。
AsyncTask 是什么
AsyncTask is designed to be a helper class around Thread and Handler and does not constitute a generic threading framework.
AsyncTasks should ideally be used for short operations (a few seconds at the most.)
If you need to keep threads running for long periods of time, it is highly recommended you use the various APIs provided by the java.util.concurrent package such as Executor, ThreadPoolExecutor and FutureTask.
上文翻译:AsyncTask 是一个被设计为围绕Thread和Handler操作的工具帮助类,而不是作为通用的线程框架,理想情况下,应将AsyncTasks用于短操作(最多几秒钟)。如果需要长时间保持线程运行,Google建议使用java.util.concurrent这个并发包提供的各种API,例如 Executor,ThreadPoolExecutor和 FutureTask。
!This class was deprecated in API level 30.
Use the standard java.util.concurrent or Kotlin concurrency utilities instead.
目前官方已经明确说明,AsyncTask 将会在API 30,也就是Android 11的版本中,将这个类废弃掉。使用java.util.concurrent
和Kotlin的协程组件代替AsyncTask 。
谷歌要将AsyncTask废弃掉的原因,我猜测是:AsyncTask 是一个很古老的类了,在API Level 3的时候就有了,还有着许多致命的缺点,终于连Google都忍不了,加上目前已经有许多替代的工具了,如Kotlin协程等。
AsyncTask的缺陷
However, the most common use case was for integrating into UI, and that would cause Context leaks, missed callbacks, or crashes on configuration changes.
It also has inconsistent behavior on different versions of the platform, swallows exceptions from doInBackground, and does not provide much utility over using Executors directly.
译:
- AsyncTask 最常见是子类继承然后直接用在 UI层的代码里,这样容易导致Context的内存泄漏问题
- Callback回调的失效
- 配置改变时的崩溃
- 不同版本行为不一致:最初的AsyncTasks在单个后台线程上串行执行;Android1.6时它更改为线程池,允许多个任务并行运行;Android 3.2时又改为只会有单个线程在执行请求,以避免并行执行引起的常见应用程序错误。
- 在它的重要方法doInBackground中会将出现的异常直接吞掉
- 多个实例调用execute后,不能保证异步任务的执行修改顺序合理
- 在直接使用Executors方面没有提供太多实用性
缺点真的蛮多的,简单用用可能还行,但是要考虑清楚
AsyncTask的参数和重要方法
定义子类时需设置传入的三大参数类型
-
Params(在执行AsyncTask时需要传入的参数,可用于在后台任务中使用)
-
Progress(后台任务执行时,如果需要在界面上显示当前的进度,则使用这里指定的泛型作为进度单位)
-
Result(当任务执行完毕后,如果需要对结果进行返回,则使用这里指定的泛型作为返回值类型)
定义子类时可重写四大方法:onPreExecute,onProgressUpdate,doInBackground,onPostExecute
-
onPreExecute()
这个方法会在后台任务开始执行之前调用,用于进行一些界面上的初始化操作,比如显示一个进度条对话框等。
-
doInBackground(Params...)
子线程中运行此方法,可以将几秒的耗时任务在这里运行。任务一旦完成就可以通过return语句来将任务的执行结果进行返回。若Result类型,指定了Void,就不会返回任务执行结果。如果想要更新当前的任务进度想在UI中显示出来,可以通过 publishProgress(Progress...)。
-
onProgressUpdate(Progress...)
当
doInBackground(params)
调用了publishProgress(Progress...)方法后,此方法中会被调用,传递的参数值就是在后台任务中传递过来的,类型是上面说到的Progress
的类型。这个方法是在UI线程操作,对UI进行操作,利用参数中的数值就可以对界面元素进行相应的更新。 -
onPostExecute(Result)
当后台任务执行完毕并通过return语句进行返回时,返回的数据会作为参数传递到此方法中,可以利用返回的
Result
来进行一些UI操作。
AsyncTask开始简单的异步任务
简单来说:AsyncTask是一个抽象类,必须被子类化才能使用,这个子类一般都会覆盖这两个方法doInBackground(Params...)
和 onPostExecute(Result)
,创建AsyncTask子类的实例执行execute方法就运行异步任务了。
//最简单的AsyncTask实现方式
public class DownloadTask extends AsyncTask {
@Override
protected void onPreExecute() {
super.onPreExecute();
}
@Override
protected Boolean doInBackground(String... strings) {
return null;
}
@Override
protected void onProgressUpdate(Integer... values) {
super.onProgressUpdate(values);
}
@Override
protected void onPostExecute(Boolean aBoolean) {
super.onPostExecute(aBoolean);
}
}
//在UI线程中启用 AsyncTask
new DownloadTask().execute();
使用AsyncTask要遵守的规矩
-
必须在UI线程上加载AsyncTask类。
-
必须在UI线程上创建 AsyncTask子类的实例。
-
必须在UI线程上调用 execute(Params ...)。
-
不要手动调用onPreExecute,onPostExecute,doInBackground,onProgressUpdate这几个方法
-
该任务只能执行一次(如果尝试第二次执行,则将引发异常。)
好鸡肋的设定啊,不知道当初为什么要这样设计
AsyncTask源码分析
先由一行最简单的启动AsyncTask的代码入手:
new DownloadTask().execute("");
进入execute方法查看:
@MainThread
public final AsyncTask execute(Params... params) {
return executeOnExecutor(sDefaultExecutor, params);
}
先看下sDefaultExecutor
这个属性是什么名堂:
//sDefaultExecutor 被 volatile修饰
private static volatile Executor sDefaultExecutor = SERIAL_EXECUTOR;
//串行执行任务线程池实例
public static final Executor SERIAL_EXECUTOR = new SerialExecutor();
private static class SerialExecutor implements Executor {
//维护一个Runnable的队列
final ArrayDeque mTasks = new ArrayDeque();
Runnable mActive;
//往队尾中压入一个Runnable的同时运行队头的Runnable,维护队列的大小
public synchronized void execute(final Runnable r) {
mTasks.offer(new Runnable() {
public void run() {
try {
r.run();
} finally {
scheduleNext();
}
}
});
if (mActive == null) {
scheduleNext();
}
}
//弹出,执行队头的Runnable
protected synchronized void scheduleNext() {
if ((mActive = mTasks.poll()) != null) {
//执行 被赋值的mActive 任务
THREAD_POOL_EXECUTOR.execute(mActive);
}
}
}
//创建核心线程数为 1,最大线程容量为20的线程池,实际的任务执行线程池
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(), sThreadFactory);
threadPoolExecutor.setRejectedExecutionHandler(sRunOnSerialPolicy);
THREAD_POOL_EXECUTOR = threadPoolExecutor;
}
可以看到的是sDefaultExecutor
,是一个控制任务排队的线程池,被调用execute
时会将新的Runnable压入任务队列,如果Runnable mActive == null的话会取出队头的Runnable执行,而每当一个任务结束后都会执行任务队列中队头Runnable。
这样做的目的是:保证在不同情况,只能有一个任务可以被执行,SerialExecutor做出了单一线程池的效果。每当一个任务执行完毕后,下一个任务才会得到执行,假如有这么一种情况,主线程快速地启动了很多AsyncTask任务,同一时刻只会有一个线程正在执行,其余的均处于等待状态。
再来看看executeOnExecutor
这个方法又有什么名堂:
@MainThread
public final AsyncTask 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;
//由上文提到的 sDefaultExecutor 执行 FutureTask任务
exec.execute(mFuture);
return this;
}
//Callable的子类,泛型类型为
private final WorkerRunnable mWorker;
private final FutureTask mFuture;
executeOnExecutor
执行方法,会先检查是否运行了这个任务或者已结束,由于AsyncTask任务规定每个任务只能执行一次,不符合就会抛出异常。接着开始调用 onPreExecute
开始预执行,然后给mWorker赋值参数,执行
mFuture蕴含的任务。到这里好像就没了?非也非也,还有很关键的AsyncTask的构造函数
/**
* 创建一个新的异步任务。 必须在UI线程上调用此构造函数。
*/
public AsyncTask(@Nullable Looper callbackLooper) {
//获取主线程Looper的Handler对象
mHandler = callbackLooper == null || callbackLooper == Looper.getMainLooper()
? getMainHandler()
: new Handler(callbackLooper);
//Worker线程被运行后会执行异步的任务
mWorker = new WorkerRunnable() {
public Result call() throws Exception {
mTaskInvoked.set(true);
Result result = null;
try {
Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND);
//执行doInBackground(mParams)返回 Result类型
result = doInBackground(mParams);
Binder.flushPendingCommands();
} catch (Throwable tr) {
mCancelled.set(true);
throw tr;
} finally {
postResult(result);
}
return result;
}
};
//FutureTask--泛型参数为 Result
mFuture = new FutureTask(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);
}
}
};
}
//postResultIfNotInvoked 如果未被调用,传递结果
private void postResultIfNotInvoked(Result result) {
final boolean wasTaskInvoked = mTaskInvoked.get();
if (!wasTaskInvoked) {
postResult(result);
}
}
//利用Handler将带有result的消息压入消息队列,等待主线程的Handler执行
private Result postResult(Result result) {
@SuppressWarnings("unchecked")
//getHandler()获取到的就是AsyncTask构建对象时创建的‘mHandler’,持有主线程Looper
Message message = getHandler().obtainMessage(MESSAGE_POST_RESULT,
new AsyncTaskResult(this, result));
message.sendToTarget();
return result;
}
AsyncTask
的构造方法,对三个重要的东西(mHandler,mWorker,mFuture)进行了初始化,确保他们在被运行时能够执行相应的任务。
再来看下 mHandler
是 InternalHandler
的实例,这个持有主线程Looper的Handler子类的特别之处:
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) {
//result.mTask属性是AsyncTask的引用
//当接收到不同类型消息,会分别执行 在UI线程更新进度 和 结束任务的方法
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;
}
}
}
由于InternalHandler
的实例被创建时,获取的是主线程的Looper,所以它的 handleMessage(msg)
方法自然也是在主线程中执行
再看下这个AsyncTask类内的 finish 方法
private void finish(Result result) {
if (isCancelled()) {
//任务已经被取消了,执行onCancelled
onCancelled(result);
} else {
//任务正常结束了,执行onPostExecute(result)
onPostExecute(result);
}
//将任务状态变更为 已结束
mStatus = Status.FINISHED;
}
判断任务是由于被取消掉而结束还是正常结束,执行onCancelled(result) or 执行onPostExecute(result)
源码分析总结
AsyncTask类维护着一个串行执行任务的线程池sDefaultExecutor,一个进程中的所有的 AsyncTask 子类全部在这个线程池中执行。
AysncTask 中的两个线程池(SerialExecutor
和 THREAD_POOL_EXECUTOR
)和维护着一个持有主线程Looper的 Handler(InternalHandler
),其中线程池 SerialExecutor 保证在不同情况,只能有一个任务可以被执行,THREAD_POOL_EXECUTOR
是核心线程数为1的线程池,负责执行耗时任务,InternalHandler
用于将执行环境从后台工作线程切换到主线程,完成UI更新进度,取消任务和任务结束后的UI操作。