Android AsyncTask源碼解讀

時間 2019-11-30

原文原文鏈接

屢思路android

1. 初始 AsyncTask

AsyncTask 這個類的聲明以下：bash

public abstract class AsyncTask<Params, Progress, Result> {
  .....
}
複製代碼

是一個抽象類 Params 表示輸入參數的類型 Progress 表示後臺任務的執行進度 Result 表示返回結果的類型異步

2.使用

在 AsyncTask 這個類的頂部有一些代碼註釋，裏面講述瞭如何使用一個 AsyncTask,以下：ide

* <p>Here is an example of subclassing:</p>
 * <pre class="prettyprint">
 * private class DownloadFilesTask extends AsyncTask&lt;URL, Integer, Long&gt; {
 *     protected Long doInBackground(URL... urls) {
 *         int count = urls.length;
 *         long totalSize = 0;
 *         for (int i = 0; i < count; i++) {
 *             totalSize += Downloader.downloadFile(urls[i]);
 *             publishProgress((int) ((i / (float) count) * 100));
 *             // Escape early if cancel() is called
 *             if (isCancelled()) break;
 *         }
 *         return totalSize;
 *     }
 *
 *     protected void onProgressUpdate(Integer... progress) {
 *         setProgressPercent(progress[0]);
 *     }
 *
 *     protected void onPostExecute(Long result) {
 *         showDialog("Downloaded " + result + " bytes");
 *     }
 * }
 * </pre>

//user
<p>Once created, a task is executed very simply:</p>
 * <pre class="prettyprint">
 * new DownloadFilesTask().execute(url1, url2, url3);
 * </pre>
複製代碼

3. 內部重要方法

onPreExecute()

@MainThread
  protected void onPreExecute() {
   }
複製代碼

在主線程中運行，異步任務以前會被調用，通常用於作一些準備工做；oop

doInBackground()

@WorkerThread
 protected abstract Result doInBackground(Params... params);
複製代碼

在線程池中運行，此方法通常用於執行異步任務，經過publishProgress 方法來更新進度；源碼分析

onProgressUpdate()

@MainThread
    protected void onProgressUpdate(Progress... values) {
    }
複製代碼

主線程中運行，當經過publishProgress 方法調用後，onProgressUpdate() 方法會被調用；post

onPostExecute()

@MainThread
    protected void onPostExecute(Result result) {
    }
複製代碼

主線程中運行，將返回的結果展現。ui

4.源碼分析

從它的 execute 方法開始：this

@MainThread
    public final AsyncTask<Params, Progress, Result> execute(Params... params) {
      //sDefaultExecutor 定義以下，線程池
        return executeOnExecutor(sDefaultExecutor, params);
    }

private static volatile Executor sDefaultExecutor = SERIAL_EXECUTOR;
public static final Executor SERIAL_EXECUTOR = new SerialExecutor();
複製代碼

@MainThread
    public final AsyncTask<Params, Progress, Result> executeOnExecutor(Executor exec,
            Params... params) {
      //首先判斷是否是 PENDING
        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)");
            }
        }
      //將狀態設置爲 RUNNING 狀態
        mStatus = Status.RUNNING;
      //1.調用了 onPreExecute() 方法
        onPreExecute();
      //將參數封裝到 mWorker.mParams 中去了
        mWorker.mParams = params;
        //調用execute 將mFuture 傳進去了
        exec.execute(mFuture);

        return this;
    }
複製代碼

爲了弄明白總體流程，首頁要搞明白上面的 mWorker mFuture 是幹嗎的。url

mWorker

private final WorkerRunnable<Params, Result> mWorker;
//抽象類 而且實現了Callable 接口
private static abstract class WorkerRunnable<Params, Result> implements Callable<Result> {
        Params[] mParams;
    }

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

        AsyncTaskResult(AsyncTask task, Data... data) {
            mTask = task;
            mData = data;
        }
    }
}
複製代碼

//在AsyncTask 的構造方法中，分別對 mWorker, mFuture 進行了初始化
public AsyncTask(@Nullable Looper callbackLooper) {
        mHandler = callbackLooper == null || callbackLooper == Looper.getMainLooper()
            ? getMainHandler()
            : new Handler(callbackLooper);

        mWorker = new WorkerRunnable<Params, Result>() {
          //實現 了 call 方法
            public Result call() throws Exception {
              //設置調用了爲 true
                mTaskInvoked.set(true);
              //
                Result result = null;
                try {

                 //設置線程的優先級
   Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND);
                    //noinspection unchecked
                    //將 2. doInBackground的結果存儲到 result 中
                    result = doInBackground(mParams);
                    Binder.flushPendingCommands();
                } catch (Throwable tr) {
                    mCancelled.set(true);
                    throw tr;
                } finally {
                  //最後執行postResult
                    postResult(result);
                }
              //返回結果
                return result;
            }
        };

        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);
                }
            }
        };
    }
複製代碼

postResult(result) 方法

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

複製代碼

發送一條 MESSAGE_POST_RESULT 的消息，而且將result 存入到了 AsyncTaskResult中的 mData 中去了，其中 AsyncTaskResult

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

        AsyncTaskResult(AsyncTask task, Data... data) {
            mTask = task;
            mData = data;
        }
    }
複製代碼

getHandler 獲取一個 Handler ,咱們看下 handleMessage 的MESSAGE_POST_RESULT 對這條消息的處理：

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 是 AsyncTaskResult 類型，前面咱們見到過的，mTask 當時咱們傳的是 this 也就是當前的 AsyncTask ,調用finish 方法，將mData 返回的結果傳入進去，還記得咱們前面看過的嗎，將返回的結果存入AsyncTaskResult.mData中去了。

下面看下 finish方法：

private void finish(Result result) {
      //判斷是否取消，若是取消了，就不執行onPostExecute 了
        if (isCancelled()) {
            onCancelled(result);
        } else {
          //4. 就執行onPostExecute 方法了
            onPostExecute(result);
        }
      // 將狀態標誌爲 finish
        mStatus = Status.FINISHED;
    }
複製代碼

ok ，上述都是 mWorker 工做的，接下來是咱們一開始說的 mFuture

mFuture

private final FutureTask<Result> mFuture;

//初始化也是在AsyncTask 構造方法中執行的，在mWorker 之下，而且將mWorder 傳入
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);
                }
            }
        };

複製代碼

postResultIfNotInvoked(get()); 以下：

private void postResultIfNotInvoked(Result result) {
        final boolean wasTaskInvoked = mTaskInvoked.get();
      //wasTaskInvoked 爲true ,以前在 mWorker 中設置了爲true
//mWorker = new WorkerRunnable<Params, Result>() {
//            public Result call() throws Exception {
 //               mTaskInvoked.set(true);

        if (!wasTaskInvoked) {
            postResult(result);
        }
    }
複製代碼

FutureTask :

咱們知道mWorker implement Callable 接口，傳入賦值給了callable 變量
 public FutureTask(Callable<V> callable) {
        if (callable == null)
            throw new NullPointerException();
        this.callable = callable;
        this.state = NEW;       // ensure visibility of callable
    }

public void run() {
        if (state != NEW ||
            !U.compareAndSwapObject(this, RUNNER, null, Thread.currentThread()))
            return;
        try {
          //callable 變量又賦值給了 c
            Callable<V> c = callable;
            if (c != null && state == NEW) {
                V result;
                boolean ran;
                try {
                  //這裏調用c.call 實際上就是調用 mWorker.call 方法
//，由咱們上面的分析知道，在mWorker.call 方法中最終會返回 result 結果
                    result = c.call();
                    ran = true;
                } catch (Throwable ex) {
                    result = null;
                    ran = false;
                    setException(ex);
                }
                if (ran)
                    set(result);
            }
        } finally {
            // runner must be non-null until state is settled to
            // prevent concurrent calls to run()
            runner = null;
            // state must be re-read after nulling runner to prevent
            // leaked interrupts
            int s = state;
            if (s >= INTERRUPTING)
                handlePossibleCancellationInterrupt(s);
        }
    }
複製代碼

ok ，這是 mFuture,還剩下最後一個：

exec.execute(mFuture);

exec 就是 sDefaultExecutor ,其實就是 SerialExecutor,以下：

private static volatile Executor sDefaultExecutor = SERIAL_EXECUTOR;

public static final Executor SERIAL_EXECUTOR = new SerialExecutor();
複製代碼

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();
                    }
                }
            });
          //第一次確定爲null ，執行 scheduleNext
            if (mActive == null) {
                scheduleNext();
            }
        }

        protected synchronized void scheduleNext() {
          //給 mActivie 賦值，mTasks.poll 會從第一個開始取
            if ((mActive = mTasks.poll()) != null) {
                THREAD_POOL_EXECUTOR.execute(mActive);
            }
        }
    }
複製代碼

上面咱們將 mFuture 傳入，實際就是 r. mTask 是 ArrayDeque<Runnable> 姑且認爲它是這個排隊序列的吧。看下offer 方法：

/**
      插入一個 element 在隊尾
     * Inserts the specified element at the end of this deque.
     *
     * <p>This method is equivalent to {@link #offerLast}.
     *
     * @param e the element to add
     * @return {@code true} (as specified by {@link Queue#offer})
     * @throws NullPointerException if the specified element is null
     */
    public boolean offer(E e) {
        return offerLast(e);
    }
複製代碼

看註釋，也就是說是每次執行一個任務，都是在當前 deque 的隊尾開始排隊的。而且執行是串行的，由於當第二個線程過來的時候，判斷 mActive 不爲 null 將不會執行 scheduleNext.(我這個是8.0)源碼，其實在 android 3.0 以後 AsyncTask 都是採用串行執行任務的。

各個版本的不一樣以下： android 1.6以前 ------ 串行 android 1.6-3.0 之間 ----- 並行 android 3.0 以後 ----- 串行

儘管如此，咱們仍然能夠經過調用 executeOnExecutor 來並行執行任務。

ok ，回到那個 execute 方法中，咱們說調用了 r.run 實際山就是調用 mFuture.run 方法：上面咱們展現過在 mFuture.run 方法中以下：

try {
                  //這裏調用c.call 實際上就是調用 mWorker.call 方法
//，由咱們上面的分析知道，在mWorker.call 方法中最終會返回 result 結果
                    result = c.call();
                    ran = true;
                } catch (Throwable ex) {
                    result = null;
                    ran = false;
                    setException(ex);
                }
複製代碼

最終調用mWorker.call 方法，而在 mWorker.call 方法中，咱們完成一系列的任務，調用了 doInBackground onPostExecute 完成了整個的調用過程。

有的人可能已經注意到了還差一個 onProgressUpdate 方法還沒被調用，咱們知道只有調用那個 publishProgress 方法的時候才能調用 onProgressUpdate ,那下面咱們卡夏 publishProgress 方法：

@WorkerThread
    protected final void publishProgress(Progress... values) {
        //若是沒取消
        if (!isCancelled()) {
    //會發送一個 MESSAGE_POST_PROGRESS 的消息            getHandler().obtainMessage(MESSAGE_POST_PROGRESS,
                    new AsyncTaskResult<Progress>(this, values)).sendToTarget();
        }
    }
複製代碼

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://是他是他 就是他
                    //3. 調用了 onProgressUpdate 方法了
                    result.mTask.onProgressUpdate(result.mData);
                    break;
            }
        }
    }
複製代碼

會調用 AsyncTask 的 onProgressUpdate 方法了。結束。