Android 源碼解析-AsyncTask

我們都知道Android 的子線程中是不能更新UI 的（當然也不是絕對的，在初始化的某個時機是可以的，稍後會根據源碼進行分析爲什麼可以，期待吧），如果想要在子線程裏進行UI操作，就需要藉助Android的異步消息處理機制。爲了更方便的在子線程中更新UI元素，Android從1.5版本後引入了AsyncTask類，AsyncTask從本質上講,是對ThreadPool和handler的封裝，本文首先介AsyncTask的基本用法，然後解析AsynTask的成員變量，然後分析AsyncTask的整個調用流程以及AsyncTask存在的問題。本文分析的是Android API 25 中的源碼。

AsyncTask 基本用法

  public abstract class AsyncTask<Params, Progress, Result> {}

從源碼來看 AsyncTask 是一個抽象類，必須繼承後纔可以使用，繼承時需要傳三個泛型參數 Params, Progress, Result，用途如下：

1、 Params
執行時的參數，在後臺任務中使用。

2、Progress
用於界面上顯示當前的進度，Progress作爲進度單位。

3、Result
當任務執行完畢後，如果需要對結果進行返回，則使用這裏指定的泛型作爲返回值類型。

AsyncTask 中需要重寫的方法，

@MainThread
protected void onPreExecute() {}

這個方法會在後臺任務開始執行之間調用，用於進行一些界面上的初始化操作，比如顯示進度條。

protected abstract Result doInBackground(Params... params);

方法內的所有代碼在子線程中運行，可以處理所有的耗時任務。任務一旦完成就可以通過return語句來將任務的執行結果進行返回，在這個方法中是不可以進行UI操作的，如果需要更新UI元素，可以調用publishProgress(Progress…)方法。

protected void onProgressUpdate(Progress... values) {}

當在後臺任務中調用了publishProgress(Progress…)方法後，這個方法就很快會被調用，方法中攜帶的參數就是在後臺任務中傳遞過來的。在這個方法中可以對UI進行操作

protected void onPostExecute(Result result) {}

當後臺任務執行完畢並通過return語句進行返回時，這個方法就很快會被調用。

模擬一個下載任務代碼如下：

public class MainActivity extends AppCompatActivity {

    SeekBar progressBar;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        progressBar = (SeekBar) findViewById(R.id.seek_bar);
    }

    @Override
    protected void onResume() {
        super.onResume();
        new DownloadTask().execute();
    }

    private class DownloadTask extends AsyncTask<Void, Integer, Boolean> {

        @Override
        protected void onPreExecute() {
            super.onPreExecute();
        }

        @Override
        protected Boolean doInBackground(Void... params) {
            try {
                int percent = 0;
                while (true) {
                    publishProgress(percent);
                    if (percent++ > 100) {
                        break;
                    }
                    Thread.sleep(50);
                }
            } catch (Exception e) {
                e.printStackTrace();
                return false;
            }
            return true;
        }

        @Override
        protected void onProgressUpdate(Integer... values) {
            progressBar.setProgress(values[0]);
            super.onProgressUpdate(values);
        }

        @Override
        protected void onPostExecute(Boolean aBoolean) {
            if (aBoolean) {
                Toast.makeText(MainActivity.this, "Download finished", Toast.LENGTH_LONG).show();
            } else {
                Toast.makeText(MainActivity.this, "Download Error", Toast.LENGTH_LONG).show();
            }
        }
    }
}

上面的代碼模擬了一個下載任務，在doInBackground()方法中去執行具體的下載邏輯，在onProgressUpdate()方法中顯示當前的下載進度，在onPostExecute()方法中來提示任務的執行結果。AsyncTask的啓動是通過new DownloadTask().execute() 啓動的。

AsyncTask 中成員變量的解析

線程池 THREAD_POOL_EXECUTOR

// CPU 核數
private static final int CPU_COUNT = Runtime.getRuntime().availableProcessors();
// We want at least 2 threads and at most 4 threads in the core pool,
// preferring to have 1 less than the CPU count to avoid saturating
// the CPU with background work
//核心線程池，最少2個 最大4個
private static final int CORE_POOL_SIZE = Math.max(2, Math.min(CPU_COUNT - 1, 4));
// 最大線程數
private static final int MAXIMUM_POOL_SIZE = CPU_COUNT * 2 + 1;
// 非核心線程數閒置時的超時時長
private static final int KEEP_ALIVE_SECONDS = 30;
//線程工廠,爲線程池提供創建新線程的功能只有一個方法newThread(),具體實現就是創建一個thread並返回
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());
    }
};
  //線程池中的任務隊列,通過線程池的execute方法提交的Runnable對象會存儲在這個參數中,此處LinkedBlockingQueue是一個單向鏈表實現的阻塞隊列
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;

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

sDefaultExecutor (特別強調:串行)

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

這裏實現了一個串行的exectuor,這裏的實現很巧妙, 每次調用execute()方式都必然會調用scheduleNext(),
使得mTasks中的所有Runnable對象依次執行.

還有一點需要注意的是:
這裏的execute()方法的作用只是用於給任務排隊,真正執行任務的是THREAD_POOL_EXECUTOR.

然後看一下成員變量的聲明:

public static final Executor SERIAL_EXECUTOR = new SerialExecutor();

private static volatile Executor sDefaultExecutor = SERIAL_EXECUTOR;

SERIAL_EXECUTOR 唯一的作用是把SerialExecutor對象傳遞給sDefaultExecutor。

爲什麼這裏要這樣使用呢?

我覺得原因在於下面這個隱藏方法:

/** @hide */
public static void setDefaultExecutor(Executor exec) {
    sDefaultExecutor = exec;
}

也就是說AsyncTask中有一個sDefaultExecutor的默認實現,但是還提供了一個隱藏方法,可以對其進行修改.

sHandler

首先先看一個內部類的實現,這個內部類是用來包裝執行結果的,其中封裝了一個AsyncTask實例和某種類型的數據集.

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

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

InternalHandler的具體實現

private static InternalHandler sHandler;
private static final int MESSAGE_POST_RESULT = 0x1;
private static final int MESSAGE_POST_PROGRESS = 0x2;
// 單例模式
private static Handler getHandler() {
    synchronized (AsyncTask.class) {
        if (sHandler == null) {
            sHandler = new InternalHandler();
        }
        return sHandler;
    }
}
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;
        }
    }
}
private void finish(Result result) {
    if (isCancelled()) {
        onCancelled(result); //這個同樣需要用戶來實現
    } else {
        onPostExecute(result); //這個就是我們自定義AsyncTask時需要實現的onPostExecute()
    }
    mStatus = Status.FINISHED; //任務執行完成的狀態
}

onProgressUpdate,onPostExecute,onCancelled這三個回調方法會在這裏集中處理,結合AsyncTask的使用方法,我們可以得出以下結論:
在doInBackground()執行過程中或者結束後,會由該handler發送消息到主線程,調用相關回調方法,可以認爲,handler是AsyncTask整個工作流程的倒數第二站.

AsyncTask的源碼解析

首先分析的是AsyncTask 的構造函數

/**
 * Creates a new asynchronous task. This constructor must be invoked on the UI thread.
 */
public AsyncTask() {
    mWorker = new WorkerRunnable<Params, Result>() {
        public Result call() throws Exception {
            mTaskInvoked.set(true); //設置mTask已經被調用過
            Result result = null;
            try {
                Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND);
                //noinspection unchecked
                result = doInBackground(mParams); //調用doInBackground()!!!!!!!!
                Binder.flushPendingCommands();
            } catch (Throwable tr) {
                mCancelled.set(true);
                throw tr;
            } finally {
                postResult(result);
            }
            return result;
        }
    };

 //將mWorker作爲參數創建FutureTask實例
        //在mFuture實例中,將會調用mWorker做後臺任務,完成後調用done方法
    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);
            }
        }
    };
}

初始化了兩個變量，mWorker和mFuture，並在初始化mFuture的時候將mWorker作爲參數傳入。mWorker是一個Callable對象，mFuture是一個FutureTask對象，這兩個變量會暫時保存在內存中，稍後纔會用到它們。

mWorker&FutureTask

private final WorkerRunnable<Params, Result> mWorker;
private final FutureTask<Result> mFuture;

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

Callable

WorkRunnable實現了Callble接口,Callable與Runnable的功能大致相似,不同的是Callable是一個泛型接口,它有一個泛型參數V,該接口中只有一個call()方法,該方法返回類型爲V的值.
Callable可以簡單理解爲有返回值的Runnable.

@FunctionalInterface
public interface Callable<V> {
    /**
     * Computes a result, or throws an exception if unable to do so.
     *
     * @return computed result
     * @throws Exception if unable to compute a result
     */
    V call() throws Exception;
}

FutureTask

FutureTask實現了 RunnableFuture接口,而RunnableFuture繼承Runnable, Future

Future提供了對Runnable或者Callable任務的執行結果進行取消,查詢是否完成,獲取結果的操作,FutureTask是它的實現類

public interface Future<V> {

    boolean cancel(boolean mayInterruptIfRunning);

    boolean isCancelled();

    boolean isDone();

    V get() throws InterruptedException, ExecutionException;

    V get(long timeout, TimeUnit unit)throws InterruptedException, ExecutionException, TimeoutException;
}

下面是FutureTask的一個構造函數,在AsyncTask的構造函數中會使用其創建一個FutureTask實例、

public FutureTask(Callable<V> callable) {
    if (callable == null)
        throw new NullPointerException();
    this.callable = callable;
    this.state = NEW;       // ensure visibility of callable
}

分析完了構造函數，然後分析如何啓動某一個任務，調用該任務的execute()方法，我們看看 execute()方法的源碼，如下所示：

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

只有一行代碼，只是調用了executeOnExecutor()方法，我們接着進這個方法看看

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

可以看到，方法中調用了onPreExecute()方法，因此證明了onPreExecute()方法會第一個得到執行。什麼地方調用doInBackground()方法呢？我們看到調用了Executor的execute()方法，並將前面初始化的mFuture對象傳了進去，那麼這個Executor對象又是什麼呢？查看上面的execute()方法，原來是傳入了一個sDefaultExecutor變量，接着找一下這個sDefaultExecutor變量是在哪裏定義的，源碼如下所示：

private static volatile Executor sDefaultExecutor = SERIAL_EXECUTOR;
public static final Executor SERIAL_EXECUTOR = new SerialExecutor();

可以看到，這裏先new出了一個SERIAL_EXECUTOR常量，然後將這個值賦給sDefaultExecutor這個常量，也就是說明，剛纔在executeOnExecutor()方法中調用的execute()方法，其實也就是調用的SerialExecutor類中的execute()方法。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類中也有一個execute()方法，run 方法中的邏輯都是運行在子線程，方法中有個Runnalbe 參數 r， r.run() 執行的就是FutureTask類的run()方法，代碼如下

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

可以看到，改方法中調用了c.all（），那麼這個callable對象是什麼呢？其實就是在初始化mFuture對象時傳入的mWorker對象了，此時調用的call()方法，也就是一開始在AsyncTask的構造函數中指定的，代碼如下所示：

mWorker = new WorkerRunnable<Params, Result>() {
    public Result call() throws Exception {
        mTaskInvoked.set(true);
        Result result = null;
        try {
            Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND);
            //noinspection unchecked
            result = doInBackground(mParams);
            Binder.flushPendingCommands();
        } catch (Throwable tr) {
            mCancelled.set(true);
            throw tr;
        } finally {
            postResult(result);
        }
        return result;
    }
};

該方法中找到了doInBackground()方法的調用處，該方法是在子線程中運行的，所以這也就是爲什麼我們可以在doInBackground()方法中去處理耗時的邏輯。接着將doInBackground()方法返回的result傳遞給了postResult()方法，這個方法的源碼如下所示：

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

這裏使用sHandler對象發出了一條消息。這個sHandler對象是InternalHandler類的一個實例，那麼稍後這條消息在InternalHandler的handleMessage()方法中被處理。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;
        }
    }
}

handleMessage 中對消息類型進行了判斷，如果這是一條MESSAGE_POST_RESULT消息，會執行finish()方法，如果是一條MESSAGE_POST_PROGRESS消息，就會去執行onProgressUpdate()方法。
因爲InternalHandler 是一個靜態類它不會持有外部類的引用，也不能調用外部類的方法，因此在發消息的時候傳入了 msg.obj 即 AsyncTaskResult,
AsyncTaskResult 中有一個屬性 mTask 就是 AsyncTask 本身因此就可以調用外部方法
finish() 方法的源碼如下

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

如果當前任務被取消掉了，就會調用onCancelled()方法，如果沒有被取消，則調用onPostExecute()方法，這樣當前任務的執行就全部結束了。
InternalHandler的handleMessage()方法裏，還有一種MESSAGE_POST_PROGRESS的消息類型，這種消息是用於當前進度的，查看publishProgress()方法的源碼，如下所示：

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

到這裏源碼已經分析完了。

AsyncTask的各種坑

1、在Activity中定義AsyncTask導致內存泄漏
由於AsyncTask是Activity的內部類，所以會持有外部的一個引用，如果Activity已經退出，但是AsyncTask還沒有執行完畢，那麼Activity就無法釋放導致內存泄漏。對於這個問題我們可以把AsyncTask定義爲靜態內部類並且採用弱引用。
2、各版本對AsyncTask的實現不一樣
對於這個問題，可以自己擴展一下AsyncTask在其內部也對版本做出判斷，對於不同版本做一些不同的處理。
3、不能及時取消任務
以4.4版本雙核手機爲例，如果用戶在A界面發起5個任務，由於使用SerialExecutor來執行任務，那麼任務將一個一個順序執行，由於第一個任務執行時間過長，其他任務只能在隊列中等待，導致阻塞，所以可以考慮把執行時間較短的任務優先加入。如果在第一個任務執行過程中，用戶跳轉到了B界面，而A界面發起的任務已經沒有必要執行，所以我們要在Activity的生命週期結束的時候取消掉任務。如果任務沒取消掉，B界面又發起新的任務，就會導致B界面的所有請求阻塞。如果有需要我們可以直接使用executeOnExecutor方法，然後直接使用THREAD_POOL_EXECUTOR線程池來執行，這樣可以3個線程同時執行，並且在doInBackground方法中判斷任務是否被取消，這樣可以提高效率。
4、曾經缺陷
以前對於缺陷的答案可能是：AsyncTask在併發執行多個任務時發生異常。其實還是存在的，在3.0以前的系統中還是會以支持多線程併發的方式執行，128，阻塞隊列可以存放10個；也就是同時執行138個任務是沒有問題的；而超過138會馬上出現java.util.concurrent.RejectedExecutionException；
而在在3.0以上包括3.0的系統中會爲單線程執行；

Android 源碼解析-AsyncTask

AsyncTask 基本用法

AsyncTask 中成員變量的解析

線程池 THREAD_POOL_EXECUTOR

sDefaultExecutor (特別強調:串行)

sHandler

AsyncTask的源碼解析

首先分析的是AsyncTask 的構造函數

mWorker&FutureTask

Callable

FutureTask

AsyncTask的各種坑

Android 應用性能優化--資源圖片的內存管理

Android Service的生命週期

Android多線程斷點續傳原理解析

Android 源碼解析-AsyncTask

Java 對象克隆(clone)

Mac下配置sublime實現LaTeX

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結