JDKのFutureソース解析
24388 ワード
zJDKのFutureモードでは、Futureに関するAPIがあります。インターフェースCallable：戻り結果があり、異常なタスクを投げ出す可能性があります。インターフェースRunnable：戻りませんでした。結果インターフェースFuture：非同期実行の結果を表します。クラスFutureTask：Future、Runnableなどのインターフェースを実現することは、非同期的に実行されるタスクです。直接実行することができます。またはCallableに包装して実行します。
1.lable/Runnable
java.lang.Runnableインターフェースは一つのrun方法だけを宣言しました。
Futureとは、具体的なRunnableまたはCallableタスクの実行結果をキャンセルし、完了したかどうか調べ、結果を得ることです。必要に応じてget方法で実行結果を取得できます。この方法はタスクが結果を返すまでブロックされます。java.util.co ncurrent.Futureインターフェース：
3 FutureTask
3.1 FutureTask類
FutureTaskクラスはRunnableFutureインターフェースを実現しました。
3.2 stateフィールド
volatile修飾されたstateフィールド。
ルナーとwaitersはvolatileタイプです。
FutureTaskには2つのコンストラクタがあります。
3.5 CASツール初期化
get()方法は2つあります。
それでは、awaitdoneの方法を見てみます。
1.lable/Runnable
java.lang.Runnableインターフェースは一つのrun方法だけを宣言しました。
@FunctionalInterface
public interface Runnable {
/**
* When an object implementing interface Runnable is used
* to create a thread, starting the thread causes the object's
* run method to be called in that separately executing
* thread.
*
* The general contract of the method run is that it may
* take any action whatsoever.
*
* @see java.lang.Thread#run()
*/
public abstract void run();
}@FunctionalInterface
public interface Callable {
/**
* Computes a result, or throws an exception if unable to do so.
*
* @return computed result
* @throws Exception if unable to compute a result
*/
V call() throws Exception;
} <T> Future<T> submit(Callable<T> task);
<T> Future<T> submit(Runnable task, T result);
Future> submit(Runnable task);Futureとは、具体的なRunnableまたはCallableタスクの実行結果をキャンセルし、完了したかどうか調べ、結果を得ることです。必要に応じてget方法で実行結果を取得できます。この方法はタスクが結果を返すまでブロックされます。java.util.co ncurrent.Futureインターフェース：
* @see FutureTask
* @see Executor
* @since 1.5
* @author Doug Lea
* @param The result type returned by this Future's {@code get} method
*/
public interface Future {
boolean cancel(boolean mayInterruptIfRunning);
boolean isCancelled();
boolean isDone();
V get() throws InterruptedException, ExecutionException;
V get(long timeout, TimeUnit unit)
throws InterruptedException, ExecutionException, TimeoutException;
} 3 FutureTask
3.1 FutureTask類
FutureTaskクラスはRunnableFutureインターフェースを実現しました。
public class FutureTask<V> implements RunnableFuture<V> {public interface RunnableFuture<V> extends Runnable, Future<V> {
void run();
}3.2 stateフィールド
volatile修飾されたstateフィールド。
/**
* Possible state transitions:
* NEW -> COMPLETING -> NORMAL
* NEW -> COMPLETING -> EXCEPTIONAL
* NEW -> CANCELLED
* NEW -> INTERRUPTING -> INTERRUPTED
*/
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;ルナーとwaitersはvolatileタイプです。
/** */
private Callable callable;
/** */
private Object outcome; // non-volatile, protected by state reads/writes
/** */
private volatile Thread runner;
/** get */
private volatile WaitNode waiters; FutureTaskには2つのコンストラクタがあります。
public FutureTask(Callable callable) {
if (callable == null)
throw new NullPointerException();
this.callable = callable;
this.state = NEW; // ensure visibility of callable
}
public FutureTask(Runnable runnable, V result) {
this.callable = Executors.callable(runnable, result);
this.state = NEW; // ensure visibility of callable
} 3.5 CASツール初期化
// 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);
}
}static final class WaitNode {
volatile Thread thread;
volatile WaitNode next;
WaitNode() { thread = Thread.currentThread(); }
}public void run() {
// new， runner null，
if (state != NEW ||
!UNSAFE.compareAndSwapObject(this, runnerOffset, null,Thread.currentThread()))
return;
try {
Callable 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);
}
// ， result state
if (ran)
set(result);
}
} finally {
// runner null， run()
runner = null;
// state，
int s = state;
if (s >= INTERRUPTING)
handlePossibleCancellationInterrupt(s);
}
} // state outcome
protected void setException(Throwable t) {
if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
outcome = t;
UNSAFE.putOrderedInt(this, stateOffset, EXCEPTIONAL); // get()
finishCompletion();
}
}// ， state outcome
protected void set(V v) {
// ，NEW->COMPLETING->NORMAL
if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
outcome = v;
UNSAFE.putOrderedInt(this, stateOffset, NORMAL);
// get
finishCompletion();
}
}// ， done， callable
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
}private void handlePossibleCancellationInterrupt(int s) {
// It is possible for our interrupter to stall before getting a
// chance to interrupt us. Let's spin-wait patiently.
if (s == INTERRUPTING)
while (state == INTERRUPTING)
Thread.yield(); // wait out pending interrupt
// assert state == INTERRUPTED;
// We want to clear any interrupt we may have received from
// cancel(true). However, it is permissible to use interrupts
// as an independent mechanism for a task to communicate with
// its caller, and there is no way to clear only the
// cancellation interrupt.
//
// Thread.interrupted();
}get()方法は2つあります。
public V get() throws InterruptedException, ExecutionException {
int s = state;
if (s <= COMPLETING)
//
s = awaitDone(false, 0L);
return report(s);
}
/**
* @throws CancellationException {@inheritDoc}
*/
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);
}それでは、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()) {
// ， q
removeWaiter(q);
//
throw new InterruptedException();
}
int s = state;
// ， state
if (s > COMPLETING) {
if (q != null)
q.thread = null;
return s;
}
// ， ，
else if (s == COMPLETING) // cannot time out yet
Thread.yield();
// NEW， ， q
else if (q == null)
q = new WaitNode();
// ，
else if (!queued)
//
// q.next=waiters, waiter CAS q
queued = UNSAFE.compareAndSwapObject(this,waitersOffset, q.next = waiters, q);
// ，
else if (timed) {
nanos = deadline - System.nanoTime();
if (nanos <= 0L) {
//
removeWaiter(q);
return state;
}
get() ，
LockSupport.parkNanos(this, nanos);
}
//
else
// get() ，
LockSupport.park(this);
}
}
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;
}
}
}