Java——FutureTask原理

Java——FutureTask原理

1. 分享目的

在Java异步多线程领域中，当既需要异步执行，又需要获取异步执行的结果时，Future接口从而诞生。而FutureTask是Future的其中一种实现，通过分享FutureTask的原理给大家提供一种获取异步执行结果的实现思路，当我们遇到适合的场景时，可以自定义实现Future接口来满足场景需要。比如在Redisson框架中的RFuture，Netty中的Future\Promise.

2. 代码分析

1. FutureTask的简单使用

FutureTask<String> task = new FutureTask<>(new Callable<String>() {
    @Override
    public String call() throws Exception {
        TimeUnit.SECONDS.sleep(2);
        return "Tarzan写bug";
    }
});

new Thread(task).start();

System.out.println(task.get());

FutureTask有Callable或Runnable为参数的构造方法，分别代表有返回值和无返回值。然后创建新线程或放入线程池中执行，最后通过FutureTask.get()阻塞主线程获取异步线程结果。

2. FutureTask.run()

FutureTask可以直接放入Thread或线程池中，可以看出其实现了Runnable结果，顾名思义可以从run()入手

// 当前的任务状态，由于状态的实时性，所以用了volatile
private volatile int state;
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 Object outcome;

public void run() {
    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;
            } catch (Throwable ex) {
                result = null;
                ran = false;
                setException(ex);
            }
            if (ran)
                set(result);
        }
    } finally {
        runner = null;
        int s = state;
        if (s >= INTERRUPTING)
            handlePossibleCancellationInterrupt(s);
    }
}

protected void set(V v) {
    if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
        outcome = v;
        UNSAFE.putOrderedInt(this, stateOffset, NORMAL); // final state
        finishCompletion();
    }
}

private void finishCompletion() {
    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;
                q = next;
            }
            break;
        }
    }

    done();

    callable = null;
}

方法逻辑：

1. 判断任务状态是否是NEW；
2. 调用Callable.call()执行任务，得到结果result；
3. 将结果保存到outcome变量中，并更新状态为COMPLETING；
4. 调用LockSupport.unpark()唤醒线程，用于后面的get().

3. FutureTask.get()

看看get()是如何阻塞获取异步任务结果的

public V get() throws InterruptedException, ExecutionException {
    int s = state;
    if (s <= COMPLETING)
        s = awaitDone(false, 0L);
    return report(s);
}

private int awaitDone(boolean timed, long nanos)
    throws InterruptedException {
    final long deadline = timed ? System.nanoTime() + nanos : 0L;
    WaitNode q = null;
    boolean queued = false;
    for (;;) {
        if (Thread.interrupted()) {
            removeWaiter(q);
            throw new InterruptedException();
        }

        int s = state;
        if (s > COMPLETING) {
            if (q != null)
                q.thread = null;
            return s;
        }
        else if (s == COMPLETING) // cannot time out yet
            Thread.yield();
        else if (q == null)
            q = new WaitNode();
        else if (!queued)
            queued = UNSAFE.compareAndSwapObject(this, waitersOffset,
                                                 q.next = waiters, q);
        else if (timed) {
            nanos = deadline - System.nanoTime();
            if (nanos <= 0L) {
                removeWaiter(q);
                return state;
            }
            LockSupport.parkNanos(this, nanos);
        }
        else
            LockSupport.park(this);
    }
}

private V report(int s) throws ExecutionException {
    Object x = outcome;
    if (s == NORMAL)
        return (V)x;
    if (s >= CANCELLED)
        throw new CancellationException();
    throw new ExecutionException((Throwable)x);
}

阻塞等待逻辑在awaitDone()中，该方法逻辑：

1. 声明一个自旋循环；
2. 循环中判断任务状态state是否等于COMPLETING；
3. 等于COMPLETING的话则跳出循环，不等于的话通过LockSupport.park()进行阻塞线程，与任务完成时的LockSupport.unpark()相呼应。如果是有时间限制的get(long timeout, TimeUnit unit)，则使用LockSupport.parkNanos()进行固定时间阻塞。

阻塞完后通过report()返回异步任务的结果。

3. 总结

FutureTask通过LockSupport的park()/unpark()进行阻塞异步线程获取结果，还可以通过wait()\notifyAll()来实现。

世界那么大，感谢遇见，未来可期…

欢迎同频共振的那一部分人

作者公众号：Tarzan写bug