Android开发AsyncTask源码分析【模板方法模式】

模板方法介绍

模板方法定义了一个算法的框架，将框架中一些步骤延迟到子类中实现，使子类可以不修改一个算法的框架结构就可以重定义框架的某些步骤。模板方法实际上是封装一个固定的流程，流程的步骤在抽象类中已经定义好了，子类可以有不同的算法实现，这样就可以在框架流程不修改的情况下实现某下算法的替换

AsyncTask的模板方法

使用AsyncTask，只要构造AsyncTask对象，然后调用execute方法即可。execute方法封装了一个固定的流程，子类不可以修改这个方法，所以execute方法为final的，不可以被重写。因为AsyncTask只是抽象封装了固定的流程，具体的步骤实现由子类决定，所以AsyncTask类定义为抽象类。调用execute后会触发固定流程，分别是onPreExecute、doInBackground、onPostExecute。这些步骤的具体实现必须由子类决定，但是执行的顺序时机已经由模板方法定好了，子类不能够更改。

protected abstract Result doInBackground(Params… params);
protected void onPreExecute() {}
protected void onPostExecute(Result result) {}
protected void onProgressUpdate(Progress… values) {

AsyncTask源码分析

execute方法封装了固定的流程，必须调用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();

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

        return this;
    }

executeOnExecutor方法首先检查了异步任务的状态，异步任务只能执行一次，所以RUNNING状态和FINISHED状态调用execute方法非法，抛出异常。
通过了上述状态检查后，设置异步任务状态为RUNNING，然后调用onPreExecute方法，进行一些准备工作，这是第一个固定步骤。
然后将execute方法传递进来的参数传递给mWorker，mWorker是一个WorkerRunnable，实现了Callable接口，封装了参数。（暂时不管，下文会分析道）

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

mWorker的初始化是在构造函数中初始化的

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

在任务处理的call方法中调用了Result result = doInBackground(mParams);这里mWorker只是定义线程任务，还未得到执行，如果得到执行的话，会调用doInBackground方法，这是第二个固定步骤，接下来就会看到mWorker如何被放到线程池得到执行
在给mWorker设定了参数后，executeOnExecutor方法接着调用线程池的execute方法

exec.execute(mFuture);

exec是executeOnExecutor方法参数传递进来的线程池对象sDefaultExecutor，sDefaultExecutor主要负责任务的排队

private static volatile Executor sDefaultExecutor = SERIAL_EXECUTOR;

public static final Executor SERIAL_EXECUTOR = new SerialExecutor();

这里可以看到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) {
            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内部使用一个ArrayDeque来管理多个任务，ArrayDeque 双向顺序存储，集成栈和队列方法，访问快，插入和删除慢。调用SerialExecutor的execute(final Runnable r)方法的时候，就是把任务r添加到了ArrayDeque队列的尾部，然后调用scheduleNext()方法，scheduleNext()方法从ArrayDeque队列头部取出一个Runnable任务，丢进THREAD_POOL_EXECUTOR线程池执行。
从上面的代码可以看到SerialExecutor只负责任务的排队，THREAD_POOL_EXECUTOR才是真正的线程池

public static final Executor THREAD_POOL_EXECUTOR
            = new ThreadPoolExecutor(CORE_POOL_SIZE, MAXIMUM_POOL_SIZE, KEEP_ALIVE,
                    TimeUnit.SECONDS, sPoolWorkQueue, sThreadFactory);

    private static final int CPU_COUNT = Runtime.getRuntime().availableProcessors();
    private static final int CORE_POOL_SIZE = CPU_COUNT + 1;
    private static final int MAXIMUM_POOL_SIZE = CPU_COUNT * 2 + 1;
    private static final int KEEP_ALIVE = 1;

AsyncTask内部多任务操作是通过ThreadPoolExecutor线程池实现的，THREAD_POOL_EXECUTOR线程池是一个核心线程数等于CPU核数，非核心线程数等于CPU核数+1，线程池容量等于CPU核数*2+1，空线程超时1秒关闭空线程的线程池。

---

回到AsyncTask的executeOnExecutor方法，最后有两句

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

这两句跨度比较大，需要找到从mWorker到mFuture转换的地方，在AsyncTask构造函数里边对mFuture进行了定义

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

这样把mWorker传递了进来，mWorker实现了callable接口，封装了executor方法传递进来的参数，因此mWorker实际上是一个callable，FutureTask执行完毕的时候会回调done方法，在done方法里边通过get获取到线程的执行结果，然后传递给 postResultIfNotInvoked(get());

---

---

---

exec.execute(mFuture);

这里是把mFuture加入线程池处理，mFuture包装了一个callable，这个callable就是mWorker，因此线程池中处理的任务就是mWorker的call方法

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

---

---

---

    private void postResultIfNotInvoked(Result result) {
        final boolean wasTaskInvoked = mTaskInvoked.get();
        if (!wasTaskInvoked) {
            postResult(result);
        }
    }

postResult方法中通过Handler的obtainMessage获取一个消息

Message obtainMessage(int what, Object obj)
设置此Message的what字段为MESSAGE_POST_RESULT，obj字段为new AsyncTaskResult(this, result) 对象

    private static class AsyncTaskResult<Data> {
        final AsyncTask mTask;
        final Data[] mData;

        AsyncTaskResult(AsyncTask task, Data... data) {
            mTask = task;
            mData = data;
        }
    }

AsyncTaskResult对象封装了AsyncTask对象和泛型不定长参数，该参数可以表示消息处理最终结果或者消息处理进度值

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

这样就把计算结果送到了handler所在的线程，该handler所在的线程是UI线程。getHandler方法是用单例模式创建了一个InternalHandler

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

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绑定的是UI线程

super(Looper.getMainLooper());

如果处理的消息的what字段是MESSAGE_POST_RESULT，表示任务完成，那么应该调用onPostExecute才对。这里先获取Message对象的obj字段，该字段保存的是AsyncTaskResult

    private static class AsyncTaskResult<Data> {
        final AsyncTask mTask;
        final Data[] mData;

        AsyncTaskResult(AsyncTask task, Data... data) {
            mTask = task;
            mData = data;
        }
    }

因此在消息处理方法中调用了mTask（AsyncTask）的finish方法

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

如果该任务未取消的话就会回调onPostExecute(result)方法，任务已经取消了的话就回调onCancelled(result)方法，这是第三个固定步骤