Android開發AsyncTask原始碼分析【模板方法模式】

王世暉發表於2016-05-19
Android原始碼模式

模板方法介紹

模板方法定義了一個演算法的框架，將框架中一些步驟延遲到子類中實現，使子類可以不修改一個演算法的框架結構就可以重定義框架的某些步驟。模板方法實際上是封裝一個固定的流程，流程的步驟在抽象類中已經定義好了，子類可以有不同的演算法實現，這樣就可以在框架流程不修改的情況下實現某下演算法的替換

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)方法，這是第三個固定步驟

相關文章