1、核心对象
- 为 2 个线程池 + Handler
类 | 作用 |
---|
THREAD_POOL_EXECUTOR | 执行耗时任务线程池 |
SERIAL_EXECUTOR | 执行并行任务线程池 |
InternalHandler | 消息传递 |
2、工作原理
- AsyncTask 初始化
- AsyncTask 执行
3、源码分析
// 抽象类,Params 传入参数,Progress 执行进度,Result 返回结果。不需要传 Void。
public abstract class AsyncTask<Params, Progress, Result> {
// THREAD_POOL_EXECUTOR 配置参数
// CPU 核心数。
private static final int CPU_COUNT = Runtime.getRuntime().availableProcessors();
// 线程池的核心线程数 2-4,最大值和 CPU 核心数有关。
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;
// 线程工厂
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());
}
};
// 存储任务的队列为 LinkedBlockingQueue 最大容量为 128。
private static final BlockingQueue<Runnable> sPoolWorkQueue =
new LinkedBlockingQueue<Runnable>(128);
// 执行耗时任务线程池
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;
}
// 执行并行任务线程池
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;
// 消息传递
private static InternalHandler sHandler;
// 耗时任务
private final WorkerRunnable<Params, Result> mWorker;
// 可获取结果异步任务
private final FutureTask<Result> mFuture;
private volatile Status mStatus = Status.PENDING;
private final AtomicBoolean mCancelled = new AtomicBoolean();
private final AtomicBoolean mTaskInvoked = new AtomicBoolean();
private final Handler mHandler;
private static class SerialExecutor implements Executor {
// 1.一个双向队列
final ArrayDeque<Runnable> mTasks = new ArrayDeque<Runnable>();
Runnable mActive;
// 2.synchronized 保证元素串行执行。
public synchronized void execute(final Runnable r) {
// 2.1 向队列中加一个新任务。
mTasks.offer(new Runnable() {
public void run() {
try {
r.run();
} finally {
// 2.2 执行一个新任务。
scheduleNext();
}
}
});
// 2.2 执行一个新任务。
if (mActive == null) {
scheduleNext();
}
}
// 取出队列头部任务,THREAD_POOL_EXECUTOR 执行任务。
protected synchronized void scheduleNext() {
if ((mActive = mTasks.poll()) != null) {
THREAD_POOL_EXECUTOR.execute(mActive);
}
}
}
// 一个任务只能执行一次,PENDING 未执行,RUNNING 正在执行,FINISHED,执行完成。
public enum Status {
PENDING,
RUNNING,
FINISHED,
}
// 注:Handler 绑定主线程 Looper,AsyncTask 必须在主线程创建,执行。
private static Handler getMainHandler() {
synchronized (AsyncTask.class) {
if (sHandler == null) {
sHandler = new InternalHandler(Looper.getMainLooper());
}
return sHandler;
}
}
private Handler getHandler() {
return mHandler;
}
/** @hide */
public static void setDefaultExecutor(Executor exec) {
sDefaultExecutor = exec;
}
public AsyncTask() {
this((Looper) null);
}
// AsyncTask 必须在 UI 线程创建。
public AsyncTask(@Nullable Handler handler) {
this(handler != null ? handler.getLooper() : null);
}
public AsyncTask(@Nullable Looper callbackLooper) {
// 1、初始化 Handler。
mHandler = callbackLooper == null || callbackLooper == Looper.getMainLooper()
? getMainHandler()
: new Handler(callbackLooper);
// 2、初始化 WorkerRunnable,一个 Callable 对象。
mWorker = new WorkerRunnable<Params, Result>() {
public Result call() throws Exception {
mTaskInvoked.set(true);
Result result = null;
try {
Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND);
// 2.1 执行耗时操作。
result = doInBackground(mParams);
Binder.flushPendingCommands();
} catch (Throwable tr) {
// 2.2 执行异常,设置取消标志。
mCancelled.set(true);
throw tr;
} finally {
// 2.3 执行结束。
postResult(result);
}
return result;
}
};
// 3、初始化 FutureTask。
mFuture = new FutureTask<Result>(mWorker) {
// 3.1 Callable 执行完,调用 done 方法。检查任务,将未被调用的任务的结果通过 InternalHandler 发送给 UI 线程。
@Override
protected void done() {
try {
// 3.2 发送未被调用的任务的 Result。
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) {
// 3.3 执行异常,发送未被调用的任务的 null。
postResultIfNotInvoked(null);
}
}
};
}
private void postResultIfNotInvoked(Result result) {
final boolean wasTaskInvoked = mTaskInvoked.get();
if (!wasTaskInvoked) {
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;
}
public final Status getStatus() {
return mStatus;
}
@WorkerThread
protected abstract Result doInBackground(Params... params);
@MainThread
protected void onPreExecute() {
}
@MainThread
protected void onPostExecute(Result result) {
}
// 调用 publishProgress 方法执行。
@MainThread
protected void onProgressUpdate(Progress... values) {
}
@MainThread
protected void onCancelled(Result result) {
onCancelled();
}
@MainThread
protected void onCancelled() {
}
public final boolean isCancelled() {
return mCancelled.get();
}
// 设置为取消状态,取消任务执行。onCancelled 方法将被调用。
public final boolean cancel(boolean mayInterruptIfRunning) {
mCancelled.set(true);
return mFuture.cancel(mayInterruptIfRunning);
}
public final Result get() throws InterruptedException, ExecutionException {
return mFuture.get();
}
public final Result get(long timeout, TimeUnit unit) throws InterruptedException,
ExecutionException, TimeoutException {
return mFuture.get(timeout, unit);
}
// 执行异步任务。
@MainThread
public final AsyncTask<Params, Progress, Result> execute(Params... params) {
return executeOnExecutor(sDefaultExecutor, params);
}
@MainThread
public final AsyncTask<Params, Progress, Result> executeOnExecutor(Executor exec,
Params... params) {
// 1.AsyncTask 重复执行将抛出异常。
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)");
}
}
// 2.AsyncTask 设置为 RUNNING 状态。
mStatus = Status.RUNNING;
// 3.主线程初始化工作。
onPreExecute();
// 4.传入参数给工作线程。
mWorker.mParams = params;
// 5.SERIAL_EXECUTOR 执行任务。
exec.execute(mFuture);
return this;
}
@MainThread
public static void execute(Runnable runnable) {
sDefaultExecutor.execute(runnable);
}
// 调用 publishProgress,执行 onProgressUpdate。
@WorkerThread
protected final void publishProgress(Progress... values) {
if (!isCancelled()) {
getHandler().obtainMessage(MESSAGE_POST_PROGRESS,
new AsyncTaskResult<Progress>(this, values)).sendToTarget();
}
}
private void finish(Result result) {
if (isCancelled()) {
onCancelled(result);
} else {
onPostExecute(result);
}
mStatus = Status.FINISHED;
}
// InternalHandler 消息传递
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;
}
}
}
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;
}
}
}