futuretask

FutureTask源码解析
第一部分:What
在Java中一般通过继承Thread类或者实现Runnable接口这两种方式来创建多线程，但是这两种方式都有个缺陷，就是不能在执行完成后获取执行的结果，因此Java 1.5之后提供了Callable和Future接口，通过它们就可以在任务执行完毕之后得到任务的执行结果。本文会简要的介绍使用方法，然后会从源代码角度分析下具体的实现原理。
本文以Java 1.7的代码进行分析。

第二部分:How
Callable接口

对于需要执行的任务需要实现Callable接口，Callable接口定义如下:

复制代码
1 public interface Callable {
2 /**
3 * Computes a result, or throws an exception if unable to do so.
4 *
5 * @return computed result
6 * @throws Exception if unable to compute a result
7 */
8 V call() throws Exception;
9 }
复制代码
可以看到Callable是个泛型接口，泛型V就是要call()方法返回的类型。Callable接口和Runnable接口很像，都可以被另外一个线程执行，但是正如前面所说的，Runnable不会返回数据也不能抛出异常。

Future接口

Future接口代表异步计算的结果，通过Future接口提供的方法可以查看异步计算是否执行完成，或者等待执行结果并获取执行结果，同时还可以取消执行。Future接口的定义如下:

复制代码
1 public interface Future {
2 boolean cancel(boolean mayInterruptIfRunning);
3 boolean isCancelled();
4 boolean isDone();
5 V get() throws InterruptedException, ExecutionException;
6 V get(long timeout, TimeUnit unit)
7 throws InterruptedException, ExecutionException, TimeoutException;
8 }
复制代码
cancel():cancel()方法用来取消异步任务的执行。如果异步任务已经完成或者已经被取消，或者由于某些原因不能取消，则会返回false。如果任务还没有被执行，则会返回true并且异步任务不会被执行。如果任务已经开始执行了但是还没有执行完成，若mayInterruptIfRunning为true，则会立即中断执行任务的线程并返回true，若mayInterruptIfRunning为false，则会返回true且不会中断任务执行线程。
isCanceled():判断任务是否被取消，如果任务在结束(正常执行结束或者执行异常结束)前被取消则返回true，否则返回false。
isDone():判断任务是否已经完成，如果完成则返回true，否则返回false。需要注意的是：任务执行过程中发生异常、任务被取消也属于任务已完成，也会返回true。
get():获取任务执行结果，如果任务还没完成则会阻塞等待直到任务执行完成。如果任务被取消则会抛出CancellationException异常，如果任务执行过程发生异常则会抛出ExecutionException异常，如果阻塞等待过程中被中断则会抛出InterruptedException异常。
get(long timeout,Timeunit unit):带超时时间的get()版本，如果阻塞等待过程中超时则会抛出TimeoutException异常。
FutureTask

Future只是一个接口，不能直接用来创建对象，FutureTask是Future的实现类，
FutureTask的继承图如下:

可以看到,FutureTask实现了RunnableFuture接口，则RunnableFuture接口继承了Runnable接口和Future接口，所以FutureTask既能当做一个Runnable直接被Thread执行，也能作为Future用来得到Callable的计算结果。

使用

FutureTask一般配合ExecutorService来使用，也可以直接通过Thread来使用。

复制代码
1 package com.beautyboss.slogen.callback;
2
3 import java.util.concurrent.*;
4
5 /**
6 * Author : Slogen
7 * AddTime : 17/6/4
8 * Email : huangjian13@meituan.com
9 /
10 public class CallDemo {
11
12 public static void main(String[] args) throws ExecutionException, InterruptedException {
13
14 /*
15 * 第一种方式:Future + ExecutorService
16 * Task task = new Task();
17 * ExecutorService service = Executors.newCachedThreadPool();
18 * Future future = service.submit(task1);
19 * service.shutdown();
20 /
21
22
23 /*
24 * 第二种方式: FutureTask + ExecutorService
25 * ExecutorService executor = Executors.newCachedThreadPool();
26 * Task task = new Task();
27 * FutureTask futureTask = new FutureTask(task);
28 * executor.submit(futureTask);
29 * executor.shutdown();
30 /
31
32 /*
33 * 第三种方式:FutureTask + Thread
34 */
35
36 // 2. 新建FutureTask,需要一个实现了Callable接口的类的实例作为构造函数参数
37 FutureTask futureTask = new FutureTask(new Task());
38 // 3. 新建Thread对象并启动
39 Thread thread = new Thread(futureTask);
40 thread.setName(“Task thread”);
41 thread.start();
42
43 try {
44 Thread.sleep(1000);
45 } catch (InterruptedException e) {
46 e.printStackTrace();
47 }
48
49 System.out.println(“Thread [” + Thread.currentThread().getName() + “] is running”);
50
51 // 4. 调用isDone()判断任务是否结束
52 if(!futureTask.isDone()) {
53 System.out.println(“Task is not done”);
54 try {
55 Thread.sleep(2000);
56 } catch (InterruptedException e) {
57 e.printStackTrace();
58 }
59 }
60 int result = 0;
61 try {
62 // 5. 调用get()方法获取任务结果,如果任务没有执行完成则阻塞等待
63 result = futureTask.get();
64 } catch (Exception e) {
65 e.printStackTrace();
66 }
67
68 System.out.println("result is " + result);
69
70 }
71
72 // 1. 继承Callable接口,实现call()方法,泛型参数为要返回的类型
73 static class Task implements Callable {
74
75 @Override
76 public Integer call() throws Exception {
77 System.out.println(“Thread [” + Thread.currentThread().getName() + “] is running”);
78 int result = 0;
79 for(int i = 0; i < 100;++i) {
80 result += i;
81 }
82
83 Thread.sleep(3000);
84 return result;
85 }
86 }
87 }
复制代码
第三部分:Why

构造函数

先从FutureTask的构造函数看起，FutureTask有两个构造函数，其中一个如下：

复制代码
1 public FutureTask(Callable callable) {
2 if (callable == null)
3 throw new NullPointerException();
4 this.callable = callable;
5 this.state = NEW; // ensure visibility of callable
6 }
复制代码
这个构造函数会把传入的Callable变量保存在this.callable字段中，该字段定义为private Callable callable;用来保存底层的调用，在被执行完成以后会指向null,接着会初始化state字段为NEW。state字段用来保存FutureTask内部的任务执行状态，一共有7中状态，每种状态及其对应的值如下：

复制代码
1 private volatile int state;
2 private static final int NEW = 0;
3 private static final int COMPLETING = 1;
4 private static final int NORMAL = 2;
5 private static final int EXCEPTIONAL = 3;
6 private static final int CANCELLED = 4;
7 private static final int INTERRUPTING = 5;
8 private static final int INTERRUPTED = 6;
复制代码
其中需要注意的是state是volatile类型的，也就是说只要有任何一个线程修改了这个变量，那么其他所有的线程都会知道最新的值。

为了后面更好的分析FutureTask的实现，这里有必要解释下各个状态。

NEW:表示是个新的任务或者还没被执行完的任务。这是初始状态。
COMPLETING:任务已经执行完成或者执行任务的时候发生异常，但是任务执行结果或者异常原因还没有保存到outcome字段(outcome字段用来保存任务执行结果，如果发生异常，则用来保存异常原因)的时候，状态会从NEW变更到COMPLETING。但是这个状态会时间会比较短，属于中间状态。
NORMAL:任务已经执行完成并且任务执行结果已经保存到outcome字段，状态会从COMPLETING转换到NORMAL。这是一个最终态。
EXCEPTIONAL:任务执行发生异常并且异常原因已经保存到outcome字段中后，状态会从COMPLETING转换到EXCEPTIONAL。这是一个最终态。
CANCELLED:任务还没开始执行或者已经开始执行但是还没有执行完成的时候，用户调用了cancel(false)方法取消任务且不中断任务执行线程，这个时候状态会从NEW转化为CANCELLED状态。这是一个最终态。
INTERRUPTING: 任务还没开始执行或者已经执行但是还没有执行完成的时候，用户调用了cancel(true)方法取消任务并且要中断任务执行线程但是还没有中断任务执行线程之前，状态会从NEW转化为INTERRUPTING。这是一个中间状态。
INTERRUPTED:调用interrupt()中断任务执行线程之后状态会从INTERRUPTING转换到INTERRUPTED。这是一个最终态。
有一点需要注意的是，所有值大于COMPLETING的状态都表示任务已经执行完成(任务正常执行完成，任务执行异常或者任务被取消)。

各个状态之间的可能转换关系如下图所示:

另外一个构造函数如下，

1 public FutureTask(Runnable runnable, V result) {
2 this.callable = Executors.callable(runnable, result);
3 this.state = NEW; // ensure visibility of callable
4 }
这个构造函数会把传入的Runnable封装成一个Callable对象保存在callable字段中，同时如果任务执行成功的话就会返回传入的result。这种情况下如果不需要返回值的话可以传入一个null。

顺带看下Executors.callable()这个方法，这个方法的功能是把Runnable转换成Callable，代码如下:

1 public static Callable callable(Runnable task, T result) {
2 if (task == null)
3 throw new NullPointerException();
4 return new RunnableAdapter(task, result);
5 }
可以看到这里采用的是适配器模式，调用RunnableAdapter(task, result)方法来适配，实现如下:

复制代码
1 static final class RunnableAdapter implements Callable {
2 final Runnable task;
3 final T result;
4 RunnableAdapter(Runnable task, T result) {
5 this.task = task;
6 this.result = result;
7 }
8 public T call() {
9 task.run();
10 return result;
11 }
12 }
复制代码
这个适配器很简单，就是简单的实现了Callable接口，在call()实现中调用Runnable.run()方法，然后把传入的result作为任务的结果返回。

在new了一个FutureTask对象之后，接下来就是在另一个线程中执行这个Task,无论是通过直接new一个Thread还是通过线程池，执行的都是run()方法，接下来就看看run()方法的实现。

run()

run()方法实现如下:

复制代码
1 public void run() {
2 // 1. 状态如果不是NEW，说明任务或者已经执行过，或者已经被取消，直接返回
3 // 2. 状态如果是NEW，则尝试把当前执行线程保存在runner字段中
4 // 如果赋值失败则直接返回
5 if (state != NEW ||
6 !UNSAFE.compareAndSwapObject(this, runnerOffset,
7 null, Thread.currentThread()))
8 return;
9 try {
10 Callable c = callable;
11 if (c != null && state == NEW) {
12 V result;
13 boolean ran;
14 try {
15 // 3. 执行任务
16 result = c.call();
17 ran = true;
18 } catch (Throwable ex) {
19 result = null;
20 ran = false;
21 // 4. 任务异常
22 setException(ex);
23 }
24 if (ran)
25 // 4. 任务正常执行完毕
26 set(result);
27 }
28 } finally {
29 // runner must be non-null until state is settled to
30 // prevent concurrent calls to run()
31 runner = null;
32 // state must be re-read after nulling runner to prevent
33 // leaked interrupts
34 int s = state;
35 // 5. 如果任务被中断，执行中断处理
36 if (s >= INTERRUPTING)
37 handlePossibleCancellationInterrupt(s);
38 }
39 }
复制代码
run()方法首先会

判断当前任务的state是否等于NEW,如果不为NEW则说明任务或者已经执行过，或者已经被取消，直接返回。
如果状态为NEW则接着会通过unsafe类把任务执行线程引用CAS的保存在runner字段中，如果保存失败，则直接返回。
执行任务。
如果任务执行发生异常，则调用setException()方法保存异常信息。setException()方法如下：
复制代码
1 protected void setException(Throwable t) {
2 if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
3 outcome = t;
4 UNSAFE.putOrderedInt(this, stateOffset, EXCEPTIONAL); // final state
5 finishCompletion();
6 }
7 }
复制代码
在setException()方法中

首先会CAS的把当前的状态从NEW变更为COMPLETING状态。
把异常原因保存在outcome字段中，outcome字段用来保存任务执行结果或者异常原因。
CAS的把当前任务状态从COMPLETING变更为EXCEPTIONAL。这个状态转换对应着上图中的二。
调用finishCompletion()。关于这个方法后面在分析。
5. 如果任务成功执行则调用set()方法设置执行结果，该方法实现如下:

复制代码
1 protected void set(V v) {
2 if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
3 outcome = v;
4 UNSAFE.putOrderedInt(this, stateOffset, NORMAL); // final state
5 finishCompletion();
6 }
7 }
复制代码
这个方法跟上面分析的setException()差不多，

首先会CAS的把当前的状态从NEW变更为COMPLETING状态。
把任务执行结果保存在outcome字段中。
CAS的把当前任务状态从COMPLETING变更为NORMAL。这个状态转换对应着上图中的一。
调用finishCompletion()。
发起任务线程跟执行任务线程通常情况下都不会是同一个线程，在任务执行线程执行任务的时候，任务发起线程可以查看任务执行状态、获取任务执行结果、取消任务等等操作，接下来分析下这些操作。

get()

任务发起线程可以调用get()方法来获取任务执行结果，如果此时任务已经执行完毕则会直接返回任务结果，如果任务还没执行完毕，则调用方会阻塞直到任务执行结束返回结果为止。get()方法实现如下:

复制代码
1 public V get() throws InterruptedException, ExecutionException {
2 int s = state;
3 if (s <= COMPLETING)
4 s = awaitDone(false, 0L);
5 return report(s);
6 }
复制代码
get()方法实现比较简单，会

判断任务当前的state <= COMPLETING是否成立。前面分析过，COMPLETING状态是任务是否执行完成的临界状态。
如果成立，表明任务还没有结束(这里的结束包括任务正常执行完毕，任务执行异常，任务被取消)，则会调用awaitDone()进行阻塞等待。
如果不成立表明任务已经结束，调用report()返回结果。
awaitDone()

当调用get()获取任务结果但是任务还没执行完成的时候，调用线程会调用awaitDone()方法进行阻塞等待，该方法定义如下:

复制代码
1 private int awaitDone(boolean timed, long nanos)
2 throws InterruptedException {
3 // 计算等待截止时间
4 final long deadline = timed ? System.nanoTime() + nanos : 0L;
5 WaitNode q = null;
6 boolean queued = false;
7 for (;😉 {
8 // 1. 判断阻塞线程是否被中断,如果被中断则在等待队
9 // 列中删除该节点并抛出InterruptedException异常
10 if (Thread.interrupted()) {
11 removeWaiter(q);
12 throw new InterruptedException();
13 }
14
15 // 2. 获取当前状态，如果状态大于COMPLETING
16 // 说明任务已经结束(要么正常结束，要么异常结束，要么被取消)
17 // 则把thread显示置空，并返回结果
18 int s = state;
19 if (s > COMPLETING) {
20 if (q != null)
21 q.thread = null;
22 return s;
23 }
24 // 3. 如果状态处于中间状态COMPLETING
25 // 表示任务已经结束但是任务执行线程还没来得及给outcome赋值
26 // 这个时候让出执行权让其他线程优先执行
27 else if (s == COMPLETING) // cannot time out yet
28 Thread.yield();
29 // 4. 如果等待节点为空，则构造一个等待节点
30 else if (q == null)
31 q = new WaitNode();
32 // 5. 如果还没有入队列，则把当前节点加入waiters首节点并替换原来waiters
33 else if (!queued)
34 queued = UNSAFE.compareAndSwapObject(this, waitersOffset,
35 q.next = waiters, q);
36 else if (timed) {
37 // 如果需要等待特定时间，则先计算要等待的时间
38 // 如果已经超时，则删除对应节点并返回对应的状态
39 nanos = deadline - System.nanoTime();
40 if (nanos <= 0L) {
41 removeWaiter(q);
42 return state;
43 }
44 // 6. 阻塞等待特定时间
45 LockSupport.parkNanos(this, nanos);
46 }
47 else
48 // 6. 阻塞等待直到被其他线程唤醒
49 LockSupport.park(this);
50 }
51 }
复制代码
awaitDone()中有个死循环，每一次循环都会

判断调用get()的线程是否被其他线程中断，如果是的话则在等待队列中删除对应节点然后抛出InterruptedException异常。
获取任务当前状态，如果当前任务状态大于COMPLETING则表示任务执行完成，则把thread字段置null并返回结果。
如果任务处于COMPLETING状态，则表示任务已经处理完成(正常执行完成或者执行出现异常)，但是执行结果或者异常原因还没有保存到outcome字段中。这个时候调用线程让出执行权让其他线程优先执行。
如果等待节点为空，则构造一个等待节点WaitNode。
如果第四步中新建的节点还没如队列，则CAS的把该节点加入waiters队列的首节点。
阻塞等待。
假设当前state=NEW且waiters为NULL,也就是说还没有任何一个线程调用get()获取执行结果，这个时候有两个线程threadA和threadB先后调用get()来获取执行结果。再假设这两个线程在加入阻塞队列进行阻塞等待之前任务都没有执行完成且threadA和threadB都没有被中断的情况下(因为如果threadA和threadB在进行阻塞等待结果之前任务就执行完成或线程本身被中断的话，awaitDone()就执行结束返回了)，执行过程是这样的，以threadA为例:

第一轮for循环，执行的逻辑是q == null,所以这时候会新建一个节点q。第一轮循环结束。
第二轮for循环，执行的逻辑是!queue，这个时候会把第一轮循环中生成的节点的netx指针指向waiters，然后CAS的把节点q替换waiters。也就是把新生成的节点添加到waiters链表的首节点。如果替换成功，queued=true。第二轮循环结束。
第三轮for循环，进行阻塞等待。要么阻塞特定时间，要么一直阻塞知道被其他线程唤醒。
在threadA和threadB都阻塞等待之后的waiters结果如图

cancel(boolean)

用户可以调用cancel(boolean)方法取消任务的执行，cancel()实现如下:

复制代码
1 public boolean cancel(boolean mayInterruptIfRunning) {
2 // 1. 如果任务已经结束，则直接返回false
3 if (state != NEW)
4 return false;
5 // 2. 如果需要中断任务执行线程
6 if (mayInterruptIfRunning) {
7 // 2.1. 把任务状态从NEW转化到INTERRUPTING
8 if (!UNSAFE.compareAndSwapInt(this, stateOffset, NEW, INTERRUPTING))
9 return false;
10 Thread t = runner;
11 // 2.2. 中断任务执行线程
12 if (t != null)
13 t.interrupt();
14 // 2.3. 修改状态为INTERRUPTED
15 UNSAFE.putOrderedInt(this, stateOffset, INTERRUPTED); // final state
16 }
17 // 3. 如果不需要中断任务执行线程，则直接把状态从NEW转化为CANCELLED
18 else if (!UNSAFE.compareAndSwapInt(this, stateOffset, NEW, CANCELLED))
19 return false;
20 // 4.
21 finishCompletion();
22 return true;
23 }
复制代码
cancel()方法会做下面几件事:

1 .判断任务当前执行状态，如果任务状态不为NEW，则说明任务或者已经执行完成，或者执行异常，不能被取消，直接返回false表示执行失败。

2. 判断需要中断任务执行线程，则

把任务状态从NEW转化到INTERRUPTING。这是个中间状态。
中断任务执行线程。
修改任务状态为INTERRUPTED。这个转换过程对应上图中的四。
3. 如果不需要中断任务执行线程，直接把任务状态从NEW转化为CANCELLED。如果转化失败则返回false表示取消失败。这个转换过程对应上图中的四。

4. 调用finishCompletion()。

finishCompletion()

根据前面的分析，不管是任务执行异常还是任务正常执行完毕，或者取消任务，最后都会调用finishCompletion()方法，该方法实现如下:

复制代码
1 private void finishCompletion() {
2 // assert state > COMPLETING;
3 for (WaitNode q; (q = waiters) != null;) {
4 if (UNSAFE.compareAndSwapObject(this, waitersOffset, 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
21 done();
22
23 callable = null; // to reduce footprint
24 }
复制代码
这个方法的实现比较简单，依次遍历waiters链表，唤醒节点中的线程，然后把callable置空。

被唤醒的线程会各自从awaitDone()方法中的LockSupport.park*()阻塞中返回，然后会进行新一轮的循环。在新一轮的循环中会返回执行结果(或者更确切的说是返回任务的状态)。

report()

report()方法用在get()方法中，作用是把不同的任务状态映射成任务执行结果。实现如下：

复制代码
1 private V report(int s) throws ExecutionException {
2 Object x = outcome;
3 // 1. 任务正常执行完成，返回任务执行结果
4 if (s == NORMAL)
5 return (V)x;
6 // 2. 任务被取消，抛出CancellationException异常
7 if (s >= CANCELLED)
8 throw new CancellationException();
9 // 3. 其他状态，抛出执行异常ExecutionException
10 throw new ExecutionException((Throwable)x);
11 }
复制代码

映射关系如下图所示:

如果任务处于NEW、COMPLETING和INTERRUPTING这三种状态的时候是执行不到report()方法的，所以没必要对这三种状态进行转换。

get(long,TimeUnit)

带超时等待的获取任务结果，实现如下:

复制代码
1 public V get(long timeout, TimeUnit unit)
2 throws InterruptedException, ExecutionException, TimeoutException {
3 if (unit == null)
4 throw new NullPointerException();
5 int s = state;
6 if (s <= COMPLETING &&
7 // 如果awaitDone()超时返回之后任务还没结束，则抛出异常
8 (s = awaitDone(true, unit.toNanos(timeout))) <= COMPLETING)
9 throw new TimeoutException();
10 return report(s);
11 }
复制代码
跟get()不同点在于get(long,TimeUnit)会在awaitDone()超时返回之后抛出TimeoutException异常。

isCancelled()和isDone()

这两个方法分别用来判断任务是否被取消和任务是否执行完成，实现都比较简单，代码如下:

1 public boolean isCancelled() {
2 return state >= CANCELLED;
3 }
1 public boolean isDone() {
2 return state != NEW;
3 }
根据前面的分析，这两个方法就很容易理解不用多做解释了，O(∩_∩)O。

总结下，其实FutureTask的实现还是比较简单的，当用户实现Callable()接口定义好任务之后，把任务交给其他线程进行执行。FutureTask内部维护一个任务状态，任何操作都是围绕着这个状态进行，并随时更新任务状态。任务发起者调用get*()获取执行结果的时候，如果任务还没有执行完毕，则会把自己放入阻塞队列中然后进行阻塞等待。当任务执行完成之后，任务执行线程会依次唤醒阻塞等待的线程。调用cancel()取消任务的时候也只是简单的修改任务状态，如果需要中断任务执行线程的话则调用Thread.interrupt()中断任务执行线程。

第四部分:Other
有个值得关注的问题就是当任务还在执行的时候用户调用cancel(true)方法能否真正让任务停止执行呢？
在前面的分析中我们直到，当调用cancel(true)方法的时候，实际执行还是Thread.interrupt()方法，而interrupt()方法只是设置中断标志位，如果被中断的线程处于sleep()、wait()或者join()逻辑中则会抛出InterruptedException异常。

因此结论是:cancel(true)并不一定能够停止正在执行的异步任务。