// 提交Callable类型任务
<T> Future<T> submit(Callable<T> task);
// 提交Runnable类型任务,预先知道返回值
<T> Future<T> submit(Runnable task, T result);
// 提交Runnable类型任务,对返回值无感知
Future<?> submit(Runnable task);
ExecutorService接口的扩展方法都是返回Future相关的实例。java.util.concurrent.Future,代表着一次异步计算的结果,它提供了检查计算是否已经完成、等待计算完成、获取计算结果等一系列方法。笔者之前强调过:线程池ThreadPoolExecutor的顶级接口Executor只提供了一个无状态的返回值类型为void的execute(Runnable command)方法,无法感知异步任务执行的完成时间和获取任务计算结果。如果我们需要感知异步任务执行的返回值或者计算结果,就必须提供带返回值的接口方法去承载计算结果的操作。而Future就是一个担任了承载计算结果(包括结果值、状态、阻塞等待获取结果操作等)的工具。
featuretask 源码
// 状态
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;
// 底层的Callable实现,执行完毕后需要置为null
private Callable<V> callable;
// 输出结果,如果是正常执行完成,get()方法会返回此结果,如果是异常执行完成,get()方法会抛出outcome包装为ExecutionException的异常
private Object outcome;
// 真正的执行Callable对象的线程实例,运行期间通过CAS操作此线程实例
private volatile Thread runner;
// 等待线程集合,Treiber Stack实现
private volatile WaitNode waiters;
// 下面是变量句柄,底层是基于Unsafe实现,通过相对顶层的操作原语,如CAS等
private static final VarHandle STATE;
private static final VarHandle RUNNER;
private static final VarHandle WAITERS;
static {
try {
MethodHandles.Lookup l = MethodHandles.lookup();
STATE = l.findVarHandle(FutureTask.class, "state", int.class);
RUNNER = l.findVarHandle(FutureTask.class, "runner", Thread.class);
WAITERS = l.findVarHandle(FutureTask.class, "waiters", WaitNode.class);
} catch (ReflectiveOperationException e) {
throw new ExceptionInInitializerError(e);
}
// Reduce the risk of rare disastrous classloading in first call to
// LockSupport.park: https://bugs.openjdk.java.net/browse/JDK-8074773
Class<?> ensureLoaded = LockSupport.class;
}
// ... 省略其他代码
### 适配器模式
// 适配使用Callable类型任务的场景
public FutureTask(Callable<V> callable) {
if (callable == null)
throw new NullPointerException();
this.callable = callable;
this.state = NEW;
}
// 适配使用Runnable类型任务和已经提供了最终计算结果的场景
public FutureTask(Runnable runnable, V result) {
this.callable = Executors.callable(runnable, result);
this.state = NEW;
}
// Executors中
public static <T> Callable<T> callable(Runnable task, T result) {
if (task == null)
throw new NullPointerException();
return new RunnableAdapter<T>(task, result);
}
// Runnable和Callable的适配器,设计十分巧妙,实际上run()方法委托给传入的Runnable实例执行,实现了Callable的call()方法,使用的是外部传入的值作为返回结果
private static final class RunnableAdapter<T> implements Callable<T> {
private final Runnable task;
private final T result;
RunnableAdapter(Runnable task, T result) {
this.task = task;
this.result = result;
}
public T call() {
task.run();
return result;
}
public String toString() {
return super.toString() + "[Wrapped task = " + task + "]";
}
}
- 这里看一下重写的run方法
// FutureTask实现的Runnable#run()方法
public void run() {
// 如果状态不为NEW(0)或者CAS(null,当前线程实例)更新runner-真正的执行Callable对象的线程实例失败,那么直接返回,不执行任务
if (state != NEW ||
!RUNNER.compareAndSet(this, null, Thread.currentThread()))
return;
try {
// 获取Callable任务实例赋值到临时变量c
Callable<V> c = callable;
// 判断任务不能为空,二次校验状态必须为NEW(0)
if (c != null && state == NEW) {
V result;
boolean ran;
try {
// 调用任务实例Callable#call()方法,正常情况下的执行完毕,没有抛出异常,则记录执行结果
result = c.call();
// 记录正常执行完毕
ran = true;
} catch (Throwable ex) {
// 异常情况下的执行完毕,执行结果记录为null
result = null;
// 记录异常执行完毕
ran = false;
// 设置异常实例
setException(ex);
}
// 正常执行完毕设置结果
if (ran)
set(result);
}
} finally {
// runner更新为null,防止并发执行run()方法
runner = null;
// 记录新的状态值,因为run()方法执行的时候,状态值有可能被其他方法更新了
int s = state;
if (s >= INTERRUPTING)
// 处理run()方法执行期间调用了cancel(true)方法的情况
handlePossibleCancellationInterrupt(s);
}
}
// 异常执行挖鼻的情况下,设置异常实例
protected void setException(Throwable t) {
// CAS更新状态state,由NEW(0)更新为COMPLETING(1)
if (STATE.compareAndSet(this, NEW, COMPLETING)) {
// 设置异常实例到outcome属性中
outcome = t;
// 设置最终状态state = EXCEPTIONAL(3),意味着任务最终异常执行完毕
STATE.setRelease(this, EXCEPTIONAL); // final state
// 完成后的通知方法
finishCompletion();
}
}
// 完成任务后的通知方法,最要作用是移除和唤醒所有的等待结果线程,调用钩子方法done()和设置任务实例callable为null
private void finishCompletion() {
// 遍历栈,终止条件是下一个元素为null
for (WaitNode q; (q = waiters) != null;) {
// CAS设置栈顶为null
if (WAITERS.weakCompareAndSet(this, q, null)) {
// 遍历栈中的所有节点,唤醒节点中的线程,这是一个十分常规的遍历单链表的方法,注意几点:
// 1. 使用LockSupport.unpark()唤醒线程,因为后面会分析,线程阻塞等待的时候使用的是LockSupport.park()方法
// 2. 断开链表节点的时候后继节点需要置为null,这样游离节点才能更容易被JVM回收
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(),这个可以通过子类进行扩展
done();
// 置任务实例callable为null,从而减少JVM memory footprint(这个东西有兴趣可以自行扩展阅读)
callable = null; // to reduce footprint
}
// 正常执行完毕的情况下设置执行结果
protected void set(V v) {
// CAS更新状态state,由NEW(0)更新为COMPLETING(1)
if (STATE.compareAndSet(this, NEW, COMPLETING)) {
// 最终执行结果值更新到outcome中
outcome = v;
// 设置最终状态state = NORMAL(2),意味着任务最终正常执行完毕
STATE.setRelease(this, NORMAL);
// 完成后的通知方法
finishCompletion();
}
}
// 处理run()方法执行期间调用了cancel(true)方法的情况
// 这里还没分析cancel()方法,但是可以提前告知:它会先把状态更新为INTERRUPTING,再进行线程中断,最后更新状态为INTERRUPTED
// 所以如果发现当前状态为INTERRUPTING,当前线程需要让出CPU控制权等待到状态更变为INTERRUPTED即可,这个时间应该十分短暂
private void handlePossibleCancellationInterrupt(int s) {
if (s == INTERRUPTING)
while (state == INTERRUPTING)
Thread.yield();
}
// 钩子方法,可以通过子类扩展此方法,方法回调的时机是任务已经执行完毕,阻塞获取结果的线程被唤醒之后
protected void done() {
}
- get 获取结果
// 获取执行结果 - 永久阻塞
public V get() throws InterruptedException, ExecutionException {
int s = state;
// 如果状态小于等于COMPLETING(1),也就是COMPLETING(1)和NEW(0),那么就需要等待任务完成
if (s <= COMPLETING)
// 注意这里调用awaitDone方法的参数为永久阻塞参数,也就是没有超时期限,返回最新的状态值
s = awaitDone(false, 0L);
// 根据状态值报告结果
return report(s);
}
// 获取执行结果 - 带超时的阻塞
public V get(long timeout, TimeUnit unit)
throws InterruptedException, ExecutionException, TimeoutException {
if (unit == null)
throw new NullPointerException();
int s = state;
// 如果状态小于等于COMPLETING(1),也就是COMPLETING(1)和NEW(0),那么就需要等待任务完成
// 注意这里调用awaitDone方法的参数为带超时上限的阻塞参数
// 如果超过了指定的等待期限(注意会把时间转化为纳秒),返回的最新状态依然为COMPLETING(1)或者NEW(0),那么抛出TimeoutException异常
if (s <= COMPLETING &&
(s = awaitDone(true, unit.toNanos(timeout))) <= COMPLETING)
throw new TimeoutException();
// 根据状态值报告结果
return report(s);
}