高度优化AsyncTask

在使用AsyncTask的时候我们可以看到几个明显的缺陷和问题：

• 主要针对UI线程；
• 无法处理异常情况；
• 线程池里面维护的线程数量过多（CORE_POOL_SIZE默认是5个）；

所以针对以上弊端，我重写了该类，希望对大家有所帮助，另外如有不如意的地方，还请大家指正：

package com.isomobile.toollib;


import android.content.Context;
import android.os.Handler;
import android.os.Message;
import android.os.Process;

import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.ThreadFactory;
import java.util.concurrent.Callable;
import java.util.concurrent.FutureTask;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeoutException;
import java.util.concurrent.CancellationException;
import java.util.concurrent.atomic.AtomicInteger;

/**
 * <p>UserTask是一个为了提高应用性能和能够处理各种异常的一个能运行在前后台的线程池框架.</p>
 * 
 * <p>UserTask运行在后台，可以只处理后台数据，也可以将后台数据展现在前台UI界面上。
 * UserTask定义了3个泛型参数，分别是： <code>Params</code>, <code>Progress</code> 和 <code>Result</code>
 * 
 * <h2>使用</h2>
 * <p>1.在使用UserTask的时候，首先是实现一个继承它的类. 子类至少需要override
 * ({@link #onErrorHandle})和({@link #onTaskFinished}.)</p>
 * 
 * <p>下面是创建子类的例子:</p>
 * <pre class="prettyprint">
 * private final class DownloadTaskManager extends UserTask<Integer, Integer, Boolean> {
 *    protected void onErrorHandle(Context context, Exception error) {
 *        mLog.debug("onErrorHandle : " + error.getMessage());
 *    }
 *
 *    protected void onTaskFinished(Context context, Boolean result) {
 *         
 *    }
 * }
 * </pre>
 * 
 * 接着需要在调用继承实现的子类对象的registerCallback方法里面去添加任务。
 * <pre class="prettyprint">
 * final DownloadTaskManager manager = new DownloadTaskManager();
 *       //final FileDownloader downloader = new FileDownloader(DownloadService.this);
 *       manager.registerCallback(new TaskCallback() {
 *           public Object call(UserTask task, Integer[] params) throws Exception {
 *                //需要后台的操作
 *          }
 *        });
 * </pre>
 */
public abstract class UserTask<Params, Progress, Result> {
    
    /** The Constant CORE_POOL_SIZE. */
    private static final int CORE_POOL_SIZE = 2;
    
    /** The Constant MAXIMUM_POOL_SIZE. */
    private static final int MAXIMUM_POOL_SIZE = 32;
    
    /** The Constant KEEP_ALIVE. */
    private static final int KEEP_ALIVE = 15;

    /** The Constant mWorkQueue. */
    private static final BlockingQueue<Runnable> mWorkQueue =
            new LinkedBlockingQueue<Runnable>(MAXIMUM_POOL_SIZE);

    /** The Constant mThreadFactory. */
    private static final ThreadFactory mThreadFactory = new ThreadFactory() {
        private final AtomicInteger mCount = new AtomicInteger(1);

        public Thread newThread(Runnable r) {
            return new Thread(r, "UserTask #" + mCount.getAndIncrement());
        }
    };

    /** The Constant mExecutor. */
    private static final ThreadPoolExecutor mExecutor = new ThreadPoolExecutor(CORE_POOL_SIZE,
            MAXIMUM_POOL_SIZE, KEEP_ALIVE, TimeUnit.SECONDS, mWorkQueue, mThreadFactory);

    /** The Constant MESSAGE_POST_RESULT. */
    private static final int MESSAGE_POST_RESULT = 0x1;
    
    /** The Constant MESSAGE_POST_PROGRESS. */
    private static final int MESSAGE_POST_PROGRESS = 0x2;
    
    /** The Constant MESSAGE_POST_CANCEL. */
    private static final int MESSAGE_POST_CANCEL = 0x3;

    /** The Constant mHandler. */
    private static final InternalHandler mHandler = new InternalHandler();

    /** The m worker. */
    private final WorkerRunnable<Params, Result> mWorker;
    
    /** The m future. */
    private final FutureTask<Result> mFuture;

    /** The m status. */
    private volatile Status mStatus = Status.PENDING;
    
    /** The m error. */
    protected Exception mError;
    
    
    /** The m callbask. */
    private TaskCallback<Params, Progress, Result> mCallback;
    
    private Context mContext;
    
    /**
     * Indicates the current status of the task. Each status will be set only once
     * during the lifetime of a task.
     */
    public enum Status {
        /**
         * Indicates that the task has not been executed yet.
         */
        PENDING,
        /**
         * Indicates that the task is running.
         */
        RUNNING,
        /**
         * Indicates that {@link UserTask#onTaskFinished} has finished.
         */
        FINISHED,
    }

    /**
     * UserTask的构造函数.
     *
     */
    public UserTask() {
        mWorker = new WorkerRunnable<Params, Result>() {
            public Result call() throws Exception {
                Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND);
                return onBackgroundExecute(mParams);
            }
        };

        mFuture = new FutureTask<Result>(mWorker) {
            @Override
            protected void done() {
                Message message;
                Result result = null;

                try {
                    result = get();
                } catch (InterruptedException e) {
                } catch (ExecutionException e) {
                    throw new RuntimeException("An error occured while executing doInBackground()",
                            e.getCause());
                } catch (CancellationException e) {
                    message = mHandler.obtainMessage(MESSAGE_POST_CANCEL,
                            new UserTaskResult<Result>(UserTask.this, (Result[]) null));
                    message.sendToTarget();
                    return;
                } catch (Throwable t) {
                    throw new RuntimeException("An error occured while executing "
                            + "doInBackground()", t);
                }

                //if(result == null) return; //赵小刚：If the result is null, return.
                message = mHandler.obtainMessage(MESSAGE_POST_RESULT,
                        new UserTaskResult<Result>(UserTask.this, result));
                message.sendToTarget();
            }
        };
    }
    
    /**
     * UserTask的构造函数.
     *
     */
    public UserTask(Context context) {
        mContext = context;
        mWorker = new WorkerRunnable<Params, Result>() {
            public Result call() throws Exception {
                Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND);
                return onBackgroundExecute(mParams);
            }
        };

        mFuture = new FutureTask<Result>(mWorker) {
            @Override
            protected void done() {
                Message message;
                Result result = null;

                try {
                    result = get();
                } catch (InterruptedException e) {
                } catch (ExecutionException e) {
                    throw new RuntimeException("An error occured while executing doInBackground()",
                            e.getCause());
                } catch (CancellationException e) {
                    message = mHandler.obtainMessage(MESSAGE_POST_CANCEL,
                            new UserTaskResult<Result>(UserTask.this, (Result[]) null));
                    message.sendToTarget();
                    return;
                } catch (Throwable t) {
                    throw new RuntimeException("An error occured while executing "
                            + "doInBackground()", t);
                }

                //if(result == null) return; //赵小刚：If the result is null, return.
                message = mHandler.obtainMessage(MESSAGE_POST_RESULT,
                        new UserTaskResult<Result>(UserTask.this, result));
                message.sendToTarget();
            }
        };
    }

    /**
     *返回当前任务的状态.
     *
     * @return The current status.
     */
    public final Status getStatus() {
        return mStatus;
    }

    /**
     * 注册任务回调方法.
     *
     * @param callback the callback
     */
    public void registerCallback(TaskCallback<Params, Progress, Result> callback) {
        this.mCallback = callback;
    }
    
    /**
     * Override this method to perform a computation on a background thread. The
     * specified parameters are the parameters passed to {@link #execute}
     * by the caller of this task.
     *
     * This method can call {@link #publishProgress} to publish updates
     * on the thread.
     *
     * @param params The parameters of the task.
     *
     * @return A result, defined by the subclass of this task.
     *
     * @see #onPreExecute()
     * @see #onPostExecute
     * @see #publishProgress
     */
    protected  Result onBackgroundExecute(Params... params) {
        Result result = null;
        try {
            result = onCallbackExecute(params);
        } catch (Exception e) {
            this.mError = e;
        }
        return result;
    }

    /**
     * Override to perform computation in a background thread.
     *
     * @param params the params
     * @return the result
     * @throws Exception the exception
     */
    protected Result onCallbackExecute(Params... params) throws Exception {
        return mCallback.call(UserTask.this, params);
    }
    
    /**
     * Runs in the thread if there was an exception throw from onCallbackExecute.
     *
     * @param error The thrown exception.
     */
    protected abstract void onErrorHandle(Context context, Exception error);
    
    /**
     * A replacement for onPostExecute. Runs in the thread after onCallbackExecute returns.
     *
     * @param result The result returned from onCallbackExecute
     */
    protected abstract void onTaskFinished(Context context, Result result);
    
    /**
     * 在 {@link #onBackgroundExecute}之前执行.
     *
     * @see #onTaskPrepare
     * @see #onBackgroundExecute
     */
    protected void onTaskPrepare() {
    }

    /**
     * 本方法在{@link #onBackgroundExecute}之后执行. The
     * specified result is the value returned by {@link #onBackgroundExecute}
     * or null if the task was cancelled or an exception occured.
     *
     * @param result The result of the operation computed by {@link #onBackgroundExecute}.
     *
     * @see #onPreExecute
     * @see #onBackgroundExecute
     */
    @SuppressWarnings({"UnusedDeclaration"})
    protected void onPostExecute(Result result) {
        if (onTaskFailed()) {
            onErrorHandle(mContext, mError);
        } else {
            onTaskFinished(mContext, result);
        }
    }

    /**
     * 本方法的执行需要在在{@link #publishProgress}被调用之后.
     * The specified values are the values passed to {@link #publishProgress}.
     *
     * @param values The values indicating progress.
     *
     * @see #publishProgress
     * @see #onBackgroundExecute
     */
    @SuppressWarnings({"UnusedDeclaration"})
    protected void onProgressUpdate(Progress... values) {
    }
    
    /**
     * Has an exception been thrown inside doCheckedInBackground().
     *
     * @return true, if successful
     */
    protected boolean onTaskFailed() {
        return mError != null;
    }

    /**
     * 在{@link #cancel(boolean)}被执行之后才能执行本方法.
     *
     * @see #cancel(boolean)
     * @see #isCancelled()
     */
    protected void onCancelled() {
    }

    /**
     * Returns <tt>true</tt> if this task was cancelled before it completed
     * normally.
     *
     * @return <tt>true</tt> if task was cancelled before it completed
     *
     * @see #cancel(boolean)
     */
    public final boolean isCancelled() {
        return mFuture.isCancelled();
    }

    /**
     * Attempts to cancel execution of this task.  This attempt will
     * fail if the task has already completed, already been cancelled,
     * or could not be cancelled for some other reason. If successful,
     * and this task has not started when <tt>cancel</tt> is called,
     * this task should never run.  If the task has already started,
     * then the <tt>mayInterruptIfRunning</tt> parameter determines
     * whether the thread executing this task should be interrupted in
     * an attempt to stop the task.
     *
     * @param mayInterruptIfRunning <tt>true</tt> if the thread executing this
     *        task should be interrupted; otherwise, in-progress tasks are allowed
     *        to complete.
     *
     * @return <tt>false</tt> if the task could not be cancelled,
     *         typically because it has already completed normally;
     *         <tt>true</tt> otherwise
     *
     * @see #isCancelled()
     * @see #onCancelled()
     */
    public final boolean cancel(boolean mayInterruptIfRunning) {
        return mFuture.cancel(mayInterruptIfRunning);
    }

    /**
     * Waits if necessary for the computation to complete, and then
     * retrieves its result.
     *
     * @return The computed result.
     * @throws InterruptedException If the current thread was interrupted
     * while waiting.
     * @throws ExecutionException If the computation threw an exception.
     */
    public final Result get() throws InterruptedException, ExecutionException {
        return mFuture.get();
    }

    /**
     * Waits if necessary for at most the given time for the computation
     * to complete, and then retrieves its result.
     *
     * @param timeout Time to wait before cancelling the operation.
     * @param unit The time unit for the timeout.
     * @return The computed result.
     * @throws InterruptedException If the current thread was interrupted
     * while waiting.
     * @throws ExecutionException If the computation threw an exception.
     * @throws TimeoutException If the wait timed out.
     */
    public final Result get(long timeout, TimeUnit unit) throws InterruptedException,
            ExecutionException, TimeoutException {
        return mFuture.get(timeout, unit);
    }

    /**
     * execute方法返回自己(this),因此调用者可以保存它的引用
     * 
     * 该方法可以在任何一个地方执行
     *
     * @param params The parameters of the task.
     * @return This instance of UserTask.
     * {@link UserTask.Status#RUNNING} or {@link UserTask.Status#FINISHED}.
     */
    public final UserTask<Params, Progress, Result> execute(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;

        onTaskPrepare();

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

        return this;
    }

    /**
     * This method can be invoked from {@link #onBackgroundExecute} to
     * publish updates on the thread while the background computation is
     * still running. Each call to this method will trigger the execution of
     *
     * @param values The progress values to update the result.
     * {@link #onProgressUpdate}
     * @see #onProgressUpdate
     * @see #onBackgroundExecute
     */
    public final void publishProgress(Progress... values) {
        mHandler.obtainMessage(MESSAGE_POST_PROGRESS,
                new UserTaskResult<Progress>(this, values)).sendToTarget();
    }

    /**
     * Finish.
     *
     * @param result the result
     */
    private void finish(Result result) {
        if (isCancelled()) result = null;
        onPostExecute(result);
        mStatus = Status.FINISHED;
    }

    /**
     * The Class InternalHandler.
     */
    private static class InternalHandler extends Handler {
        
        /* (non-Javadoc)
         * @see android.os.Handler#handleMessage(android.os.Message)
         */
        @SuppressWarnings({"unchecked", "RawUseOfParameterizedType"})
        public void handleMessage(Message msg) {
            UserTaskResult result = (UserTaskResult) 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;
                case MESSAGE_POST_CANCEL:
                    result.mTask.onCancelled();
                    break;
            }
        }
    }

    /**
     * The Class WorkerRunnable.
     *
     * @param <Params> the generic type
     * @param <Result> the generic type
     */
     private static abstract class WorkerRunnable<Params, Result> implements Callable<Result> {
        
        /** The m params. */
        Params[] mParams;
    }

    /**
     * The Class UserTaskResult.
     *
     * @param <Data> the generic type
     */
    @SuppressWarnings({"RawUseOfParameterizedType", "unchecked"})
    private static class UserTaskResult<Data> {
        
        /** The m task. */
        final UserTask mTask;
        
        /** The m data. */
        final Data[] mData;
        
        /**
         * UserTaskResult的构造函数
         *
         * @param task the task
         * @param data the data
         */
        UserTaskResult(UserTask task, Data... data) {
            mTask = task;
            mData = data;
        }
    }
    
    /**
     * TaskCallback接口用于实现UserTask的registerCallback方法.
     *
     * @param <Params> the generic type
     * @param <Progress> the generic type
     * @param <Result> the generic type
     */
    public interface TaskCallback<Params, Progress, Result> {
        
        /**
         * 耗时操作都放在在call方法里面
         *
         * @param task the task
         * @return the result
         * @throws AppException the app exception
         */
        public Result call(UserTask<Params, Progress, Result> task, Params[] params) throws Exception;
    }
}

下面是一个使用该类的实例：

public class MainActivity extends Activity {
    /** Called when the activity is first created. */
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.main);
        
        handlePrinter();
    }
    
    private void handlePrinter() {
        final PrinterTask task =  new PrinterTask(this);
        task.registerCallback(new TaskCallback<Integer, Void, Integer>() {
            @Override
            public Integer call(UserTask<Integer, Void, Integer> task, Integer[] params)
                    throws Exception {
                final int time = params[0];
                android.util.Log.d("TAG", String.valueOf(time));
                SystemClock.sleep(time);
                return 0;
            }
        });
        
        task.execute(5000);
    }
    
    
    private class PrinterTask extends UserTask<Integer, Void, Integer>{
        
        public PrinterTask(Context context) {
            super(context);
        }

        @Override
        protected void onTaskPrepare() {
            // TODO Auto-generated method stub
            super.onTaskPrepare();
        }

        @Override
        protected void onErrorHandle(Context context, Exception error) {
            // TODO Auto-generated method stub
            
        }

        @Override
        protected void onTaskFinished(Context context, Integer result) {
            Toast.makeText(context, "5s", Toast.LENGTH_SHORT).show();
            
        }
        
    }
}