1. 程式人生 > >Callable、Future和FutureTask原理解析

Callable、Future和FutureTask原理解析

返回結果的任務Callable與Future

Executor框架使用Runnable作為其基本的任務表示形式。Runnable是一種有很大侷限的抽象,它不能返回一個值或丟擲一個受檢查的異常。Runnable介面:

public interface Runnable {
    public abstract void run();
}
  • 1
  • 2
  • 3

由於run()方法返回值為void型別,所以在執行完任務之後無法返回任何結果。

許多工實際上都是存在延遲的計算,對於這些任務,Callable是一種更好的抽象:它會返回一個值,並可能丟擲一個異常。Callable介面:

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; }
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9

可以看到,這是一個泛型介面,call()函式返回的型別就是傳遞進來的V型別。

Runnable和Callable描述的都是抽象的計算任務。這些任務通常是有生命週期的。Executor執行的任務有4個生命週期階段:建立、提交、開始和完成。由於有些任務可能要執行很長時間,因此通常希望可以取消這些任務。在Executor框架中,已提交但尚未開始的任務可以取消,對於已經開始執行的任務,只有當它們響應中斷時才能取消。

Future表示一個任務的生命週期,並提供了方法來判斷是否已經完成或取消,以及獲取任務的結果和取消任務等。Future介面:

public interface Future<V> {
    boolean cancel(boolean mayInterruptIfRunning);

    boolean isCancelled();

    boolean isDone();

    V get() throws InterruptedException, ExecutionException;

    V get(long timeout, TimeUnit unit)
        throws InterruptedException, ExecutionException, TimeoutException;
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12

在Future介面中聲明瞭5個方法,下面依次解釋每個方法的作用:

  1. cancel方法用來取消任務,如果取消任務成功則返回true,如果取消任務失敗則返回false。引數mayInterruptIfRunning表示是否允許取消正在執行卻沒有執行完畢的任務,如果設定true,則表示可以取消正在執行過程中的任務。如果任務已經完成,則無論mayInterruptIfRunning為true還是false,此方法肯定返回false,即如果取消已經完成的任務會返回false;如果任務正在執行,若mayInterruptIfRunning設定為true,則返回true,若mayInterruptIfRunning設定為false,則返回false;如果任務還沒有執行,則無論mayInterruptIfRunning為true還是false,肯定返回true。

  2. isCancelled方法表示任務是否被取消成功,如果在任務正常完成前被取消成功,則返回 true。

  3. isDone方法表示任務是否已經完成,若任務完成,則返回true;

  4. get()方法用來獲取執行結果,這個方法會產生阻塞,會一直等到任務執行完畢才返回;

  5. get(long timeout, TimeUnit unit)用來獲取執行結果,如果在指定時間內,還沒獲取到結果,就直接返回null。

也就是說實際上Future提供了三種功能:

  1. 判斷任務是否完成;
  2. 中斷任務;
  3. 獲取任務執行結果。

Future與Callable的關係與ExecutorService與Executor的關係對應。

FutureTask

Future只是一個介面,無法直接建立物件,因此有了FutureTask。
我們先來看下FutureTask的實現:

public class FutureTask<V> implements RunnableFuture<V>
  • 1

FutureTask類實現了RunnableFuture介面:

public interface RunnableFuture<V> extends Runnable, Future<V> {
    void run();
}
  • 1
  • 2
  • 3

RunnableFuture繼承了Runnable和Future介面,而FutureTask實現了RunnableFuture介面。

FutureTask的繼承關係和方法如圖所示:
FutureTask

FutureTask是一個可取消的非同步計算,FutureTask 實現了Future的基本方法,提供start cancel 操作,可以查詢計算是否已經完成,並且可以獲取計算的結果。結果只可以在計算完成之後獲取,get方法會阻塞當計算沒有完成的時候,一旦計算已經完成, 那麼計算就不能再次啟動或是取消。

一個FutureTask 可以用來包裝一個 Callable 或是一個Runnable物件。因為FurtureTask實現了Runnable方法,所以一個 FutureTask可以提交(submit)給一個Excutor執行(excution). 它同時實現了Callable, 所以也可以作為Future得到Callable的返回值。

FutureTask有兩個很重要的屬性分別是state和runner, FutureTask之所以支援canacel操作,也是因為這兩個屬性。
其中state為列舉值:

    private volatile int state; // 注意volatile關鍵字
    /**
     * 在構建FutureTask時設定,同時也表示內部成員callable已成功賦值,
     * 一直到worker thread完成FutureTask中的run();
     */
    private static final int NEW = 0;

    /**
     * woker thread在處理task時設定的中間狀態,處於該狀態時,
     * 說明worker thread正準備設定result.
     */
    private static final int COMPLETING = 1;

    /**
     * 當設定result結果完成後,FutureTask處於該狀態,代表過程結果,
     * 該狀態為最終狀態final state,(正確完成的最終狀態)
     */
    private static final int NORMAL = 2;

    /**
     * 同上,只不過task執行過程出現異常,此時結果設值為exception,
     * 也是final state
     */
    private static final int EXCEPTIONAL = 3;

    /**
     * final state, 表明task被cancel(task還沒有執行就被cancel的狀態).
     */
    private static final int CANCELLED = 4;

    /**
     * 中間狀態,task執行過程中被interrupt時,設定的中間狀態
     */
    private static final int INTERRUPTING = 5;

    /**
     * final state, 中斷完畢的最終狀態,幾種情況,下面具體分析
     */
    private static final int INTERRUPTED = 6;
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39

state初始化為NEW。只有在set, setException和cancel方法中state才可以轉變為終態。在任務完成期間,state的值可能為COMPLETING或INTERRUPTING。
state有四種可能的狀態轉換:

  • NEW -> COMPLETING -> NORMAL
  • NEW -> COMPLETING -> EXCEPTIONAL
  • NEW -> CANCELLED
  • NEW -> INTERRUPTING -> INTERRUPTED

其他成員變數:

    /** The underlying callable; nulled out after running */
    private Callable<V> callable;   // 具體run執行時會呼叫其方法call(),並獲得結果,結果時置為null.

    /** The result to return or exception to throw from get() */
    private Object outcome; // non-volatile, protected by state reads/writes   沒必要為votaile,因為其是伴隨state 進行讀寫,而state是FutureTask的主導因素。

    /** The thread running the callable; CASed during run() */
    private volatile Thread runner;   //具體的worker thread.

    /** Treiber stack of waiting threads */  
    private volatile WaitNode waiters;     //Treiber stack 併發stack資料結構,用於存放阻塞在該futuretask#get方法的執行緒。
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11

下面分析下Task的狀態變化,也就一個任務的生命週期:
建立一個FutureTask首先呼叫構造方法:

 public FutureTask(Runnable runnable, V result) {
        this.callable = Executors.callable(runnable, result);
        this.state = NEW;       // ensure visibility of callable
 }
  • 1
  • 2
  • 3
  • 4

此時將state設定為初始態NEW。這裡注意Runnable是怎樣轉換為Callable的,看下this.callable = Executors.callable(runnable, result); 呼叫Executors.callable:

public static <T> Callable<T> callable(Runnable task, T result) {
        if (task == null)
            throw new NullPointerException();
        return new RunnableAdapter<T>(task, result);
}
  • 1
  • 2
  • 3
  • 4
  • 5
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;
        }
}
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12

其實就是通過Callable的call方法呼叫Runnable的run方法,把傳入的 T result 作為callable的返回結果;

當建立完一個Task通常會提交給Executors來執行,當然也可以使用Thread來執行,Thread的start()方法會呼叫Task的run()方法。看下FutureTask的run()方法的實現:

public void run() {
        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;
                } catch (Throwable ex) {
                    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 must be re-read after nulling runner to prevent
            // leaked interrupts
            int s = state;
            if (s >= INTERRUPTING)
                handlePossibleCancellationInterrupt(s);
        }
    }
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32

首先判斷任務的狀態,如果任務狀態不是new,說明任務狀態已經改變(說明他已經走了上面4種可能變化的一種,比如caller呼叫了cancel,此時狀態為Interrupting, 也說明了上面的cancel方法,task沒執行時,就interrupt, task得不到執行,總是返回);

如果狀態是new, 判斷runner是否為null, 如果為null, 則把當前執行任務的執行緒賦值給runner,如果runner不為null, 說明已經有執行緒在執行,返回。此處使用cas來賦值worker thread是保證多個執行緒同時提交同一個FutureTask時,確保該FutureTask的run只被呼叫一次, 如果想執行多次,使用runAndReset()方法。

這裡

!UNSAFE.compareAndSwapObject(this, runnerOffset,                                   null, Thread.currentThread())
  • 1

語義相當於

if (this.runner == null ){
    this.runner = Thread.currentThread();
}
  • 1
  • 2
  • 3

接著開始執行任務,如果要執行的任務不為空,並且state為New就執行,可以看到這裡呼叫了Callable的call方法。如果執行成功則set結果,如果出現異常則setException。最後把runner設為null。

接著看下set方法:

protected void set(V v) {
        if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
            outcome = v;
            UNSAFE.putOrderedInt(this, stateOffset, NORMAL); // final state
            finishCompletion();
        }
    }
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7

如果現在的狀態是NEW就把狀態設定成COMPLETING,然後設定成NORMAL。這個執行流程的狀態變化就是: NEW->COMPLETING->NORMAL。

最後執行finishCompletion()方法:

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
 }
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24

finishCompletion()會解除所有阻塞的worker thread, 呼叫done()方法,將成員變數callable設為null。這裡使用了LockSupport類來解除執行緒阻塞,關於LockSupport,可參見:LockSupport的park和unpark的基本使用,以及對執行緒中斷的響應性

接下來分析FutureTask非常重要的get方法:

    public V get() throws InterruptedException, ExecutionException {
        int s = state;
        if (s <= COMPLETING)
            s = awaitDone(false, 0L);
        return report(s);
    }
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6

首先判斷FutureTask的狀態是否為完成狀態,如果是完成狀態,說明已經執行過set或setException方法,返回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);
    }
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

可以看到,如果FutureTask的狀態是NORMAL, 即正確執行了set方法,get方法直接返回處理的結果, 如果是取消狀態,即執行了setException,則丟擲CancellationException異常。

如果get時,FutureTask的狀態為未完成狀態,則呼叫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) // cannot time out yet
                Thread.yield();
            else if (q == null)
                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
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36

awaitDone方法可以看成是不斷輪詢檢視FutureTask的狀態。在get阻塞期間:

  • 如果執行get的執行緒被中斷,則移除FutureTask的所有阻塞佇列中的執行緒(waiters),並丟擲中斷異常;

  • 如果FutureTask的狀態轉換為完成狀態(正常完成或取消),則返回完成狀態;

  • 如果FutureTask的狀態變為COMPLETING, 則說明正在set結果,此時讓執行緒等一等;

  • 如果FutureTask的狀態為初始態NEW,則將當前執行緒加入到FutureTask的阻塞執行緒中去;

  • 如果get方法沒有設定超時時間,則阻塞當前呼叫get執行緒;如果設定了超時時間,則判斷是否達到超時時間,如果到達,則移除FutureTask的所有阻塞列隊中的執行緒,並返回此時FutureTask的狀態,如果未到達時間,則在剩下的時間內繼續阻塞當前執行緒。

注:本文原始碼基於JDK1.7。(1.6通過AQS實現)