1、概述
- AsyncTask的作用:首先看看API中对AsyncTask的官方解释
<p>AsyncTask enables proper and easy use of the UI thread. This class allows you
* to perform background operations and publish results on the UI thread without
* having to manipulate threads and/or handlers.</p>
- 上述这句话翻译的意思是:AsyncTask能够正确使用UI线程,允许您在UI线程上执行后台操作和发布结果,而不必操纵线程和/或处理程序,简单的说就是可以直接执行后台任务而无需自己处理线程;
- AsyncTask的主要方法:
- AsyncTask<Params, Progress, Result>: 继承AsyncTask需要传入三个参数类型;Params:后台任务的输入参数类型,Progress:中间进度的数据类型,Result : 执行结果的数据类型;
- protected void onPreExecute() :执行后台任务的准备工作,在执行doInBackground()前调用;
- abstract Result doInBackground(Params... params):根据参数和逻辑在后台执行操作任务并返回执行的结果,抽象方法必须实现;
- void onProgressUpdate(Progress... values) :在操作执行时刷新操作进度,需要配合void publishProgress(Progress... values)方法使用;
- void onPostExecute(Result result):后台任务执行完成后返回执行的结果,此时方法已经切换到UI线程了;
2、基本使用
- 以一个简单例子使用AsyncTask的执行,并输出相应的线程信息,使用方法创建类继承AsyncTask,并重写相应的方法,代码如下:
inner class TestAsyncTask : AsyncTask<Int, Int, String>() {
override fun doInBackground(vararg params: Int?): String {
Log.e("method:", "doInBackground()")
Log.e("Thread:", Thread.currentThread().name)
val stringBuilder = StringBuilder()
for (i in params[0]!!..params[0]!! + 10) { // 输出信息
stringBuilder.append(i)
publishProgress(i) // 更新当前进度
Thread.sleep(500)
}
return stringBuilder.toString()
}
override fun onPreExecute() {
super.onPreExecute()
Log.e("method:", "onPreExecute()")
Log.e("Thread:", Thread.currentThread().name)
}
override fun onProgressUpdate(vararg i: Int?) {
super.onProgressUpdate(*i)
Log.e("method:", "onProgressUpdate()")
Log.e("Thread:", Thread.currentThread().name)
Log.e("Progress:", i.toString()) //更新进度
}
override fun onPostExecute(result: String?) {
super.onPostExecute(result)
Log.e("method:", "onPostExecute()")
Log.e("Thread:", Thread.currentThread().name)
}
}
- 在Activity中的调用
TestAsyncTask().execute(0)
- 执行结果:
从上面的执行结果中看出只有doInBackground()方法,执行在非UI线程,其余的输出都切换在UI线程,这也就说明开头的解释:无需开发者对线程管理,AsyncTask会自动切换线程执行任务和输出结果;
3、源码分析
相信对于AsyncTask 的使用没什么难度,系统封装好了处理数据和线程的功能,只需按照步骤把要执行的逻辑放进去就好了,现在来看看AsyncTask 是如何处理了复杂逻辑而却给我们提供简单的使用方法,由使用示例知道AsyncTask 的执行是从调用AsyncTask().execute()开始的,一起来看看他的源码吧:
@MainThread
public final AsyncTask<Params, Progress, Result> execute(Params... params) {
return executeOnExecutor(sDefaultExecutor, params);
}
@MainThread
public final AsyncTask<Params, Progress, Result> executeOnExecutor(Executor exec,
Params... params) {
if (mStatus != Status.PENDING) { //判断此时的AsyncTask对象的状态
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; //标记AsyncTask对象为运行状态
onPreExecute();
mWorker.mParams = params; //设置任务参数
exec.execute(mFuture);
return this;
}
从源码中可以看出execute()的方法执行过程:
- 从方法注解中看出execute()必须在主线程中调用
- 在execute()方法中调用executeOnExecutor()传入Executor实例和参数params
- 在executeOnExecutor()中,首先判断运行状态,AsyncTask提供三种运行状态:PENDING(未执行)、RUNNING(执行中)、FINISHED(完成)三种状态,只有在PENDING状态下才可执行,且每个对象只能执行一次
- 调用onPreExecute()方法初始化数据,此时方法执行在Main线程中
- 设置参数,并执行任务
上述所述的执行过程外,方法中还出现了三个变量:sDefaultExecutor 、mWorker、mFuture,从变量的名称和执行的操作我们姑且可以猜测一下,sDefaultExecutor 应该为任务的直接执行者(即线程、线程池)或间接调用线程执行,mWork对执行参数的封装,mFuture是在exec.execute(mFuture)中执行的,所以应该Runnable类的实例,三个对象实现了任务的保存、获取、执行者、如何执行;那如果我们搞懂了这几个类的工作过程也就搞懂了AsyncTask的实现。
3.1 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);
}
}
}
- sDefaultExecutor是在开始就初始化好的SerialExecutor的实例,sDefaultExecutor最终调用的是SerialExecutor中的execute()方法执行任务
- SerialExecutor类中创建一个Runnable队列ArrayDeque<Runnable> Task,用于保存和获取sDefaultExecutor传递的任务
- execute()方法中首先将Runnable添加到对列Task中,然后调用mTask.poll()取出头部的Runnable对象,每次执行完后都会调用schedule获取下一个任务,从而实现任务串行处理
- 将拿到的Runnable对象交给THREAD_POOL_EXECUTOR执行,很显然 THREAD_POOL_EXECUTOR为线程池,创建过程如下:
private static final BlockingQueue<Runnable> sPoolWorkQueue =
new LinkedBlockingQueue<Runnable>(128); // 任务队列
private static final ThreadFactory sThreadFactory = new ThreadFactory() { // 生成命名的线程
private final AtomicInteger mCount = new AtomicInteger(1);
public Thread newThread(Runnable r) {
return new Thread(r, "AsyncTask #" + mCount.getAndIncrement());
}
};
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;
}
上述为手动创建线程池的基本过程,还记得前面的Log中执行onBackground()的线程 AsyncTask #1吗;就是在这个地方创建的,也间接说明了真正执行任务的是线程池
忽略参数细节处理的话,到此Async的执行流程基本出来了,首先调用execute()方法 --> 判断状态是否为PENDING -->调用prepare准备数据 -->一系列的参数操作 -->在SerialExecutor中的队列中保存任务 -> 取出头部任务 --> 线程池执行取出的任务;
3.2 mWorker
从上面的赋值可以看出,mWork保存了AsyncTask传入的参数params,下面看看它是如何执行的:
private static abstract class WorkerRunnable<Params, Result> implements Callable<Result> {
Params[] mParams;
}
mWorker = new WorkerRunnable<Params, Result>() {
public Result call() throws Exception {
mTaskInvoked.set(true);
Result result = null;
try {
Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND);
result = doInBackground(mParams);//执行任务
Binder.flushPendingCommands();
} catch (Throwable tr) {
mCancelled.set(true);
throw tr;
} finally {
postResult(result);
}
return result;
}
};
- mWork是Callable的对象,学过Java多线程应该知道Callable接口,它作用相当于Runnable在执行是会调用内部的call()并返回执行结果,另外它内部保存参数的数组Params,这也验证了我们之前的猜想;
- 在AsynTask 的构造函数中创建了mWork,重写了Callable的call(),在方法中调用doInBackground()执行任务;
- 使用mTaskInvoked保存true,此处只是保持一个标志位,具体作用在下面会看到
- 在得到返回结果Result后,通过postResult()发送数据,postResult()中使用Handler切换线程发送结果,此处的Handler一定在主线程中,通过Handler发送Message切换UI线程;
private Result postResult(Result result) {
@SuppressWarnings("unchecked")
Message message = getHandler().obtainMessage(MESSAGE_POST_RESULT,
new AsyncTaskResult<Result>(this, result));
message.sendToTarget();
return result;
}
3.2 mFuture:封装mWorker并执行任务
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);
}
}
};
还记的前面的判断吗?mFuture 为Runnable的对象,它的使用也基本都是封装Callable对象并调用Callable.call()方法,在AsyncTask中同样也实例化了mFuture的对象,实现done()方法,在任务执行结束后调用 postResultIfNotInvoked()传递结果;
private void postResultIfNotInvoked(Result result) {
final boolean wasTaskInvoked = mTaskInvoked.get();
if (!wasTaskInvoked) {
postResult(result);
}
}
- 调用mTaInvoked.get()判断是否已经发送过结果,想起前面mWorker的设置 mTaskInvoked.set(true)了吧,如果已经设置为true表示已经执行过mWork的call(),即已经发送过数据,如果获取为false再次调用postResult发送
3.4 线程池执行mFuture
- 线程池执行后会调用mFuture的run()方法,在run()中又回调用其内部的Callable.call()方法;
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();//调用call()
ran = true;
} catch (Throwable ex) {
result = null;
ran = false;
setException(ex);
}
if (ran)
set(result);
}
} finally {
runner = null;
int s = state;
if (s >= INTERRUPTING)
handlePossibleCancellationInterrupt(s);
}
}
- 首先拿到Callable的实例,提到Callable应该会面熟吧,前面的mWorker就是Callable实例,那mWorker如何传到这的呢?没错前面mFuture传入的mWorker正是此处的mCallabke;
- 执行mCallablke的call(),也就是执行mWorker的call(),而mWorker调用了doInbackgroud()和postResult(),到此任务的执行和结果的传递都联系起来了吧
- 最后的set(result)会调用mFuture的done()方法,二次确认是否传递了执行结果
到此AsyncTask的参数处理、任务执行和结果的传递都介绍完毕了,相信大家对此过程应该有所了解了,所剩部分就是AsyncTask的线程切换了,前面也提到了是利用Handler实现的,一起看看吧
3.5 线程的切换
- 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) {
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;
}
}
}
- Result的传递前面介绍的 postResult()方法中
- Progress的传递调用 publishProgress(Progress... values)
protected final void publishProgress(Progress... values) {
if (!isCancelled()) {
getHandler().obtainMessage(MESSAGE_POST_PROGRESS,
new AsyncTaskResult<Progress>(this, values)).sendToTarget();
}
}
好了,大功告成,所有的内容讲完了,有没有感觉代码封装的奇妙之处呢?有没想自己尝试一下写一个简单的AsyncTask呢?心动不如行动,一起实现一个简单的AsyncTask类吧;
3.6 版本更新
- Android 4.0之后
关于Async经常被提及的问题可能就是串行和并行的问题,上面的版本在android-28版本中的源码,从代码中看出使用了阻塞消息队列,即任务采用串行方式依次执行;
- Andoid 2.3之前
private static final ThreadPoolExecutor sExecutor = new ThreadPoolExecutor(CORE_POOL_SIZE,MAXIMUM_POOL_SIZE, KEEP_ALIVE, TimeUnit.SECONDS, sWorkQueue, sThreadFactory); // 创建线程池
mStatus = Status.RUNNING;
onPreExecute();
mWorker.mParams = params;
sExecutor.execute(mFuture); // 直接使用线程池执行任务
从Android2.3的源码中看出在调用execute()方法后,直接使用创建的线程池sExecutor对象执行任务,线程池直接执行必然会是一个并发的过程,所以2.3之前AsyncTask是并行执行的;
从上面两个版本代码中细心的同学会发现,4.0之后源码中是在线程池执行任务前增加一个环节,使用的阻塞队列阻塞线程实现串行,但源码中的executeOnExecutor()方法仍然是public,换句话说我们直接可以用此方法让线程池直接执行Future对象,这样就可在当前版本中实现并行;
new MyAsyncTask("AsyncTask#1").executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR,"");
4、SimpleAsyncTask
代码如下:
/**
* @author : Alex
* @date : 2018/08/25
* @version : V 2.0.0
*/
const val PROGRESS = 100
const val RESULT = 101
abstract class SimpleAsyncTask<Params, Progress, Result> {
val handler = object : Handler(Looper.getMainLooper()) {
override fun handleMessage(msg: Message?) {
super.handleMessage(msg)
when (msg?.what) {
PROGRESS -> onProgressUpdate(msg.obj as Progress)
RESULT -> onPostExecute(msg.obj as Result)
}
}
}
open fun onPreExecute() {
}
open abstract fun doInBackground(params: Array<Int>): Result
open fun onProgressUpdate( progress: Progress) {
}
open fun onPostExecute(result: Result) {
}
fun postResult(result: Result) {
val msg = handler.obtainMessage(RESULT, result)
handler.sendMessage(msg)
}
fun publishProgress(progress: Progress) {
val msg = handler.obtainMessage(PROGRESS, progress)
handler.sendMessage(msg)
}
fun execute(params: Array<Int>) {
onPreExecute()
Thread {
postResult(doInBackground(params))
}.start()
}
}
将上面例子中改为继承SimpleAsyncTask,执行结果与AsyncTask执行结果一样:
例子非常简单也体现了执行的过程和逻辑,好了本次到此结束。