前言

代码写到一定程度，多线程是必须要学会的，不然就是永远的CURD咸鱼了。
生活中的多线程就像是领导一定会剥削你让你同时做多个项目一样，在处理多个任务时，如果几个项目都有待定的内容时，你就不能一直僵持在某个任务上，需要来回在这些任务间切换；当然也有可能你会阻塞在某些疑难问题上。为了防止多个领导争抢你，你得说明你正在处理某个任务，等等。

一、使用方法

public class TestFutureTask {

    public static void main(String[] args) throws ExecutionException, InterruptedException {
        // 构建task
        FutureTask<String> futureTask = new FutureTask<>(() -> {
            System.out.println("任务执行中");
            Thread.sleep(5000);
            return "任务执行结果";
        });
        // 让线程去运行
        Thread t0 = new Thread(futureTask, "执行任务");
        t0.start();
        // 让子线程去等待
        Thread t1 = new Thread(() -> {
            try {
                System.out.println("t1等待");
                String info = futureTask.get();
                System.out.println("t1拿到: " + info);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }, "等待者1");
        Thread t2 = new Thread(() -> {
            try {
                System.out.println("t2等待");
                String info = futureTask.get();
                System.out.println("t2拿到: " + info);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }, "等待者2");
        Thread.sleep(1000);
        t1.start();
        t2.start();
    }
}

输出结果：

任务执行中
t1等待
t2等待
t2拿到: 任务执行结果
t1拿到: 任务执行结果

二、原理剖析

2.1状态信息

总共有7种状态
// 任务对象新建的时候处于new状态
private static final int NEW = 0;
// 这是个中间状态，因为future是有结果返回的，抛异常/赋值/唤醒过程可能会多线程冲突的问题，所以需要加一个状态
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;

2.2构造函数

// 通过callable创建任务，通过call方法返回执行结果
public FutureTask(Callable<V> callable) {
        if (callable == null)
            throw new NullPointerException();
        this.callable = callable;
        this.state = NEW;       // ensure visibility of callable
    }
// 通过runnable创建任务，result这个传入的result负责传递引用，就是在任务执行过程中复制给它，而不是通过run方法的返回值获取结果，因为run没有返回值
 public FutureTask(Runnable runnable, V result) {
        this.callable = Executors.callable(runnable, result);
        this.state = NEW;       // ensure visibility of callable
    }

2.3任务执行

这里只挑个主要的来说明,runAndReset是用来复用的，如上次取消了，然后再次执行，这里不做过多说明。

// 线程执行的还是run方法，说明call方法没有run方法吃香，即使是在它的领域内，哈哈
 public void run() {
       // 状态不是NEW的时候，通过cas判断是不是当前线程
       // 就是为了防止在多个线程冲突
        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();
                    // run的过去式，表示已经执行完了
                    ran = true;
                } catch (Throwable ex) {
                // 异常抛出的时候调用setException，这个也会有唤醒能力
                    result = null;
                    ran = false;
                    setException(ex);
                }
                if (ran)
                // 设置结果，具有唤醒等到线程的能力
                    set(result);
            }
        } finally {
            // runner must be non-null until state is settled to
            // prevent concurrent calls to run()
            runner = null;
            // 获取state的当前值，后面会因为任务的进行改变
            int s = state;
            if (s >= INTERRUPTING)
            // 这里面会自旋等待最终状态，采用yield方式，yield可以让同优先级的线程获取锁的权限
                handlePossibleCancellationInterrupt(s);
        }
    }

2.4任务完成

// 正常线程执行完成会调用这个方法，把执行结果赋值给outcome
protected void set(V v) {
        // 注意这里是没有锁的，而是采用了cas的方式，只有在更新成功的情况下会进入逻辑
        if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
            outcome = v;
            // 赋值完成更新最后的线程状态
            UNSAFE.putOrderedInt(this, stateOffset, NORMAL); // final state
            finishCompletion();
        }
    }

// 等待线程的唤醒以及线程执行完成的收尾工作，如辅助gc的措施
private void finishCompletion() {
        // 假设 state > COMPLETING;
        // 这里它没有直接获取所有waiter对象的方法，像是list那种，只能循环获取next
        for (WaitNode q; (q = waiters) != null;) {
            if (UNSAFE.compareAndSwapObject(this, waitersOffset, q, null)) {
                for (;;) {
                    Thread t = q.thread;
                    // 辅助gc将指针对象置空，这样它就没有引用路径了
                    if (t != null) {
                        q.thread = null;
                        // 执行unpark方法，让线程执行下去
                        LockSupport.unpark(t);
                    }
                    // 查看下个节点是不是还是空的，如果不是空的就继续，为空就退出循环
                    WaitNode next = q.next;
                    if (next == null)
                        break;
                    // 这里同样需要将指针对象置空
                    q.next = null;
                    q = next;
                }
                break;
            }
        }
        // 这个方法默认是空的，可以在继承类中实现它，然后在线程执行完成之后附加一些方法
        done();
        callable = null;        // to reduce footprint
    }

2.5get()方法获取值

public V get() throws InterruptedException, ExecutionException {
     int s = state;
     // 如果还在执行中，就进入等待
     if (s <= COMPLETING)
         s = awaitDone(false, 0L);
     return report(s);
}

// 等待方法有两个入参，一个是等待时间，还有一个是否允许等待
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) // cannot time out yet
                Thread.yield();
            // 初始化一个等待节点，对象中包含下个节点的指针以及当前线程
            else if (q == null)
                q = new WaitNode();
            // 第一次肯定queued=false
            else if (!queued)
            // this表示当前对象
            // waitersOffset表示在当前对象中waiters的内存偏移量,通俗点说就是它在对象中的位置
            // q.next = waiters有两个意思，让next指向waiters，同时获取waiters
            // 这里的逻辑会这个新的q = new WaitNode()，放在waiters的最前面
                queued = UNSAFE.compareAndSwapObject(this, waitersOffset,
                                                     q.next = waiters, q);
            // 这里按照入参要求执行park，park会释放锁，也会阻塞当前线程
            // 结合finishCompletion里面的unpark完成线程的阻塞和唤醒
            else if (timed) {
                nanos = deadline - System.nanoTime();
                if (nanos <= 0L) {
                    removeWaiter(q);
                    return state;
                }
                LockSupport.parkNanos(this, nanos);
            }
            else
                LockSupport.park(this);
        }
    }

三、总结

总体流程为，初始化task（NEW）->run方法执行任务->get()方法获取执行结果，线程没有执行完，阻塞->线程执行完毕（COMPLETING->NORMAL），唤醒调用get方法的对象->结束
等待队列的唤醒顺序是和调用get方法的顺序反过来的，因为每次新进来的waiter都是放在最前面的

FutureTask使用与原理