在分析AsyncTask源码时,里面用到Future模式,用到了FutureTask这个类,只好“解剖”其源码,学习学习。
FutureTask类的作用
FutureTask类提供了异步任务的功能,比较独特的是,它在执行任务时,我们可以取消任务,还可以查询这个任务执行的状态和获取其结果,主要是配合线程池使用。很好玩的一个类,不能错过源码解析。
FutureTask源码解析
先了解几个接口:
// Callable接口,主要在FutureTask内部使用
public interface Callable<V> {
V call() throws Exception;
}
// Runnable接口
public interface Runnable {
public abstract void run();
}
// Future接口
public interface Future<V> {
//试图取消对此任务的执行。
boolean cancel(boolean mayInterruptIfRunning);
//如果在任务正常完成前将其取消,则返回 true。
boolean isCancelled();
//如果任务已完成,则返回 true。
boolean isDone();
//如有必要,等待任务完成,然后获取其结果。
V get() throws InterruptedException, ExecutionException;
//如有必要,最多等待为使任务完成所给定的时间之后,获取其结果(如果结果可用)。
V get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException;
}
// RunnableFuture接口,继承了Runnable和Future接口
public interface RunnableFuture<V> extends Runnable, Future<V> {
void run();
}
FutureTask主要是实现RunnableFuture接口,我们看看构造函数:
/**
* 构造参数 传入callable对象,并且将当前状态state设置为null。
*/
public FutureTask(Callable<V> callable) {
if (callable == null)
throw new NullPointerException();
this.callable = callable;
this.state = NEW; // ensure visibility of callable
}
/**
* 传入runnable对象和result
* 通过Executors包装一下,还是返回一个callable的实例
* 在执行完runnable的任务后直接返回result
*/
public FutureTask(Runnable runnable, V result) {
this.callable = Executors.callable(runnable, result);
this.state = NEW; // ensure visibility of callable
}
两组构造函数都是初始化一个Callable对象,并设置状态为New。接下来我们看看run方法:
public void run() {
// 任务不能多个线程同时运行。
// 如果第一次运行将runner设置为当前执行的线程。
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
ran = true;
} catch (Throwable ex) {
// 出现异常就调用setException方法,将状态state设置为EXCEPTIONAL
result = null;
ran = false;
setException(ex);
}
// 如果上面任务正常完成则调用set方法,那么将状态state设置为NORMAL
if (ran)
set(result);
}
} finally {
runner = null;
int s = state;
// 这里要判断一下,任务是否被取消过。
if (s >= INTERRUPTING)
handlePossibleCancellationInterrupt(s);
}
}
我们看看set(result)方法:
protected void set(V v) {
// 将状态先设置为COMPLETING正在完成,然后再设置为正常NORMAL
if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
outcome = v;
UNSAFE.putOrderedInt(this, stateOffset, NORMAL); // final state
// 然后调用完成方法
finishCompletion();
}
}
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方法
done();
callable = null; // to reduce footprint
}
我们先看看我们通过FutureTask获取结果的代码,之后我们再来说说set(result)做了什么:
/**
* 获取任务的结果,如果任务未完成则线程进入等待状态。
*/
public V get() throws InterruptedException, ExecutionException {
int s = state;
// 如果任务未完成
if (s <= COMPLETING)
// 等待完成 里面的是实现是等待队列
s = awaitDone(false, 0L);
// 调用report方法来根据情况返回结果
return report(s);
}
/**
* 最多等待为使计算完成所给定的时间之后,获取其结果。
*/
public V get(long timeout, TimeUnit unit)
throws InterruptedException, ExecutionException, TimeoutException {
if (unit == null)
throw new NullPointerException();
int s = state;
// 如果超时任务未能完成就抛出TimeoutException
if (s <= COMPLETING &&
(s = awaitDone(true, unit.toNanos(timeout))) <= COMPLETING)
throw new TimeoutException();
// 调用report方法来根据情况返回结果
return report(s);
}
第一个get方法不限等待任务执行,直到任务执行完毕或者取消或者报错中断为止。第二个get方法加了超时的,如果任务不能再规定时间内完成,就报错。两个get方法都调用了awaitDone方法:
private int awaitDone(boolean timed, long nanos) throws InterruptedException {
// 计算一下需要等待的时间,有可能为0,为0的话就无限期等待。
final long deadline = timed ? System.nanoTime() + nanos : 0L;
// 一个等待节点
WaitNode q = null;
// 是否加入队列
boolean queued = false;
for (;;) {
// 如果当且调用get方法的线程被interrupt 那么就把当前线程从等待队列remove
// 然后抛出异常
if (Thread.interrupted()) {
removeWaiter(q);
throw new InterruptedException();
}
int s = state;
// 如果任务已经完成 不管是被暂停了 还是出现异常了 只要状态大于COMPLETING就返回。
if (s > COMPLETING) {
if (q != null)
q.thread = null;
return s;
}
else if (s == COMPLETING) // cannot time out yet
// 如果任务正在完成中(注意是ING进行时) 那么让出一会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) {
// 如果设置了等待 那么就得锁住线程等待,如果时间到了就返回状态。
// 方法 public V get(long timeout, TimeUnit unit) 这里会根据状态做后续处理。
nanos = deadline - System.nanoTime();
if (nanos <= 0L) {
removeWaiter(q);
return state;
}
LockSupport.parkNanos(this, nanos);
}
else
// 否则锁住线程等待其他线程解锁。
LockSupport.park(this);
}
}
通过以上代码,我们知道,在调用FutureTask的get方法获取结果时,如果任务还没有执行完,就会阻塞线程。等任务执行完了,通过set(result)方法唤醒等待线程,并返回任务执行的结果(如果结果有用)。我们还能通过FutureTask取消任务,我们看看代码:
public boolean cancel(boolean mayInterruptIfRunning) {
// 如果当前状态不是新创建时的状态 那么返回false
// 这种情况说明任务已经执行,那么当前状态的值就有俩种情况。
// 一种是任务正常完成 那么当前状态将的值会按照这个方向执行 NEW -> COMPLETING -> NORMAL
// 一种任务是执行中出现异常 那么当前状态的值会按照这个方向执行 NEW -> COMPLETING -> EXCEPTIONAL
if (state != NEW)
return false;
if (mayInterruptIfRunning) {
// 设置当前状态为INTERRUPTING(正在设置线程的中断状态)
if (!UNSAFE.compareAndSwapInt(this, stateOffset, NEW, INTERRUPTING))
return false;
Thread t = runner;
if (t != null)
// 设置线程的中断状态
t.interrupt();
// 设置当前状态为INTERRUPTED
UNSAFE.putOrderedInt(this, stateOffset, INTERRUPTED); // final state
}
// 如果当前状态为NEW 那么会把当前状态设置为 CANCELLED 然后调用finishCompletion,然后返回成功
else if (!UNSAFE.compareAndSwapInt(this, stateOffset, NEW, CANCELLED))
return false;
// 唤醒等待
finishCompletion();
return true;
}
这样我们就可以中断线程,停止执行任务。
我们在看看2个判断状态的方法:
/*
* 判断任务是否取消
*/
public boolean isCancelled() {
return state >= CANCELLED;
}
/*
* 如果任务已完成,则返回 true。
* 可能由于正常终止、异常或取消而完成,在所有这些情况中,此方法都将返回 true。
*/
public boolean isDone() {
return state != NEW;
}
至于队列的操作吧,我不想太深入,知道有这么一回事就行了。有兴趣的可以研究一下UNSAFE类。FutureTask分析到这里就行了,足够我理解AsyncTask了,还顺便学习怎么使用FutureTask,及其原理。