Java线程池中,需要实现带有返回值的线程任务接口需要实现Callable接口,在线程池ThreadPoolExecutor中采用submit()方法返回得到线程与返回值的容器FutureTask,用以完成对该线程的各种操作。
ThreadPoolExecutor继承自AbstractExecutorService,而具体的submit()方法实现就在AbstractExecutorService中。
public <T> Future<T> submit(Callable<T> task) {
if (task == null) throw new NullPointerException();
RunnableFuture<T> ftask = newTaskFor(task);
execute(ftask);
return ftask;
}
在这段代码中,调用了newTaskFor()来完成将callable交给一个RunnableFuture(FutureTask实现了在这一接口)作为容器来管理线程状态及其返回值。
protected <T> RunnableFuture<T> newTaskFor(Callable<T> callable) {
return new FutureTask<T>(callable);
}
直接在其中调用了FutureTask的构造方法,将要实现的callable作为参数传入。
public FutureTask(Callable<V> callable) {
if (callable == null)
throw new NullPointerException();
this.callable = callable;
this.state = NEW;
}
这里直接将FutureTask的callable设置为了传进来的callable对象,并且将状态设置为了new。可以直接看一下FutureTask的成员对象。
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;
以上是FutureTask的状态量。
New状态表示该FutureTask刚刚初始化完毕,FutureTask中的线程任务并没有开始执行。
Completing状态表示该FutureTask的线程任务执行完毕,返回值正在设置当中。
Normal状态表示该容器的线程任务已经结束,可以顺利取得返回值。
Exceptional状态表示该线程任务执行中由于出现异常而中断。
Cancelled状态表示该线程在还没有具体执行就由调用者调用cancel()方法中断。
Interrupting状态表示该线程任务在执行过程中被中断。
Interrupted状态表示该线程已经被中断。
private Callable<V> callable;
private Object outcome;
private volatile Thread runner;
private volatile WaitNode waiters;
从上到下分别为FutureTask中所要执行的callable,准备向外部提供的任务执行完毕后的返回值,具体执行任务的线程,以及等待取得返回值的线程阻塞堆栈。
在上面的代码中,可以看到在FutureTask的构造方法中callable已经被设置,同时状态也已经被设置为New状态。那么在回到线程池的submit()方法中线程池也成功得到了FutureTask,那么接下来就调用了execute()方法,将FutrueTask跟别的普通线程任务一样的方式调用execute()方法交给线程池处理,并将得到的FutureTask返回给调用submit()的调用者。既然FutureTask作为线程任务交由线程池处理,那么一定实现了Runnable接口,也想必实现了相应的run()方法。
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);
}
}
在FutureTask的run()方法的一开始先判断状态是不是为刚初始化完毕的new状态,否则将不执行。同样的,通过unsafe将FutureTask的线程对象设置为正在执行的该条线程(一般是线程池正在调用这个方法的工作线程),在检察完毕这两段之后才会执行。
接下里就会直接调用callable也就是我们的具体带返回值的任务的call()方法。如果在调用call()中抛出了异常将会直接在这里捕获,调用setException()方法来完成相关变量的设置。
protected void setException(Throwable t) {
if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
outcome = t;
UNSAFE.putOrderedInt(this, stateOffset, EXCEPTIONAL); // final state
finishCompletion();
}
}
先将容器状态改为Completing,之后将容器中保存的返回值改为所抛出的异常,接下来的所有get操作都将会返回这个异常,然后将状态改为Exceptional状态,也将是这个容器的最终状态,最后调用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;
}
依次将等待堆栈里的get线程依次从挂起中恢复,然后依次将等待队列中的节点置null以便回收,这样FutureTask中的任务遇到异常的流程就结束了。
相应的回到run()方法,如果在执行call()方法中一切顺利没有遇到异常成功取到了返回值呢?将会调用set()方法直接将call()的返回值设置在容器中以便外部调用get方法以便外部顺利取得返回值。
protected void set(V v) {
if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
outcome = v;
UNSAFE.putOrderedInt(this, stateOffset, NORMAL); // final state
finishCompletion();
}
}
在这里唯一和setException()方法的区别在于将容器的Completing状态变成了Normal状态。相应的,finishCompletion()这里的动作更多了一份唤醒由于返回值没有准备好而阻塞的get线程以便取得想要的返回值的意味。
外部通过get()方法来试图取得返回值。get()方法有两种实现方式,由于调用了get()方法的线程会由于返回值还没有准备好在此处阻塞,所以存在设置timeout和不设置timeout的两种实现方式。
public V get() throws InterruptedException, ExecutionException {
int s = state;
if (s <= COMPLETING)
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;
if (s <= COMPLETING &&
(s = awaitDone(true, unit.toNanos(timeout))) <= COMPLETING)
throw new TimeoutException();
return report(s);
}
两者首先都需要判断线程任务是否已经执行完毕(小于等于Completing状态),已经执行完毕,则直接通过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);
}
很简单的对返回值进行了类型处理就返回了。
那么如果在调用get()方法的时候容器还处于New状态或者Completing状态呢,那么将会调用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)
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);
}
}
传入的boolean参数timed表示是否存在timeout,如果为true,则nanos表示线程等待最久的时间。
在该方法中WaitNode表示该线程在等待堆栈中的节点。Boolean的queue表示该线程是否已经处于等待堆栈中。
首先判断容器的状态是否有已经结束,如果已经结束,那直接就返回。
接下来判容器的状态是否处于Completing,如果是则通过yield()降低当前线程优先级,以便执行run()方法的能够尽快将返回值设置好,以便在接下里的循环中顺利返回。
接下来由于前两个判断,此时线程任务肯定还没有执行完毕,所以判断是否判断了等待节点,如果没有,直接创建。
static final class WaitNode {
volatile Thread thread;
volatile WaitNode next;
WaitNode() { thread = Thread.currentThread(); }
}
在创建完毕等待节点的前提下,若下一次循环线程任务还没有执行完毕,那么将该等待节点放入等待队列当中。
此时,进行节点的时间超时判断(在传入参数timed为true的情况下),并给线程挂起相应的时间,如果在这里的挂起被恢复回到这里将会由于超时而返回。
在上面一系列的判断完毕之后(timed为false),get线程将会直接被挂起,在线程任务执行完毕后,一次性将等待堆栈里的节点全部唤醒,在下一次循环中由于容器状态改变而返回。