美文网首页
FutureTask源码剖析

FutureTask源码剖析

作者: 王侦 | 来源:发表于2022-12-03 09:52 被阅读0次

1.向线程池提交的任务是啥?

参考父类AbstractExecutorService#submit方法:ThreadPoolExecutor extends AbstractExecutorService

    public Future<?> submit(Runnable task) {
        if (task == null) throw new NullPointerException();
        RunnableFuture<Void> ftask = newTaskFor(task, null);
        execute(ftask);
        return ftask;
    }

    /**
     * @throws RejectedExecutionException {@inheritDoc}
     * @throws NullPointerException       {@inheritDoc}
     */
    public <T> Future<T> submit(Runnable task, T result) {
        if (task == null) throw new NullPointerException();
        RunnableFuture<T> ftask = newTaskFor(task, result);
        execute(ftask);
        return ftask;
    }

    /**
     * @throws RejectedExecutionException {@inheritDoc}
     * @throws NullPointerException       {@inheritDoc}
     */
    public <T> Future<T> submit(Callable<T> task) {
        if (task == null) throw new NullPointerException();
        RunnableFuture<T> ftask = newTaskFor(task);
        execute(ftask);
        return ftask;
    }
    protected <T> RunnableFuture<T> newTaskFor(Runnable runnable, T value) {
        return new FutureTask<T>(runnable, value);
    }

可见,Runnable和Callable都会被封装成FutureTask,提交到线程池里面去。

2.FutureTask的核心属性

    / * Possible state transitions:
     * NEW -> COMPLETING -> NORMAL
     * NEW -> COMPLETING -> EXCEPTIONAL
     * NEW -> CANCELLED
     * NEW -> INTERRUPTING -> INTERRUPTED
     */
    //表示当前task状态
    private volatile int state;
    //当前任务尚未执行
    private static final int NEW          = 0;
    //当前任务正在结束,尚未完全结束,一种临界状态
    private static final int COMPLETING   = 1;
    //当前任务正常结束
    private static final int NORMAL       = 2;
    //当前任务执行过程中发生了异常。 内部封装的 callable.run() 向上抛出异常了
    private static final int EXCEPTIONAL  = 3;
    //当前任务被取消
    private static final int CANCELLED    = 4;
    //当前任务中断中..
    private static final int INTERRUPTING = 5;
    //当前任务已中断
    private static final int INTERRUPTED  = 6;

    /** The underlying callable; nulled out after running */
    //submit(runnable/callable)   runnable 使用 装饰者模式 伪装成 Callable了。
    private Callable<V> callable;
    /** The result to return or exception to throw from get() */
    //正常情况下:任务正常执行结束,outcome保存执行结果。 callable 返回值。
    //非正常情况:callable向上抛出异常,outcome保存异常
    private Object outcome; // non-volatile, protected by state reads/writes
    /** The thread running the callable; CASed during run() */
    //当前任务被线程执行期间,保存当前执行任务的线程对象引用。
    private volatile Thread runner;
    /** Treiber stack of waiting threads */
    //因为会有很多线程去get当前任务的结果,所以 这里使用了一种数据结构 stack 头插 头取 的一个队列。
    private volatile WaitNode waiters;

3.执行提交到线程池的任务FutureTask#run()

调用栈:

  • submit
  • execute
  • addWorker
  • thread.start()
  • Worker#run
  • runWorker()
  • task.run()
  • FutureTask#run()
    //submit(runnable/callable) -> newTaskFor(runnable) -> execute(task)   -> pool
    //任务执行入口
    public void run() {
        //条件一:state != NEW 条件成立,说明当前task已经被执行过了 或者 被cancel 了,总之非NEW状态的任务,线程就不处理了。
        //条件二:!UNSAFE.compareAndSwapObject(this, runnerOffset,null, Thread.currentThread())
        //       条件成立:cas失败,当前任务被其它线程抢占了...
        if (state != NEW ||
                !UNSAFE.compareAndSwapObject(this, runnerOffset,
                        null, Thread.currentThread()))
            return;

        //执行到这里,当前task一定是 NEW 状态,而且 当前线程也抢占TASK成功!

        try {
            //callable 就是程序员自己封装逻辑的callable 或者 装饰后的runnable
            Callable<V> c = callable;
            //条件一:c != null 防止空指针异常
            //条件二:state == NEW 防止外部线程 cancel掉当前任务。
            if (c != null && state == NEW) {

                //结果引用
                V result;
                //true 表示callable.run 代码块执行成功 未抛出异常
                //false 表示callable.run 代码块执行失败 抛出异常
                boolean ran;

                try {
                    //调用程序员自己实现的callable 或者 装饰后的runnable
                    result = c.call();
                    //c.call未抛出任何异常,ran会设置为true 代码块执行成功
                    ran = true;
                } catch (Throwable ex) {
                    //说明程序员自己写的逻辑块有bug了。
                    result = null;
                    ran = false;
                    setException(ex);
                }



                if (ran)
                    //说明当前c.call正常执行结束了。
                    //set就是设置结果到outcome
                    set(result);
            }
        } finally {
            // runner must be non-null until state is settled to
            // prevent concurrent calls to run()
            runner = null;
            // state must be re-read after nulling runner to prevent
            // leaked interrupts
            int s = state;
            if (s >= INTERRUPTING)
                //回头再说..讲了 cancel() 就明白了。
                handlePossibleCancellationInterrupt(s);
        }
    }

任务执行异常setException(ex)

    protected void setException(Throwable t) {
        //使用CAS方式设置当前任务状态为 完成中..
        //有没有可能失败呢? 外部线程等不及了,直接在set执行CAS之前 将  task取消了。  很小概率事件。
        if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
            //引用的是 callable 向上层抛出来的异常。
            outcome = t;
            //将当前任务的状态 修改为 EXCEPTIONAL
            UNSAFE.putOrderedInt(this, stateOffset, EXCEPTIONAL); // final state
            //回头讲完 get() 。
            finishCompletion();
        }
    }

任务执行正常set(result)

    protected void set(V v) {
        //使用CAS方式设置当前任务状态为 完成中..
        //有没有可能失败呢? 外部线程等不及了,直接在set执行CAS之前 将  task取消了。  很小概率事件。
        if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {

            outcome = v;
            //将结果赋值给 outcome之后,马上会将当前任务状态修改为 NORMAL 正常结束状态。
            UNSAFE.putOrderedInt(this, stateOffset, NORMAL); // final state

            //猜一猜?
            //最起码得把get() 再此阻塞的线程 唤醒..
            finishCompletion();
        }
    }

任务执行完成后(无论是异常还是正常),都会唤醒阻塞在该FutureTask的所有线程。

    private void finishCompletion() {
        // assert state > COMPLETING;
        //q指向waiters 链表的头结点。
        for (WaitNode q; (q = waiters) != null;) {

            //使用cas设置 waiters 为 null 是因为怕 外部线程使用 cancel 取消当前任务 也会触发finishCompletion方法。 小概率事件。
            if (UNSAFE.compareAndSwapObject(this, waitersOffset, q, null)) {
                for (;;) {
                    //获取当前node节点封装的 thread
                    Thread t = q.thread;
                    //条件成立:说明当前线程不为null
                    if (t != null) {

                        q.thread = null;//help GC
                        //唤醒当前节点对应的线程
                        LockSupport.unpark(t);
                    }
                    //next 当前节点的下一个节点
                    WaitNode next = q.next;

                    if (next == null)
                        break;

                    q.next = null; // unlink to help gc
                    q = next;
                }

                break;
            }
        }

        done();

        //将callable 设置为null helpGC
        callable = null;        // to reduce footprint
    }

这里为啥中断时要如此处理?

等待cancel方法的线程把t.interrupt()执行完。不然执行run方法的线程把当前任务都执行完了,cancel方法的线程再执行t.interrupt(),这个中断状态就带给下一个任务,就乱套了。

    /**
     * Ensures that any interrupt from a possible cancel(true) is only
     * delivered to a task while in run or runAndReset.
     */
    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();
    }

4.get()

    //场景:多个线程等待当前任务执行完成后的结果...
    public V get() throws InterruptedException, ExecutionException {
        //获取当前任务状态
        int s = state;
        //条件成立:未执行、正在执行、正完成。 调用get的外部线程会被阻塞在get方法上。
        if (s <= COMPLETING)
            //返回task当前状态,可能当前线程在里面已经睡了一会了..
            s = awaitDone(false, 0L);

        return report(s);
    }

awaitDone可分为两部分来看:
第一部分,是线程阻塞;

  • 第一次自旋,当前线程还未创建 WaitNode 对象,此时为当前线程创建 WaitNode对象
  • 第二次自旋,线程CAS入队(头插法)
  • 第三次自旋,线程park阻塞

第二部分,线程被唤醒后;

  • 线程被中断,会从等待链表中出队,并抛出中断异常
  • 任务FutureTask已经有结果,则返回当前状态
    private int awaitDone(boolean timed, long nanos)
            throws InterruptedException {
        //0 不带超时
        final long deadline = timed ? System.nanoTime() + nanos : 0L;
        //引用当前线程 封装成 WaitNode 对象
        WaitNode q = null;
        //表示当前线程 waitNode对象 有没有 入队/压栈
        boolean queued = false;
        //自旋
        for (;;) {

            //条件成立:说明当前线程唤醒 是被其它线程使用中断这种方式喊醒的。interrupted()
            //返回true 后会将 Thread的中断标记重置回false.
            if (Thread.interrupted()) {
                //当前线程node出队
                removeWaiter(q);
                //get方法抛出 中断异常。
                throw new InterruptedException();
            }

            //假设当前线程是被其它线程 使用unpark(thread) 唤醒的话。会正常自旋,走下面逻辑。

            //获取当前任务最新状态
            int s = state;
            //条件成立:说明当前任务 已经有结果了.. 可能是好 可能是 坏..
            if (s > COMPLETING) {

                //条件成立:说明已经为当前线程创建过node了,此时需要将 node.thread = null helpGC
                if (q != null)
                    q.thread = null;
                //直接返回当前状态.
                return s;
            }
            //条件成立:说明当前任务接近完成状态...这里让当前线程再释放cpu ,进行下一次抢占cpu。
            else if (s == COMPLETING) // cannot time out yet
                Thread.yield();
            //条件成立:第一次自旋,当前线程还未创建 WaitNode 对象,此时为当前线程创建 WaitNode对象
            else if (q == null)
                q = new WaitNode();
            //条件成立:第二次自旋,当前线程已经创建 WaitNode对象了,但是node对象还未入队
            else if (!queued){
                //当前线程node节点 next 指向 原 队列的头节点   waiters 一直指向队列的头!
                q.next = waiters;
                //cas方式设置waiters引用指向 当前线程node, 成功的话 queued == true 否则,可能其它线程先你一步入队了。
                queued = UNSAFE.compareAndSwapObject(this, waitersOffset, waiters, q);
            }
            //第三次自旋,会到这里。
            else if (timed) {
                nanos = deadline - System.nanoTime();
                if (nanos <= 0L) {
                    removeWaiter(q);
                    return state;
                }
                LockSupport.parkNanos(this, nanos);
            }
            else
                //当前get操作的线程就会被park了。  线程状态会变为 WAITING状态,相当于休眠了..
                //除非有其它线程将你唤醒  或者 将当前线程 中断。
                LockSupport.park(this);
        }
    }

这里就是返回任务结果。

    private V report(int s) throws ExecutionException {
        //正常情况下,outcome 保存的是callable运行结束的结果
        //非正常,保存的是 callable 抛出的异常。
        Object x = outcome;
        //条件成立:当前任务状态正常结束
        if (s == NORMAL)
            //直接返回callable运算结果
            return (V)x;

        //被取消状态
        if (s >= CANCELLED)
            throw new CancellationException();

        //执行到这,说明callable接口实现中,是有bug的...
        throw new ExecutionException((Throwable)x);
    }

5.cancel()

    public boolean cancel(boolean mayInterruptIfRunning) {
        //条件一:state == NEW 成立 表示当前任务处于运行中 或者 处于线程池 任务队列中..
        //条件二:UNSAFE.compareAndSwapInt(this, stateOffset, NEW, mayInterruptIfRunning ? INTERRUPTING : CANCELLED))
        //      条件成立:说明修改状态成功,可以去执行下面逻辑了,否则 返回false 表示cancel失败。
        if (!(state == NEW &&
                UNSAFE.compareAndSwapInt(this, stateOffset, NEW,
                        mayInterruptIfRunning ? INTERRUPTING : CANCELLED)))
            return false;

        try {    // in case call to interrupt throws exception
            if (mayInterruptIfRunning) {
                try {
                    //执行当前FutureTask 的线程,有可能现在是null,是null 的情况是: 当前任务在 队列中,还没有线程获取到它呢。。
                    Thread t = runner;
                    //条件成立:说明当前线程 runner ,正在执行task.
                    if (t != null)
                        //给runner线程一个中断信号.. 如果你的程序是响应中断 会走中断逻辑..假设你程序不是响应中断的..啥也不会发生。
                        t.interrupt();
                } finally { // final state
                    //设置任务状态为 中断完成。
                    UNSAFE.putOrderedInt(this, stateOffset, INTERRUPTED);
                }
            }

        } finally {
            //唤醒所有get() 阻塞的线程。
            finishCompletion();
        }

        return true;
    }

6.总结

这里异步协作分为两类线程:

  • 1)提交任务到线程池,并等待任务执行结果的线程
  • 2)执行任务的线程

这两类线程通过FutureTask进行协作:

  • 1)等待任务结果的线程阻塞在FutureTask#get()
  • 2)执行任务的线程FutureTask#run()执行完会设置任务结果到FutureTask的outcome中去,并唤醒阻塞在FutureTask上的线程
  • 3)阻塞在FutureTask上的线程被唤醒后,会从outcome获取任务结果返回

总体来说,任务结果分为三类:

  • 1)正常的结果
  • 2)任务被取消CancellationException,此时会对执行任务的线程池中线程进行interrupt中断,然后唤醒阻塞在FutureTask上的线程
  • 3)任务本身执行异常ExecutionException
  • 4)等待任务结果的线程本身被中断,会抛出InterruptedException

相关文章

网友评论

      本文标题:FutureTask源码剖析

      本文链接:https://www.haomeiwen.com/subject/ypkyfdtx.html