Java FutureTask<V> 源码分析 Android上的实现

FutureTask类提供了可取消的异步计算，并且可以利用开始和取消计算的方法、查询计算是否完成的方法和获取计算结果的方法。

首先看一下继承关系

public class FutureTask<V> implements RunnableFuture<V>

public interface RunnableFuture<V> extends Runnable, Future<V> {
    void run();
}

FutureTask -> RunnableFuture -> Runnable,Future  Runnable我们都知道就不说了，主要看一下Future接口。

public interface Future<V> {

    //试图取消对此任务的执行。
    boolean cancel(boolean mayInterruptIfRunning);

    //如果在任务正常完成前将其取消，则返回 true。
    boolean isCancelled();

    //如果任务已完成，则返回 true。
    boolean isDone();

    //如有必要，等待计算完成，然后获取其结果。
    V get() throws InterruptedException, ExecutionException;

    //如有必要，最多等待为使计算完成所给定的时间之后，获取其结果（如果结果可用）。
    V get(long timeout, TimeUnit unit)
        throws InterruptedException, ExecutionException, TimeoutException;
}

也就是说当FutureTask的实例被一个线程执行以后，我们可以对它进行控制，比如终止任务，查询任务是否完成，获取结果等。

public class FutureTask<V> implements RunnableFuture<V> {

    /**
     * 这个类可能的几种过度状态
     * NEW -> COMPLETING -> NORMAL  新建-正在完成-正常完成
     * NEW -> COMPLETING -> EXCEPTIONAL 新建-正在完成-异常
     * NEW -> CANCELLED 新建-取消
     * NEW -> INTERRUPTING -> INTERRUPTED 新建-正在中断线程-已经中断
     */
    private volatile int state; //当前状态 注意volatile，因为这个类是为多线程使用而设计的
    private static final int NEW          = 0;
    private static final int COMPLETING   = 1;
    private static final int NORMAL       = 2;
    private static final int EXCEPTIONAL  = 3;
    private static final int CANCELLED    = 4;
    private static final int INTERRUPTING = 5;
    private static final int INTERRUPTED  = 6;

    /** 用于执行任务并且返回结果 */
    private Callable<V> callable;
    /** 用于存放返回结果 另外如果出现异常那么就存放异常的引用 */
    private Object outcome; // non-volatile, protected by state reads/writes
    /** 当前执行该类的线程 */
    private volatile Thread runner;
    /** 等待锁队节点 */
    private volatile WaitNode waiters;

    /**
     * 根据state的值，判断任务是否正常完成。
     *
     * @param s 当前的状态值
     */
    @SuppressWarnings("unchecked")
    private V report(int s) throws ExecutionException {
        Object x = outcome;
        //如果状态为NORMAL 则正常返回结果。
        if (s == NORMAL)
            return (V)x;
        //如果状态>=CANCELLED 则抛出一个异常CancellationException 告诉用户任务已经终止。
        if (s >= CANCELLED)
            throw new CancellationException();
        //否则就是任务执行过程中出现异常，包装一下直接抛出。
        throw new ExecutionException((Throwable)x);
    }

    /**
     * 构造参数 传入callable对象，并且将当前状态state设置为null。
     */
    public FutureTask(Callable<V> callable) {
        if (callable == null)
            throw new NullPointerException();
        this.callable = callable;
        this.state = NEW;       // ensure visibility of callable
    }

    /**
     * 传入runnable对象和result
     * 通过Executors包装一下，还是返回一个callable的实例
     * 在执行完runnable的任务后直接返回result
     */
    public FutureTask(Runnable runnable, V result) {
        this.callable = Executors.callable(runnable, result);
        this.state = NEW;       // ensure visibility of callable
    }

    /*
     * 判断任务是否取消
     */
    public boolean isCancelled() {
        return state >= CANCELLED;
    }

    /*
     * 如果任务已完成，则返回 true。 
     * 可能由于正常终止、异常或取消而完成，在所有这些情况中，此方法都将返回 true。 
     */
    public boolean isDone() {
        return state != NEW;
    }

    /**
     * 取消任务
     * mayInterruptIfRunning 如果应该中断执行此任务的线程，则为 true；否则允许正在运行的任务运行完成 
     */
    public boolean cancel(boolean mayInterruptIfRunning) {
        //如果当前状态不是新创建时的状态 那么返回false
        //这种情况说明任务已经执行，那么当前状态的值就有俩种情况。
        //一种是任务正常完成 那么当前状态将的值会按照这个方向执行 NEW -> COMPLETING -> NORMAL
        //一种任务是执行中出现异常 那么当前状态的值会按照这个方向执行 NEW -> COMPLETING -> EXCEPTIONAL
        if (state != NEW)
            return false;
        
        if (mayInterruptIfRunning) {
            //设置当前状态为INTERRUPTING(正在设置线程的中断状态)
            if (!UNSAFE.compareAndSwapInt(this, stateOffset, NEW, INTERRUPTING))
                return false;
            Thread t = runner;
            if (t != null)
                //设置线程的中断状态
                t.interrupt();
            //设置当前状态为INTERRUPTED
            UNSAFE.putOrderedInt(this, stateOffset, INTERRUPTED); // final state
        }
        //如果当前状态为NEW 那么会把当前状态设置为 CANCELLED 然后调用finishCompletion，然后返回成功
        else if (!UNSAFE.compareAndSwapInt(this, stateOffset, NEW, CANCELLED))
            return false;
        //这个方法下面解释
        finishCompletion();
        return true;
    }

    /**
     * 获取任务的结果，如果任务未完成则线程进入等待状态。
     */
    public V get() throws InterruptedException, ExecutionException {
        int s = state;
        //如果任务未完成
        if (s <= COMPLETING)
            //等待完成 里面的是实现是等待队列
            s = awaitDone(false, 0L);
        //调用report方法来根据情况返回结果
        return report(s);
    }

    /**
     * 最多等待为使计算完成所给定的时间之后，获取其结果。
     */
    public V get(long timeout, TimeUnit unit)
        throws InterruptedException, ExecutionException, TimeoutException {
        if (unit == null)
            throw new NullPointerException();
        int s = state;
        //如果超时任务未能完成就抛出TimeoutException
        if (s <= COMPLETING &&
            (s = awaitDone(true, unit.toNanos(timeout))) <= COMPLETING)
            throw new TimeoutException();
        //调用report方法来根据情况返回结果
        return report(s);
    }

    /**
     * 给子类扩展的方法，state状态发生改变时被调用。
     */
    protected void done() { }

    protected void set(V v) {
        //将状态先设置为COMPLETING正在完成，然后再设置为正常NORMAL
        if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
            outcome = v;
            UNSAFE.putOrderedInt(this, stateOffset, NORMAL); // final state
            //然后调用完成方法
            finishCompletion();
        }
    }

    protected void setException(Throwable t) {
        //将状态先设置为COMPLETING正在完成，然后再设置为异常EXCEPTIONAL
        if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
            outcome = t;
            UNSAFE.putOrderedInt(this, stateOffset, EXCEPTIONAL); // final state
            //然后调用完成方法
            finishCompletion();
        }
    }

    //任务开始方法
    public void run() {
        //任务不能多个线程同时运行。
        //如果第一次运行将runner设置为当前执行的线程。
        if (state != NEW ||
            !UNSAFE.compareAndSwapObject(this, runnerOffset,
                                         null, Thread.currentThread()))
            return;
        try {
            Callable<V> c = callable;
            if (c != null && state == NEW) {
                V result;
                boolean ran;
                try {
                    result = c.call();
                    //任务正常完成 也就是没有出现异常，那么ran=true
                    ran = true;
                } catch (Throwable ex) {
                    //出现异常就调用setException方法，将状态state设置为EXCEPTIONAL
                    result = null;
                    ran = false;
                    setException(ex);
                }
                //如果上面任务正常完成则调用set方法，那么将状态state设置为NORMAL
                if (ran)
                    set(result);
            }
        } finally {
            runner = null;
            int s = state;
            //这里要判断一下，任务是否被取消过。
            if (s >= INTERRUPTING)
                handlePossibleCancellationInterrupt(s);
        }
    }

    /**
     * Executes the computation without setting its result, and then
     * resets this future to initial state, failing to do so if the
     * computation encounters an exception or is cancelled.  This is
     * designed for use with tasks that intrinsically execute more
     * than once.
     *
     * @return true if successfully run and reset
     */
    protected boolean runAndReset() {
        if (state != NEW ||
            !UNSAFE.compareAndSwapObject(this, runnerOffset,
                                         null, Thread.currentThread()))
            return false;
        boolean ran = false;
        int s = state;
        try {
            Callable<V> c = callable;
            if (c != null && s == NEW) {
                try {
                    c.call(); // don't set result
                    ran = true;
                } catch (Throwable ex) {
                    setException(ex);
                }
            }
        } 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
            s = state;
            if (s >= INTERRUPTING)
                handlePossibleCancellationInterrupt(s);
        }
        return ran && s == NEW;
    }

    /**
     * 如果其他线程正在中午该任务，那么运行该任务的线程就暂时让出CPU时间
     * 一直到state=INTERRUPTED为止。
     */
    private void handlePossibleCancellationInterrupt(int s) {

        if (s == INTERRUPTING)
            while (state == INTERRUPTING)
                Thread.yield(); // wait out pending interrupt
    }

    /**
     * Simple linked list nodes to record waiting threads in a Treiber
     * stack.  See other classes such as Phaser and SynchronousQueue
     * for more detailed explanation.
     */
    static final class WaitNode {
        volatile Thread thread;
        volatile WaitNode next;
        WaitNode() { thread = Thread.currentThread(); }
    }

    /**
     * 解锁所有等待队列当中的线程，让他们调用done方法。
     */
    private void finishCompletion() {
        // assert state > COMPLETING;
        for (WaitNode q; (q = waiters) != null;) {
            if (UNSAFE.compareAndSwapObject(this, waitersOffset, q, null)) {
                for (;;) {
                    Thread t = q.thread;
                    if (t != null) {
                        q.thread = null;
                        LockSupport.unpark(t);
                    }
                    WaitNode next = q.next;
                    if (next == null)
                        break;
                    q.next = null; // unlink to help gc
                    q = next;
                }
                break;
            }
        }

        done();

        callable = null;        // to reduce footprint
    }

    /**
     * 等待任务完成，在get方法中最后会调用到这里
     */
    private int awaitDone(boolean timed, long nanos)
        throws InterruptedException {
        //计算一下需要等待的时间，有可能为0，为0的话就无限期等待。
        final long deadline = timed ? System.nanoTime() + nanos : 0L;
        //一个等待节点
        WaitNode q = null;
        //是否加入队列
        boolean queued = false;
        for (;;) {
            //如果当且调用get方法的线程被interrupt 那么就把当前线程从等待队列remove
            //然后抛出异常
            if (Thread.interrupted()) {
                removeWaiter(q);
                throw new InterruptedException();
            }
            int s = state;
            //如果任务已经完成 不管是被暂停了 还是出现异常了 只要状态大于COMPLETING就返回。
            if (s > COMPLETING) {
                if (q != null)
                    q.thread = null;
                return s;
            }
            else if (s == COMPLETING) // cannot time out yet
            //如果任务正在完成中(注意是ING进行时) 那么让出一会CPU时间在继续执行
                Thread.yield();
            else if (q == null)
                //创建等待节点
                q = new WaitNode();
            else if (!queued)
                //第一次创建的等待节点需要加入等待队列，这里加入队列等待。
                queued = UNSAFE.compareAndSwapObject(this, waitersOffset,
                                                     q.next = waiters, q);
            else if (timed) {
                //如果设置了等待 那么就得锁住线程等待，如果时间到了就返回状态。
                //方法 public V get(long timeout, TimeUnit unit) 这里会根据状态做后续处理。
                nanos = deadline - System.nanoTime();
                if (nanos <= 0L) {
                    removeWaiter(q);
                    return state;
                }
                LockSupport.parkNanos(this, nanos);
            }
            else
                //否则锁住线程等待其他线程解锁。
                LockSupport.park(this);
        }
    }

    /**
     * 这里就是循环线程队列，将当前等待节点remove掉
     */
    private void removeWaiter(WaitNode node) {
        if (node != null) {
            node.thread = null;
            retry:
            for (;;) {          // restart on removeWaiter race
                for (WaitNode pred = null, q = waiters, s; q != null; q = s) {
                    s = q.next;
                    if (q.thread != null)
                        pred = q;
                    else if (pred != null) {
                        pred.next = s;
                        if (pred.thread == null) // check for race
                            continue retry;
                    }
                    else if (!UNSAFE.compareAndSwapObject(this, waitersOffset,
                                                          q, s))
                        continue retry;
                }
                break;
            }
        }
    }

    // Unsafe mechanics
    private static final sun.misc.Unsafe UNSAFE;
    private static final long stateOffset;
    private static final long runnerOffset;
    private static final long waitersOffset;
    static {
        try {
            UNSAFE = sun.misc.Unsafe.getUnsafe();
            Class<?> k = FutureTask.class;
            stateOffset = UNSAFE.objectFieldOffset
                (k.getDeclaredField("state"));
            runnerOffset = UNSAFE.objectFieldOffset
                (k.getDeclaredField("runner"));
            waitersOffset = UNSAFE.objectFieldOffset
                (k.getDeclaredField("waiters"));
        } catch (Exception e) {
            throw new Error(e);
        }
    }

}

由此可见此类的设计还是非常复杂的，不得不佩服老外们的逻辑思维能力，相当的缜密，上面一些关于状态的转换过程还是比较复杂的，

因为要考虑到多线程的情况，还要考虑到状态转换时的线程安全问题等等。具体奥妙还的自己分析源码慢慢体会。