Java FutureTask 源码解析

FutureTask注释

FutureTask一个可取消的异步计算。利用开始和取消计算的方法、查询计算是否完成的方法和获取计算结果的方法，此类提供了对Future的基本实现。仅在计算完成时才能获取结果；如果计算尚未完成，则阻塞get方法。一旦计算完成，就不能在重新开始或取消计算。

可使用FutureTask包装Callable或Runnable对象。因为Future实现了Runnable，所以可将Future提交给Executor执行。

FutureTask属性

FutureTask 有两个很重要的属性 分别是 state  runner ，futureTask之所以可以支持cancel操作 就是因为这两个属性

其中state为枚举值：

NEW                            新建            0

COMPLETING            执行中        1
NORMAL                   正常            2
EXCEPTIONAL           异常            3
CANCELLED               取消           4
INTERRUPTING         中断中        5
INTERRUNPED          被中断        6

state的状态变化可以有四种方式

NEW->COMPLETING->NORMAL                        正常完成的流程

NEW->COMPLETING->EXCEPTIONAL                出现异常的流程
NEW->CANCELED                                                  被取消
NEW->INTERRUNPING->INTERRRUNPTED       被中断

我们研究下Task的状态变化也就是一个任务的生命周期:

我们创建一个FutureTask 首先会调用构造方法:

1. public FutureTask(Runnable runnable, V result) {
2. this.callable = Executors.callable(runnable, result);
3. this.state = NEW; // ensure visibility of callable
4. }

在我们构造Task的时候会把状态 设置成 NEW 也就是所有 状态变化路径的起始状态

我们创建完一个Task 会提交给Executes来执行(当然我们也可以自己启动Thread来执行 效果基本是一样，只是交给线程池执行Task可能会延迟执行）。

在之后的Task生命周期的变化 主要取决于 run()方法先被调用还是cancel ()方法会被调用，这两个方法的执行顺序决定了Task的生命周期的四种走向。

FutureTask run()

我们先分析run方法先被调用的情况，为了能对run()方法能更加详细的理解我在run方法中加了增加了些注释

1. public void run() {
2. 1、首先判断任务的状态 如果任务的状态不是new 说明任务的状态已经改变（说明他已经走了4种可能变化的一种） 
3.         2、如果状态是new就会把 当前执行任务的线程付给runner, 这里用的cmpandset如果runner不为空 说明已经有线程在执行 
4.         3、任务也会退出执行,如果状态是new并且runner为空并且把当前的线程付给了runner那么就继续执行任务(runner state 都是 volatile 类型的变量是一个很轻量机的线程安全操作) 
5.         4、引起state状态变化的原因 就是调用了cancel 或是 run 
6. if (state != NEW ||
7. !U.compareAndSwapObject(this, RUNNER, null, Thread.currentThread()))
8. return;
9. //开始执行任务  
10. try {
11. Callable<V> c = callable;
12. // 如果 要执行的任务不为空 并且状态 new 就执行 
13. if (c != null && state == NEW) {
14. V result;
15. boolean ran;
16. try {
17. // 执行任务  
18. result = c.call();
19. // 如果没有意外发生就执行成功了  
20. ran = true;
21. } catch (Throwable ex) {
22. // 有异常  
23. result = null;
24. ran = false;
25. // 设置异常
26. setException(ex);
27. }
28. // 如果计算成功了 设置结果
29. if (ran)
30. set(result);
31. }
32. } finally {
33. // runner must be non-null until state is settled to
34. // prevent concurrent calls to run()
35. // 不管是否执行成功了 都把runner设置成null  
36. runner = null;
37. // state must be re-read after nulling runner to prevent
38. // leaked interrupts
39. int s = state;
40. if (s >= INTERRUPTING)
41. handlePossibleCancellationInterrupt(s);
42. }
43. }

Task执行后如果成功会调用set()方法,如果有异常会调用setException()方法。

我们先看下set方法 ：

1. protected void set(V v) {
2. // 如果state是new 把state设置成 COMPLETING 
3. if (U.compareAndSwapInt(this, STATE, NEW, COMPLETING)) {
4. // 将结果保存到outcome
5. outcome = v;
6. // 将任务设置成NORMAL   over the task  
7. U.putOrderedInt(this, STATE, NORMAL); // final state
8. finishCompletion();
9. }
10. }

如果现在的状态是NEW 就把状态设置成COMPLETING 然后设置成NORMAL。 这个执行流程导致的状态变化就是

NEW->COMPLETING->NORMAL 

执行步骤是 首先执行 run() 并且Task正常完成而且在这其间没有调用cancel()

上边是任务正常执行完成的状态变化，我们在看下有异常的情况。有异常的话会调用setException()方法:

1. protected void setException(Throwable t) {
2. // 如果state是new 把state设置成 COMPLETING 
3. if (U.compareAndSwapInt(this, STATE, NEW, COMPLETING)) {
4. outcome = t;
5. // 将任务设置成EXCEPTIONAL
6. U.putOrderedInt(this, STATE, EXCEPTIONAL); // final state
7. finishCompletion();
8. }
9. }

如果现在的状态是NEW 就把状态设置成COMPLETING 然后设置成EXCEPTIONAL。 这个执行流程导致的状态变化就是

NEW->COMPLETING->EXCEPTIONAL  

执行步骤是 首先执行 run() 并且Task抛出异常而且在这其间没有调用cancel()。

上文所分析的场景只是run()方法被调用了而在run()方法执行的过程中 调用cancel()并没有分析，两个方法有时间交集的情况我们稍后分析。

FutureTask cancel()

现在我们分析下cancel()方法先被调用的情况

1. public boolean cancel(boolean mayInterruptIfRunning) {
2. // mayInterruptIfRunning 是否中断running
3. // 这个判断逻辑等价于：
4. // if(state!=new || !UNSAFE.compareAndSwapInt(this, stateOffset, NEW, mayInterruptIfRunning ? INTERRUPTING : CANCELLED)) 
5.         // 1、如果state不是new 那么就退出方法，这时的任务是已经完成了 或是被取消了 或是被中断了 
6.         // 2、如果是state是new 就设置state 为中断状态 或是取消状态 
7. if (!(state == NEW &&
8. U.compareAndSwapInt(this, STATE, NEW,
9. mayInterruptIfRunning ? INTERRUPTING : CANCELLED)))
10. return false;
11. try { // in case call to interrupt throws exception
12. // 如果是可中断 那么就调用系统中断方法 然后把状态设置成INTERRUPTED  
13. if (mayInterruptIfRunning) {
14. try {
15. Thread t = runner;
16. if (t != null)
17. t.interrupt();
18. } finally { // final state
19. U.putOrderedInt(this, STATE, INTERRUPTED);
20. }
21. }
22. } finally {
23. finishCompletion();
24. }
25. return true;
26. }

这个方法很简单 ：

1、.如果是cancel(false) 那么Task的状态变化就是

NEW->=CANCELLED

2、如果是cancel(true)那么Task的状态化就是

NEW->INTERRUPTING ->INTERRUPTED

至此Task的四种状态变化我们都看到了，不过这都是在两个方法都是单独执行的情况。

我们在分析下两个方法交叉执行的情况( run()->cancel() )：

1、如果Task已经执行(run)然后再调用cancel():

    A、调用cancel(false)情况

• 如果Task已经在执行而callable.call()没有返回 或是 call()已经返回但是state状态还没有改变，那么任务调用cancel(false) 不会对任务的执行造成影响 只会影响task的状态 。

• 如果callable.call()已经返回并且状态已经变成COMPLETING或是 COMPLED 那么对任务执行 和任务状态都没有影响。

    B、调用cancel(true)

• 如果任务已经在执行而callable.call()没有返回，会把state设置成 INTERRUPTING然后调用执行线程的中断请求 然后把状态设置成INTERRUPTED,这里如果 callable.call()方法可以响应中断 可能对任务执行产生影响，如果方法不会响应中断不会对任务运行产生影响。影响任务的状态。

• 如果任务已经在执行并且 call()已经返回但是state状态还没有改变  不会对任务的执行造成影响 只会影响任务的状态 。

2、调用cancel()后 在执行任务 ( cancel() -> run() )

先调用cancel()无论是那种调用方式都会引起state状态的变化。在run()方法执行的时候发现state已经不是new了 就会放弃任务的执行。

任务结果回调方法 done()

不管是run，还是cancel，最后都会调用finishCompletion()方法。

1. private void finishCompletion() {
2. // assert state > COMPLETING;
3. for (WaitNode q; (q = waiters) != null;) {
4. if (U.compareAndSwapObject(this, WAITERS, q, null)) {
5. for (;;) {
6. Thread t = q.thread;
7. if (t != null) {
8. q.thread = null;
9. LockSupport.unpark(t);
10. }
11. WaitNode next = q.next;
12. if (next == null)
13. break;
14. q.next = null; // unlink to help gc
15. q = next;
16. }
17. break;
18. }
19. }
20. // 子类覆写此方法，在计算结果结束后会回调此方法，获取结果的方法：get()
21. done();
23. callable = null; // to reduce footprint
24. }

获取结果的方法 get()

1. public V get() throws InterruptedException, ExecutionException {
2. int s = state;
3. // 如果没有计算完成，则等待
4. if (s <= COMPLETING)
5. s = awaitDone(false, 0L);
6. return report(s);
7. }

1. private V report(int s) throws ExecutionException {
2. // 获取到结果
3. Object x = outcome;
4. // 如果是正常，则返回结果
5. if (s == NORMAL)
6. return (V)x;
7. // 如果是异常，则抛出异常 CancellationException
8. if (s >= CANCELLED)
9. throw new CancellationException();
10. throw new ExecutionException((Throwable)x);
11. }