FutureTask 概览

最新推荐文章于 2023-07-01 13:00:00 发布

张伯毅

最新推荐文章于 2023-07-01 13:00:00 发布

阅读量452

点赞数

分类专栏：多线程 JAVA

本文链接：https://blog.csdn.net/zhanglong_4444/article/details/95856787

版权

JAVA 同时被 2 个专栏收录

56 篇文章 4 订阅

订阅专栏

多线程

24 篇文章 1 订阅

订阅专栏

概念

FutureTask一个可取消的异步计算，FutureTask 实现了Future的基本方法，提空 start cancel 操作，可以查询计算是否已经完成，并且可以获取计算的结果。结果只可以在计算完成之后获取，get方法会阻塞当计算没有完成的时候，一旦计算已经完成，那么计算就不能再次启动或是取消。

一个FutureTask 可以用来包装一个 Callable 或是一个runnable对象。因为FurtureTask实现了Runnable方法，所以一个 FutureTask可以提交(submit)给一个Excutor执行(excution).

FutureTask既能当做一个Runnable直接被Thread执行，也能作为Future用来得到Callable的计算结果。

场景

FutureTask可用于异步获取执行结果或取消执行任务的场景。通过传入Runnable或者Callable的任务给FutureTask，直接调用其run方法或者放入线程池执行，之后可以在外部通过FutureTask的get方法异步获取执行结果，因此，FutureTask非常适合用于耗时的计算，主线程可以在完成自己的任务后，再去获取结果。另外，FutureTask还可以确保即使调用了多次run方法，它都只会执行一次Runnable或者Callable任务，或者通过cancel取消FutureTask的执行等。

Callable与Runnable

java.lang.Runnable，它是一个接口，在它里面只声明了一个run()方法：

由于run()方法返回值为void类型，所以在执行完任务之后无法返回任何结果。

@FunctionalInterface
public interface Runnable {
    /**
     * When an object implementing interface <code>Runnable</code> is used
     * to create a thread, starting the thread causes the object's
     * <code>run</code> method to be called in that separately executing
     * thread.
     * <p>
     * The general contract of the method <code>run</code> is that it may
     * take any action whatsoever.
     *
     * @see     java.lang.Thread#run()
     */
    public abstract void run();
}

Callable位于java.util.concurrent包下，它也是一个接口，在它里面也只声明了一个方法，只不过这个方法叫做call()：

可以看到，这是一个泛型接口，call()函数返回的类型就是传递进来的V类型。

@FunctionalInterface
public interface Callable<V> {
    /**
     * Computes a result, or throws an exception if unable to do so.
     *
     * @return computed result
     * @throws Exception if unable to compute a result
     */
    V call() throws Exception;
}

使用样例:

FutureTask既能当做一个Runnable直接被Thread执行，也能作为Future用来得到Callable的计算结果。


import java.util.concurrent.*;

public class CallableTest implements Callable {

    public static void main(String[] args) throws Exception {

        Task task = new Task();

        //todo ------ 方案一  -------------


        FutureTask<Integer> futureTask = new FutureTask<Integer>(task);
        Thread thread = new Thread(futureTask);
        thread.start();

        int sum = futureTask.get();

        System.out.println("resoult: "+sum);



        //todo ------ 方案二  -------------
        ExecutorService executor = Executors.newCachedThreadPool();


        Future<Integer> sumFuture = executor.submit(task);



        int  rs = futureTask.get();

        System.out.println("resoult: "+rs);



    }


    @Override
    public String call() throws Exception {
        return "hello world";
    }
}

class Task implements Callable<Integer>{
    @Override
    public Integer call() throws Exception {
        System.out.println("子线程在进行计算");
        Thread.sleep(3000);
        int sum = 0;
        for(int i=0;i<100;i++)
            sum += i;
        return sum;
    }
}

FutureTask 源码解析

常量

任务状态

    private volatile int state;
    private static final int NEW          = 0;   //todo 初始状态
    private static final int COMPLETING   = 1;   //todo 执行中状态
    private static final int NORMAL       = 2;   //todo 正常运行结束状态
    private static final int EXCEPTIONAL  = 3;   //todo 运行中状态
    private static final int CANCELLED    = 4;   //todo 任务被取消状态
    private static final int INTERRUPTING = 5;   //todo 任务正在被取消状态
    private static final int INTERRUPTED  = 6;   //todo 任务已经被取消状态


    /** The underlying callable; nulled out after running */
    private Callable<V> callable;
    /** The result to return or exception to throw from get() */
    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 */
    private volatile WaitNode waiters;

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。这是一个最终态。

ps：所有值大于COMPLETING的状态都表示任务已经执行完成(任务正常执行完成，任务执行异常或者任务被取消)。

ScheduledFutureTask 内部还有一个变量 period 用来表示任务的类型，任务类型如下

period=0，说明当前任务是一次性的，执行完毕后就退出了。
period为负数，说明当前任务为 fixed-delay任务，是固定延迟的定时可重复执行任务。
•period为正数，说明当前任务为 fixed-rate任务， 是固定频率的定时可重复执行任务。

构造方法

入参是 Callable 类型

    public FutureTask(Callable<V> callable) {
        if (callable == null)
            throw new NullPointerException();
        this.callable = callable;
        this.state = NEW;       // ensure visibility of callable
    }

入参是 Runnable 类型

这个构造函数会把传入的Runnable封装成一个Callable对象保存在callable字段中，同时如果任务执行成功的话就会返回传入的result。这种情况下如果不需要返回值的话可以传入一个null。

    // 如果 runnable 方法带有返回值, 则 转换为 callable 类型 [RunnableAdapter ]
    public FutureTask(Runnable runnable, V result) {
        this.callable = Executors.callable(runnable, result);
        this.state = NEW;       // ensure visibility of callable
    }

    public static <T> Callable<T> callable(Runnable task, T result) {
        if (task == null)
            throw new NullPointerException();
        return new RunnableAdapter<T>(task, result);
    }

    static final class RunnableAdapter<T> implements Callable<T> {
        final Runnable task;
        final T result;
        RunnableAdapter(Runnable task, T result) {
            this.task = task;
            this.result = result;
        }
        public T call() {
            task.run();
            return result;
        }
    }

run 方法

在线程运行的时候,执行的其实是run方法,并获得返回值.

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

run()方法首先会

判断当前任务的state是否等于NEW,如果不为NEW则说明任务或者已经执行过，或者已经被取消，直接返回。
如果状态为NEW则接着会通过unsafe类把任务执行线程引用CAS的保存在runner字段中，如果保存失败，则直接返回。
执行任务。
如果任务执行发生异常，则调用setException()方法保存异常信息。否则执行set()设置结果和状态值。
任务如果是被中断的，执行 handlePossibleCancellationInterrupt()处理状态和中断响应。

     public void run() {
        // todo 状态如果不是NEW，说明任务或者已经执行过，或者已经被取消，直接返回
        // todo 状态如果是NEW，则尝试把当前执行线程保存在runner字段(runnerOffset)中，如果赋值失败则直接返回
        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 {
                    // todo 执行任务  计算逻辑
                    result = c.call();
                    ran = true;
                } catch (Throwable ex) {
                    result = null;
                    ran = false;
                    // todo 任务异常处理
                    setException(ex);
                }
                if (ran)
                    // todo 任务正常执行完毕
                    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;
            // todo 如果任务被中断，执行中断处理
            if (s >= INTERRUPTING)
                handlePossibleCancellationInterrupt(s);
        }
    }

get 方法

获取返回结果

    public V get() throws InterruptedException, ExecutionException {
        int s = state;
        //todo 如果线程正在执行的时候,阻塞获取结果
        if (s <= COMPLETING)
            s = awaitDone(false, 0L);
        return report(s);
    }

awaitDone 方法

在获取结果. get 方法的时候, 会调用 awaitDone 判断参数是否返回.

awaitDone()中有个死循环，每一次循环都会：

判断调用get()的线程是否被其他线程中断，如果是的话则在等待队列中删除对应节点然后抛出InterruptedException异常。
获取任务当前状态，如果当前任务状态大于COMPLETING则表示任务执行完成，则把thread字段置null并返回结果。
如果任务处于COMPLETING状态，则表示任务已经处理完成(正常执行完成或者执行出现异常)，但是执行结果或者异常原因还没有保存到outcome字段中。这个时候调用线程让出执行权让其他线程优先执行。
如果等待节点为空，则构造一个等待节点WaitNode。
如果第四步中新建的节点还没如队列，则CAS的把该节点加入waiters队列的首节点。
阻塞等待。

    private int awaitDone(boolean timed, long nanos)
            throws InterruptedException {

        // todo 计算等待截止时间
        final long deadline = timed ? System.nanoTime() + nanos : 0L;
        WaitNode q = null;
        boolean queued = false;

        // todo 自旋
        for (;;) {

            //todo  1. 判断阻塞线程是否被中断,
            //         如果被中断则在等待队列中删除该节点并抛出InterruptedException异常
            if (Thread.interrupted()) {
                removeWaiter(q);
                throw new InterruptedException();
            }

            // todo 2. 获取当前状态，如果状态大于COMPLETING
            //         说明任务已经结束(要么正常结束，要么异常结束，要么被取消)
            //         则把thread显示置空，并返回结果
            int s = state;
            if (s > COMPLETING) {
                if (q != null)
                    q.thread = null;
                return s;
            }

            // todo  3. 如果状态处于中间状态COMPLETING
            //          表示任务已经结束但是任务执行线程还没来得及给outcome赋值
            //          这个时候让出执行权让其他线程优先执行
            else if (s == COMPLETING) // cannot time out yet
                Thread.yield();

            // todo  4. 如果等待节点为空，则构造一个等待节点
            else if (q == null)
                q = new WaitNode();

            // todo  5. 如果还没有入队列，则把当前节点加入waiters首节点并替换原来waiters
            else if (!queued)
                queued = UNSAFE.compareAndSwapObject(this, waitersOffset,
                        q.next = waiters, q);

            //todo  如果需要等待特定时间，则先计算要等待的时间
            //      如果已经超时，则删除对应节点并返回对应的状态
            else if (timed) {
                nanos = deadline - System.nanoTime();
                if (nanos <= 0L) {
                    removeWaiter(q);
                    return state;
                }

                //todo 6. 阻塞等待特定时间
                LockSupport.parkNanos(this, nanos);
            }
            else
                // todo 6. 阻塞等待直到被其他线程唤醒
                LockSupport.park(this);
        }
    }

假设当前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循环，进行阻塞等待。要么阻塞特定时间，要么一直阻塞知道被其他线程唤醒。

finishCompletion 方法

不管是任务执行异常还是任务正常执行完毕，或者取消任务，最后都会调用finishCompletion()方法

依次遍历waiters链表，唤醒节点中的线程，然后把callable置空。

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

    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();

        callable = null;        // to reduce footprint
    }

report 方法

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

    //todo report()方法用在get()方法中，作用是把不同的任务状态映射成任务执行结果。
    @SuppressWarnings("unchecked")
    private V report(int s) throws ExecutionException {
        Object x = outcome;
        if (s == NORMAL)
            return (V)x;
        if (s >= CANCELLED)
            throw new CancellationException();
        throw new ExecutionException((Throwable)x);
    }

总结

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

有个值得关注的问题就是当任务还在执行的时候用户调用cancel(true)方法能否真正让任务停止执行呢？

当调用cancel(true)方法的时候，实际执行还是Thread.interrupt()方法，而interrupt()方法只是设置中断标志位，如果被中断的任务执行线程处于sleep()、wait()或者join()逻辑中则会抛出InterruptedException异常。因此结论是:cancel(true)并不一定能够停止正在执行的异步任务。

参考: https://www.cnblogs.com/wade-luffy/p/7073827.html

张伯毅

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
FutureTask 概览

概念FutureTask一个可取消的异步计算，FutureTask 实现了Future的基本方法，提空 start cancel 操作，可以查询计算是否已经完成，并且可以获取计算的结果。结果只可以在计算完成之后获取，get方法会阻塞当计算没有完成的时候，一旦计算已经完成，那么计算就不能再次启动或是取消。一个FutureTask 可以用来包装一个 Callable 或是一个runnable对...
复制链接

扫一扫