简单聊一聊FutureTask的实现

974 阅读8分钟

简介

FutureTask是一种支持取消的异步任务包装类,也就是说FutureTask执行的时候不立即返回结果,自己可以通过异步调用get方法获取结果,也可以中途调用cancel方法取消任务。而且必须要知道的就是FutureTask只是任务的包装类,并不是真正的任务类。

FutureTask实现RunnableFuture接口,而RunnableFuture继承了Runnable, Future接口。

实现

下面我们将介绍一下FutureTask的具体实现。

FutureTask状态

正是因为FutureTask只是任务执行的包装类,所以他肯定是需要很多的状态来维护任务运行的状态,不然怎么能cancel,get呢,下面我们具体来看一下。

private volatile int state;
private static final int NEW          = 0; //新建任务的状态
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; //中断完成

根据代码注释中的描述,上述的状态很有可能发生以下四种可能性:

过程 含义
NEW -> COMPLETING -> NORMAL 正常的执行过程,从开始到结束
NEW -> COMPLETING -> EXCEPTIONAL 执行过程中发生了异常
NEW -> CANCELLED 任务被取消
NEW -> INTERRUPTING -> INTERRUPTED 任务被中断

FutureTask构造方法

FutureTask的构造方法主要有两个,和我们之前讲线程池的很相似,主要是为了针对不同的任务类型

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

很简单,就是强行把runable包装成callble对象,并且返回值为传入的result。

run方法

在FutureTask中有两种执行的方式,run方法和runAndReset方法,先看一下run方法的实现。

public void run() {
   //不是NEW状态的任务无法执行
    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(); //执行
                ran = true; //正常状态下设置状态为true
            } catch (Throwable ex) {
                result = null;
                ran = false;
                setException(ex); //发生异常时,状态修改
            }
            if (ran) //正常情况下
                set(result);
        }
    } finally {
        runner = null;
        int s = state;
        if (s >= INTERRUPTING) //如果是有中断发生
            handlePossibleCancellationInterrupt(s);
    }
}

方法的逻辑非常的简单,就三件事情

1.首先就是判断任务是不是可执行的状态,如果不可以那么就结束,否则

2.执行任务,如果发生异常,进行异常状态下的设置,否则正常逻辑状态设置

3.最后在返回前进行状态设置,如果处于中断状态,设置更新状态。

异常处理

接下来我们需要看一下异常状态下的处理。

protected void setException(Throwable t) {
   //尝试设置到COMPLETING状态
    if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
        outcome = t; //设置outcome为异常对象
        UNSAFE.putOrderedInt(this, stateOffset, EXCEPTIONAL); // 最终的状态
        finishCompletion(); 
    }
}

这里就满足了我们在上面表格中介绍到的异常状态下的状态的变化过程。发生异常后还需要执行finishCompletion方法,finishCompletion的主要目的其实是唤醒所有等待获取结果的线程,所以我们把放在get方法的后面再讲。

正常结束

下面我们看一下set方法的干的事情,根据我们之前在表格中的介绍应该很容易才出来。

protected void set(V v) {
    if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
        outcome = v;
        UNSAFE.putOrderedInt(this, stateOffset, NORMAL);
        finishCompletion();
    }
}

set方法逻辑和setException逻辑类似,只是他们设置的最终状态值和outcome值不同而已。就不多说了。

发生中断

我们接着看run方法中finally中的方法

private void handlePossibleCancellationInterrupt(int s) {
    if (s == INTERRUPTING)
        while (state == INTERRUPTING)
            Thread.yield(); 
}

这里做的事情很简单,就是假如发生了中断的事件,那么此时就是释放锁,一直重试到状态变成了INTERRUPTED。

runAndReset方法

我们再看一下runAndReset方法和run方法的异同。

protected boolean runAndReset() {
    if (state != NEW ||
        !UNSAFE.compareAndSwapObject(this, runnerOffset,null, Thread.currentThread()))
        return false;
    boolean ran = false;
    int s = state;
    try {
        Callable<V> c = callable;
        if (c != null && s == NEW) {
            try {
                c.call(); // don't set result
                ran = true;
            } catch (Throwable ex) {
                setException(ex);
            }
        }
    } finally {
        runner = null;
        s = state;
        if (s >= INTERRUPTING)
            handlePossibleCancellationInterrupt(s);
    }
    return ran && s == NEW;
}

很容易看出,runAndReset在正常执行结束后是不会更改状态的,这样的话势必会造成正常情况下是无法获取程序的结果的。之所以这么做也是因为任务是要复用的,因为这个方法是用来做周期循环调度的。所以也不会改变状态,也不会设置结果值。具体的体现我们可以再ScheduleThreadPoolExecutor中具体查看。

cancel方法

上面我们介绍了中断时的状态的改变,但是我们没介绍到底是怎么产生中断的,接下来我们看一下,先说明一下其实中断和取消的方法是使用同一个方法,只是状态值不同

public boolean cancel(boolean mayInterruptIfRunning) {
   //mayInterruptIfRunning true代表中断,false代表取消
   //如果是NEW状态又执行了中断或取消,跳过,否则直接结束
    if (!(state == NEW &&
          UNSAFE.compareAndSwapInt(this, stateOffset, NEW,
              mayInterruptIfRunning ? INTERRUPTING : CANCELLED)))
        return false;
    try {  
       //中断的情况,设置线程中断
        if (mayInterruptIfRunning) {
            try {
                Thread t = runner;
                if (t != null)
                    t.interrupt();
            } finally { // final state
                UNSAFE.putOrderedInt(this, stateOffset, INTERRUPTED);
            }
        }
    } finally {
        finishCompletion();
    }
    return true;
}

我们可以看到,cancel同时具有取消和中断两种功能,

1.当我们的任务还是NEW状态,又改变状态成功,这说明任务已经无法执行了,设置线程状态,如果不处于NEW状态,或者修改状态失败则直接结束方法。

2.不满足的情况下就会判断任务是否为中断,如果中断的话就把线程的状态也设置为中断,并改变最终的状态。

3.最终也都要释放等待的线程(具体留在后面说明)。

get方法

get方法主要有两种,一种是一直等待,一种是设置超时的时间。

public V get() throws InterruptedException, ExecutionException {
    int s = state;
    if (s <= COMPLETING)
        s = awaitDone(false, 0L);
    return report(s);
}
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);
    }

如果任务的状态还小于COMPLETING,说明任务还没有完成,不管是有没有发生意外的情况。此时都要把获取结果的线程加入到等待结果的链表中,如果是已完成则直接获取结果,很简单就不多描述了。

我们在继续看看带超时时间的get方法

public V get(long timeout, TimeUnit unit)
    throws InterruptedException, ExecutionException, TimeoutException {
    if (unit == null)
        throw new NullPointerException();
    int s = state;
    if (s <= COMPLETING &&
        (s = awaitDone(true, unit.toNanos(timeout))) <= COMPLETING)
        throw new TimeoutException();
    return report(s);
}

其实抛开awaitDone方法都是一致的,所以我们直接来看一下awaitDone方法。

awaitDone方法

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) //说明马上状态就改变了,那么此时肯定不会入队了,所以让出时间片
                Thread.yield();
            else if (q == null) //说明还在NEW状态,
                q = new WaitNode();
            else if (!queued) //入队
                queued = UNSAFE.compareAndSwapObject(this, waitersOffset,
                                                     q.next = waiters, q); //设置到队列头
            else if (timed) { //如果是设置了超时时间的
                nanos = deadline - System.nanoTime();
                if (nanos <= 0L) {
                    removeWaiter(q); //移除等待的线程
                    return state;
                }
                LockSupport.parkNanos(this, nanos); //否则挂起指定时间
            }
            else
                LockSupport.park(this);
        }
    }

好,这里的所及还算是比较复杂,在这里我们简单的总结一下

1.判断线程是否有被中断,如果被中断了直接结束等待。否则

2.判断state的状态是否COMPLETING,如果大于说明要么执行完要么出了状况,可以去拿值了。直接返回,如果不满足

3.在判断是否为COMPLETING,也说明该执行的也执行了,现在在修改状态中,马上就可以拿值,所以放弃时间片,等下次来再判断。如果不满足

4.否则没有入队就入队,否则如果是设置超时时间,就判断是否已经超时,超时就移除,否则就把线程挂起指定时间。

说了那么多,很多方法都调用了finishCompletion方法,都需要释放等待结果的线程,接下来我们就一起看看其中的逻辑。

finishCompletion方法

其实实现的逻辑还是很简单的,

private void finishCompletion() {
        // 处理等待的线程链表
        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
    }

这里的逻辑也是非常简单就是唤醒所有等待的线程,如果还没处理完毕,又会被挂起。

总结

本文从run方法,get方法,cancel方法以及他们所涉及到的方法总体上弄清楚了FutureTask的功能。

1.FutureTask只是任务的包装类,真正的执行的逻辑不在其中。

2.一定要弄清楚FutureTask的几种状态值,非常重要。

3.只有NEW状态的任务才能被执行,run方法运行后正常情况下会改变state的值,而runAndReset不会,因为两种方法的场景不同。

4.runAndReset调度任务,发生异常任务就会终止后面的调度。

目前FutureTask主要是用于线程池中,用于异步获取执行结果和线程池的调度上。

最后

此文章都是个人的理解并整理,如果存在什么逻辑上的疏漏或者表述不当,欢迎吐槽反馈!!

与君共勉!!!