Java并发编程之Future与FutureTask
Java并发编程之Future与FutureTask
简述
我们都知道实现异步可以通过Runnable接口来实现，但是Runnable接口是无法获取任务的返回值的，如果需要获取到任务的返回值，那么就需要利用Future机制了。
Future是一个接口，它制订了规范，它规定了如何获取任务的结果，如何取消任务，以及获取任务的状态等操作。在Netty，Redisson，Spring当中都有相关的实现类，用来处理异步请求的结果。当然在JUC中也有相关的实现类，比如FutureTask和CompletableFuture。接下来我们就通过分析FutureTask类来进一步了解Future。
Future提供的api
1.cancel()
用来取消任务，如果取消任务成功则返回true，如果取消任务失败则返回false
2.isCancelled()
用来判断任务是否已经被取消，如果已经取消返回true，否则返回false
3.isDone()
用来判断任务是否已经完成，完成返回true，否则返回false。
4.get()
用来获取任务的返回结果，如果任务还没有结果，那么就会阻塞，直到任务结束获取到结果
5.get(long timeout, TimeUnit unit)
也是用来获取任务的返回结果的，如果任务还没有结果，那么就会阻塞，但是如果没有在指定的时间内获取到结果，线程就会被唤醒并且抛出TimeoutException。
接下来我们分析Future的实现类FutureTask，来进一步了解Future。
FutureTask的简单使用
我们首先看看FutureTask是如何使用的，然后再分析FutureTask的实现原理。FutureTask需结合callable进行使用。
例：
@Test
void contextLoads() throws ExecutionException, InterruptedException {
FutureTask<Integer> future = new FutureTask<>(new TestCallable());
new Thread(future).start();
Integer integer = future.get();
System.out.println(integer);
}
}
class TestCallable implements Callable<Integer> {
@Override
public Integer call() throws Exception {
return 0;
}
}FutureTask原理分析
1.FutureTask的继承关系
首先FutureTask实现了RunnableFuture接口，而RunnableFuture接口又是Runnable接口和Future的子接口。
public class FutureTask<V> implements RunnableFuture<V> {}public interface RunnableFuture<V> extends Runnable, Future<V> {}2.FutureTask的成员变量
//保存需要执行的callable任务
private Callable<V> callable;
//用于保存callable任务的结果
private Object outcome; // non-volatile, protected by state reads/writes
/** The thread running the callable; CASed during run() */
//保存执行callable任务的线程 取消任务的时候需要用到 哪个线程执行的任务，就需要中断哪个线程
private volatile Thread runner;
/** Treiber stack of waiting threads */
//一个链表 用于保存等待获取任务结果的线程
private volatile WaitNode waiters;
//保存state runner waiters三个属性的内存偏移量 之后CAS操作需要用到，保证线程安全
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);
}
}接下来我们看它的构造函数，需要传递一个Callable，在构造函数中会把传进来的Callable保存到成员变量中，并且初始化FutureTask的状态为NEW状态。
public FutureTask(Callable<V> callable) {
if (callable == null)
throw new NullPointerException();
this.callable = callable;
this.state = NEW; // ensure visibility of callable
}FutureTask的状态有以下几个状态
//新生状态
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;3.FutureTask的源码分析
FutureTask实现了Runnable接口，以线程的方式启动，所以我们接下来看FutureTask的run()方法。
run()
首先利用CAS将当前线程赋值给runner属性，保存执行任务的线程，然后调用callable任务的call()方法执行任务，执行成功之后调用set()方法将结果保存起来。如果执行出现异常则调用setException()方法进行异常处理。
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 {
//执行callable的call()方法
result = c.call();
ran = true;
} catch (Throwable ex) {
//如果出现异常，那么就将状态设置为EXCEPTIONAL
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);
}
}set()
这个方法会将callable返回的结果保存到outcome成员变量中，并且将状态扭转为NORMAL，然后将等待中的线程全部唤醒。
protected void set(V v) {
// 先将状态设置为COMPLETING
if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
// 将任务的结果保存到outcome成员变量中
outcome = v;
//最后将状态设置为NORMAL
UNSAFE.putOrderedInt(this, stateOffset, NORMAL); // final state
//唤醒正在等待的节点
finishCompletion();
}
}finishCompletion()
finishCompletion()方法逻辑很简单，for循环调用LockSupport.unpark()方法唤醒所有被阻塞的线程。（所有被get()方法阻塞的线程都需要被唤醒）
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
}setException()
当任务执行出现异常时，会调用setException()方法进行异常处理，首先将状态扭转为COMPLETING，然后将异常保存到outcome成员变量中，再将状态修改为EXCEPTIONAL，最后还需要调用finishCompletion()方法唤醒所有阻塞的线程。
protected void setException(Throwable t) {
//通过cas保证线程安全
if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
outcome = t;
UNSAFE.putOrderedInt(this, stateOffset, EXCEPTIONAL); // final state
finishCompletion();
}
}接下来我们看get()方法
public V get() throws InterruptedException, ExecutionException {
int s = state;
//如果任务还没有执行完成，那么需要阻塞线程 等待结果
if (s <= COMPLETING)
s = awaitDone(false, 0L);
//如果已经执行完成，那么获取到结果
return report(s);
}awaitDone()
awaitDone()方法的作用是在获取到任务的结果之前将线程进行阻塞，直到超时或者任务执行完成后才被唤醒。
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
//任务正在执行 ，那么先让出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) {
//如果有时间限制，那么需要调用unpark阻塞线程指定时间
nanos = deadline - System.nanoTime();
if (nanos <= 0L) {
//如果已经
removeWaiter(q);
return state;
}
LockSupport.parkNanos(this, nanos);
}
else
//没有时间限制，那么直接阻塞 等待被唤醒
LockSupport.park(this);
}
}report()
report()的作用是返回任务的结果。只有在正常完成任务的状态下才会返回任务的返回值，否则会抛出异常。
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);
}接下来看FutureTask是如何实现cancel()方法来取消任务
cancel()
cancel()方法用于实现任务的取消，首先获取到执行任务的线程，调用线程的interrupt()方法中断线程，然后通过cas操作将FutureTask的状态修改为INTERRUPTED，并且调用finishCompletion()方法唤醒所有被阻塞的线程。（finishCompletion()在前文已经进行分析，这里就不在过多赘述）。
public boolean cancel(boolean mayInterruptIfRunning) {
if (!(state == NEW &&
UNSAFE.compareAndSwapInt(this, stateOffset, NEW,
mayInterruptIfRunning ? INTERRUPTING : CANCELLED)))
return false;
try { // in case call to interrupt throws exception
if (mayInterruptIfRunning) {
try {
//获取到执行任务的线程 调用interrupt()方法中断线程
Thread t = runner;
if (t != null)
t.interrupt();
} finally { // final state
//cas操作将FutureTask的状态修改为INTERRUPTED
UNSAFE.putOrderedInt(this, stateOffset, INTERRUPTED);
}
}
} finally {
//唤醒被阻塞的线程
finishCompletion();
}
return true;
}最后
至此，FutureTask的源码我们就大致分析完了，相信通过本文，你对Future与FutureTask的理解又更深了一步。如果有任何疑问，欢迎在下方评论区留言。