Android多线程开发之AsyncTask的使用

一、AsyncTask简介

AsyncTask是一种轻量级的异步任务类,它内部封装了Handler和Thread，能将后台线程执行的进度和最终的结果分发到UI线程中进行处理，通过AsyncTask可以更加方便地执行后台任务。

AsyncTask并不构成一个通用的线程处理框架，理想情况下它只应该用于短时间的操作(最多几秒钟)，若是需要保持线程运行较长一段时间的话，Google推荐我们使用java.util.concurrent包中的API，比如：Executor, ThreadPoolExecutor和FutureTask.

一个异步任务定义了三个泛型参数，分别是：Params, Progress和Result，还定义了4个方法执行的步骤，分别是：onPreExecute, doInBackground, onProgressUpdate和onPostExecute.

二、AsyncTask使用说明

AsyncTask是抽象类，必须实现它的抽象方法doInBackground(…)，大多数情况下我们可能还需要实现onPostExecute(…)方法去获取异步任务处理的结果。在使用AsyncTask类时，我们需要指定3个泛型参数，分别是：

• Params：表示后台任务执行时传入的参数的类型
• Progress：表示后台任务的执行进度的类型
• Result：表示后台任务的返回结果的类型

这三种参数类型并非一定要使用，若不想用它，传一个Void就行。

private class MyTask extends AsyncTask<Void, Void, Void> { ... }

AsyncTask使用中经常需要重写的四个方法分别是：

1. onPreExecute()：执行在UI线程中，在异步任务开始执行之前调用，用于进行一些界面上的初始化操作，比如显示一个进度条对话框等。

2. doInBackground(Params…)：执行在后台线程中，在onPreExecute()方法执行之后调用，参数Params表示异步任务的输入参数，该方法计算的结果Result参数会返回给onPostExecute()方法，在此方法中可以通过调用publishProgress()方法来更新任务的进度，然后传递到onProgressUpdate()进行显示。

3. onProgressUpdate(Progress…)：执行在UI线程中，publishProgress(Progress…)方法执行后调用，用于更新当前异步任务执行的进度，方法中携带的参数就是在doInBackground()中传递过来的。

4. onPostExecute(Result)：执行在UI线程中，在异步任务执行完后调用，其中result参数是doInBackground()的返回值，可以利用该参数来进行一些UI操作，比如说提醒任务执行的结果，以及关闭掉进度条对话框等。

AsyncTask的线程规则：

• AsyncTask的类必须在主线程中被加载，在4.1及以上的版本已经被系统自动完成了；
• AsyncTask的实例对象必须在UI中创建；
• AsyncTask的execute()方法必须在UI线程调用；
• 不要在程序中直接调用onPreExecute(), onPostExecute(), doInBackground()和onProgressUpdate()方法；
• 一个AsyncTask对象只能被执行一次, 即只能调用一次execute()方法, 否则会报运行时异常；

如何取消一个任务：

• 通过调用cancel()方法可以在任意时刻取消一个正在进行的异步任务；
• 调用cancel()方法后，后续调用isCancelled()方法会返回true；
• 调用cancel()方法后，一旦doInBackground()方法执行完，onPostExecute()方法不会被调用，而onCancelled()方法会被调用；
• 调用cancel()方法后，为确保任务能尽快的取消，我们应该在doInBackground()方法中对isCancelled()方法的返回值进行检查。

AsyncTask的执行顺序：

• 在DONUT(即Android 1.6)之前，AsyncTask是串行执行任务的;
• 在Android 1.6的时候AsyncTask开始采用在线程池里处理并行任务;
• 后来，从HONEYCOMB(即Android 3.0)开始，为了避免AsyncTask带来的并发错误，AsyncTask又采用了在一个线程中串行的执行任务。

不过，在3.0以后，我们仍然可以通过AsyncTask#executeOnExecute()方法来并行的执行任务。

三、AsyncTask使用实例

异步文件下载AsyncTask类：

import android.app.ProgressDialog;
import android.content.Context;
import android.os.AsyncTask;
import android.widget.Toast;

public class DownloadFilesTask extends AsyncTask<String, Integer, Long> {
    private ProgressDialog mProgressDialog;
    private Context mContext;

    public DownloadFilesTask(Context context) {
        this.mContext = context;
    }

    @Override
    protected void onPreExecute() {
        mProgressDialog = new ProgressDialog(mContext);
        mProgressDialog.show();
    }

    @Override
    protected Long doInBackground(String... urls) {
        int count = urls.length;
        long totalSize = 0;
        for (int i = 0; i < count; i++) {
            totalSize += Downloader.downloadFile(urls[i]); // pseudo-code
            publishProgress((int) ((i / (float) (count - 1)) * 100));
            // Escape early if cancel() is called
            if (isCancelled()) {
                break;
            }
        }
        return totalSize;
    }

    @Override
    protected void onProgressUpdate(Integer... values) {
        mProgressDialog.setMessage("Current download progress：" + values[0] + "%");
    }

    @Override
    protected void onPostExecute(Long result) {
        mProgressDialog.dismiss();
        Toast.makeText(mContext, "Download " + result + " bytes.", Toast.LENGTH_SHORT).show();

    }

    @Override
    protected void onCancelled(Long result) {
        mProgressDialog.dismiss();
        Toast.makeText(mContext, "Download cancelled!", Toast.LENGTH_SHORT).show();
    }
}

启动AsyncTask：

 new DownloadFilesTask(this).execute(url1, url2, url3);

四、AsyncTask源码解析

由于各个版本的AsyncTask实现大同小异，我这里仅以Android 5.1的源码来进行分析。

初看AsyncTask的源码，会发现里面有一大堆的用static标识的成员变量、类及代码块，对此我们需要了解一下类的初始化过程，不太了解的请移步博客：Java中的类加载顺序

接下类，我们看下AsyncTask类被加载时执行的代码片段：

成员变量及构造函数的初始化

public abstract class AsyncTask<Params, Progress, Result> {
    private static final String LOG_TAG = "AsyncTask";

    //获得当前运行状态的cup数量
     private static final int CPU_COUNT = Runtime.getRuntime().availableProcessors();
    //根据当前机器CPU的个数设置线程池中的核心线程数
    private static final int CORE_POOL_SIZE = CPU_COUNT + 1;
    //根据当前机器CPU的个数设置线程池中的最大线程数
    private static final int MAXIMUM_POOL_SIZE = CPU_COUNT * 2 + 1;
    //线程的存活时间
    private static final int KEEP_ALIVE = 1;

    //初始化线程工厂类，为线程池创建所需的线程
    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());
        }
    };

    //初始化线程池中的缓存队列，设置为128个
    private static final BlockingQueue<Runnable> sPoolWorkQueue =
            new LinkedBlockingQueue<Runnable>(128);

    /**
     * An {@link Executor} that can be used to execute tasks in parallel.
     */
     //初始化线程池执行器
    public static final Executor THREAD_POOL_EXECUTOR
            = new ThreadPoolExecutor(CORE_POOL_SIZE, MAXIMUM_POOL_SIZE, KEEP_ALIVE,
                    TimeUnit.SECONDS, sPoolWorkQueue, sThreadFactory);

    /**
     * An {@link Executor} that executes tasks one at a time in serial
     * order.  This serialization is global to a particular process.
     */
    //初始化顺序执行的线程池执行器
    public static final Executor SERIAL_EXECUTOR = new SerialExecutor();

    //初始化异步任务处理结果码及进度更新码
    private static final int MESSAGE_POST_RESULT = 0x1;
    private static final int MESSAGE_POST_PROGRESS = 0x2;

    //初始化线程池中默认的执行器
    private static volatile Executor sDefaultExecutor = SERIAL_EXECUTOR;    
    //初始化消息的执行者Handler对象，在getHandler()中进行构造
     private static InternalHandler sHandler;

    //异步任务回调接口
    private final WorkerRunnable<Params, Result> mWorker;
    private final FutureTask<Result> mFuture;

    //当前异步任务的状态，初始状态为“未执行”状态
    private volatile Status mStatus = Status.PENDING;

    //初始化boolean型原子类
    private final AtomicBoolean mCancelled = new AtomicBoolean();
    private final AtomicBoolean mTaskInvoked = new AtomicBoolean();

......................

    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);
            }
        }
    }


  /**
     * Creates a new asynchronous task. This constructor must be invoked on the UI thread.
     */
    //创建一个异步任务实例，该构造方法必须在UI线程中调用
    public AsyncTask() {
        mWorker = new WorkerRunnable<Params, Result>() {
            public Result call() throws Exception {
                mTaskInvoked.set(true);  

                Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND);
                //noinspection unchecked
                return postResult(doInBackground(mParams));
            }
        };

        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 occured while executing doInBackground()",
                            e.getCause());
                } catch (CancellationException e) {
                    postResultIfNotInvoked(null);
                }
            }
        };
    }
..................

}

从这里可以知道，AsyncTask的成员变量大部分都是static的，也就是说一个应用中的内存中只保存有一份这些成员变量的值。 然后构造函数中只初始化了两个变量，分别是mWorker和mFuture，并在初始化mFuture的时候将mWorker作为参数传入，而mWorker是一个Callable对象，mFuture是一个FutureTask对象，FutureTask继承自Runnable，也即可以理解成：mFuture对象封装了一个后台的异步耗时任务，并等待线程池执行器去处理该耗时任务，而且mFuture对象会作为一个线程接口提供给调用者。这里面，实际的后台工作是由mWorker的call() 方法调用的，当然，call() 方法可能会失败，所以在mFuture的done() 方法里做了进一步的判断。

其中mWorker的实现如下：

private static abstract class WorkerRunnable<Params, Result> implements Callable<Result> {
    Params[] mParams;
}

接着我们看下它执行的入口方法execute()。

AsyncTask的执行方法execute()

public static void execute(Runnable runnable) {
    sDefaultExecutor.execute(runnable);
}

该方法仅仅是执行一个Runnable对象，实际用的并不多，我们看下另外一个方法：

 public final AsyncTask<Params, Progress, Result> execute(Params... params) {
    return executeOnExecutor(sDefaultExecutor, params);
 }

通过传递指定的参数执行异步任务，实际执行的是executeOnExecutor() 方法，我们看下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();

    mWorker.mParams = params;
    exec.execute(mFuture);

    return this;
}

该方法带有两个参数，分别是Executor和Params，第一个参数在类加载的时候就已经初始化了，这里传递进来的是sDefaultExecutor，实际开启异步任务的线程池也是它，那么它到底是串行执行还是并行执行呢？其实在前面我们已经总结了，它是串行执行还是并行执行跟平台版本有关。在1.6前通过单个后台线程去处理队列中的任务，1.6后改为固定线程数的线程池去处理队列中的任务，后来到了3.0开始，又改回到单个后台线程去处理队列中的任务，这是为了解决Android1.6以后如果异步任务超过138个时AsyncTask会抛出异常。

当然如果我们想在3.0后并行执行异步任务也是可以的，直接用executeOnExecutor()方法，并往里面传入THREAD_POOL_EXECUTOR变量来启动异步任务。

这里需要知道，AsyncTask里面有两个线程池，分别是SerialExecutor和THREAD_POOL_EXECUTOR，其中SerialExecutor用于任务的排列，而THREAD_POOL_EXECUTOR用于实际的任务执行。

execute() 执行启动后，最终在mFuture所构造的后台线程里面运行异步耗时任务，耗时任务的执行实际上会通过抽象函数doInBackground() 回调给调用者进行处理，这也是我们必须要实现的方法。执行完后，通过postResult() 进行线程间的切换，通过Handler机制将后台线程切回到UI线程。

private Result postResult(Result result) {
     @SuppressWarnings("unchecked")
     Message message = getHandler().obtainMessage(MESSAGE_POST_RESULT,
            new AsyncTaskResult<Result>(this, result));
    message.sendToTarget();
    return result;
}

这里将后台线程执行的结果Result通过AsyncTaskResult的包装传递到UI线程，AsyncTaskResult是一个私有静态内部类，只是封装了AsyncTask的实例和泛型对象Data数组。

@SuppressWarnings({"RawUseOfParameterizedType"})
private static class AsyncTaskResult<Data> {
    final AsyncTask mTask;
    final Data[] mData;
        AsyncTaskResult(AsyncTask task, Data... data) {
        mTask = task;
        mData = data;
    }
}

从前面的的类加载中我们知道，static标识的对象和代码块会优先进行加载，不过sHandler一开始初始化为null，通过调用静态方法getHandler() 后才进行实例化，而该方法内部通过同步加锁机制防止了多线程同时持有InternalHandler对象而导致的多线程安全问题。

private static Handler getHandler() {
    synchronized (AsyncTask.class) {
        if (sHandler == null) {
            sHandler = new InternalHandler();
        }
        return sHandler;
    }
}

在前面，我们说过：AsyncTask的类必须在主线程中被加载，为什么呢？因为sHandler的缘故，它是静态的，在类加载的时候进行初始化，而且我们还要用它来进行线程的切换呢，这就必须要求AsyncTask必须在UI线程中加载，否则AsyncTask工作就不正常了。

接下来我们看下InternalHandler对消息处理的实现：

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;
        }
    }
}

InternalHandler 也是私有内部类，外部不能访问，我们看到它的构造函数中传入了Looper.getMainLooper()，说明它是通过UI线程的Looper作为参数构造的，因此InternalHandler是在UI线程中处理消息的。

它里面有两种消息类型的处理，分别是MESSAGE_POST_RESULT和MESSAGE_POST_PROGRESS。

1、MESSAGE_POST_RESULT：通过调用postResult() 方法，将结果处理分发到UI线程的finish() 方法中：

private void finish(Result result) {
    if (isCancelled()) {
        onCancelled(result);
    } else {
        onPostExecute(result);
    }
    mStatus = Status.FINISHED;
}

该方法首先判断当前异步任务是否已经被取消，若取消回调onCancelled() 方法，否则回调onPostExecute() 方法，最后将mStatus标记为FINISHED。其中onPostExecute() 和onCancelled() 就是留给子类去实现的。

2、MESSAGE_POST_PROGRESS：表示这是一个进度更新消息，需要通过子类在doInBackground() 方法内部调用publishProgress() 方法来触发，然后在onProgressUpdate() 方法中回调给子类去实现。

protected final void publishProgress(Progress... values) {
    if (!isCancelled()) {
        getHandler().obtainMessage(MESSAGE_POST_PROGRESS,
            new AsyncTaskResult<Progress>(this, alues)).sendToTarget();
    }
}

接下来我们看下怎么取消异步任务：

/**
 * <p>Attempts to cancel execution of this task.  This attempt will
 * fail if the task has already completed, already been cancelled,
 * or could not be cancelled for some other reason. If successful,
 * and this task has not started when <tt>cancel</tt> is called,
 * this task should never run. If the task has already started,
 * then the <tt>mayInterruptIfRunning</tt> parameter determines
 * whether the thread executing this task should be interrupted in
 * an attempt to stop the task.</p>
 * 
 * <p>Calling this method will result in {@link #onCancelled(Object)} being
 * invoked on the UI thread after {@link #doInBackground(Object[])}
 * returns. Calling this method guarantees that {@link #onPostExecute(Object)}
    * is never invoked. After invoking this method, you should check te
    * value returned by {@link #isCancelled()} periodically from
    * {@link #doInBackground(Object[])} to finish the task as early as
    * possible.</p>
    *
    * @param mayInterruptIfRunning <tt>true</tt> if the thread executing this
    *        task should be interrupted; otherwise, in-progress tasks are allowed
    *        to complete.
    *
    * @return <tt>false</tt> if the task could not be cancelled,
    *         typically because it has already completed normally;
    *         <tt>true</tt> otherwise
    *
    * @see #isCancelled()
    * @see #onCancelled(Object)
    */
public final boolean cancel(boolean mayInterruptIfRunning) {
    mCancelled.set(true);
    return mFuture.cancel(mayInterruptIfRunning);
}

方法注释挺多的，总结起来就是：

• 若异步任务已经结束，或已经取消过了，或由于某些原因不能被取消—>返回false；
• 若异步任务还没启动，但调用了cancel()方法，那么任务永远也不会运行；
• 若异步任务已经启动了但未结束，则由mayInterruptIfRunning决定。此时参数若为true，那么当前正在执行异步任务的线程会立即中断；若为false，则等当前正在执行的异步任务完成之后再取消后面其他的异步任务。

五、AsyncTask应用场景

正如Google官方文档所说，AsyncTask只适合处理短时间的耗时操作，再根据我们前面的分析，总结如下：
- AsyncTask用于不需要进行大数据下载的简单耗时任务；
- 对磁盘读写只需要花费几毫秒的短时间操作任务。

其它情况还是用Java并发包里面的API靠谱些。