線程池續(xù):你必須要知道的線程池submit()實現(xiàn)原理之FutureTask!

FutureTask思維導(dǎo)圖.png

前言

上一篇內(nèi)容寫了Java中線程池的實現(xiàn)原理及源碼分析,說好的是實實在在的大滿足,想通過一篇文章讓大家對線程池有個透徹的了解,但是文章寫完總覺得還缺點什么?

上篇文章只提到線程提交的execute()方法,并沒有講解線程提交的submit()方法,submit()有一個返回值,可以獲取線程執(zhí)行的結(jié)果Future<T>,這一講就那深入學(xué)習(xí)下submit()FutureTask實現(xiàn)原理。

使用場景&示例

使用場景

我能想到的使用場景就是在并行計算的時候,例如一個方法中調(diào)用methodA()、methodB(),我們可以通過線程池異步去提交方法A、B,然后在主線程中獲取組裝方法A、B計算后的結(jié)果,能夠大大提升方法的吞吐量。

使用示例

/**
 * @author wangmeng
 * @date 2020/5/28 15:30
 */
public class FutureTaskTest {
    public static void main(String[] args) throws InterruptedException, ExecutionException {
        ExecutorService threadPool = Executors.newCachedThreadPool();

        System.out.println("====執(zhí)行FutureTask線程任務(wù)====");
        Future<String> futureTask = threadPool.submit(new Callable<String>() {
            @Override
            public String call() throws Exception {
                System.out.println("FutureTask執(zhí)行業(yè)務(wù)邏輯");
                Thread.sleep(2000);
                System.out.println("FutureTask業(yè)務(wù)邏輯執(zhí)行完畢!");
                return "歡迎關(guān)注: 一枝花算不算浪漫!";
            }
        });

        System.out.println("====執(zhí)行主線程任務(wù)====");
        Thread.sleep(1000);
        boolean flag = true;
        while(flag){
            if(futureTask.isDone() && !futureTask.isCancelled()){
                System.out.println("FutureTask異步任務(wù)執(zhí)行結(jié)果:" + futureTask.get());
                flag = false;
            }
        }

        threadPool.shutdown();
    }
}

上面的使用很簡單,submit()內(nèi)部傳遞的實際上是個Callable接口,我們自己實現(xiàn)其中的call()方法,我們通過futureTask既可以獲取到具體的返回值。

submit()實現(xiàn)原理

submit() 是也是提交任務(wù)到線程池,只是它可以獲取任務(wù)返回結(jié)果,返回結(jié)果是通過FutureTask來實現(xiàn)的,先看下ThreadPoolExecutor中代碼實現(xiàn):

public class ThreadPoolExecutor extends AbstractExecutorService {
    public <T> Future<T> submit(Callable<T> task) {
        if (task == null) throw new NullPointerException();
        RunnableFuture<T> ftask = newTaskFor(task);
        execute(ftask);
        return ftask;
    }
}

public abstract class AbstractExecutorService implements ExecutorService {
    protected <T> RunnableFuture<T> newTaskFor(Callable<T> callable) {
        return new FutureTask<T>(callable);
    }
}

提交任務(wù)還是執(zhí)行execute()方法,只是task被包裝成了FutureTask ,也就是在excute()中啟動線程后會執(zhí)行FutureTask.run()方法。

再來具體看下它執(zhí)行的完整鏈路圖:

submit()全鏈路圖.png

上圖可以看到,執(zhí)行任務(wù)并返回執(zhí)行結(jié)果的核心邏輯實在FutureTask中,我們以FutureTask.run/get 兩個方法為突破口,一點點剖析FutureTask的實現(xiàn)原理。

FutureTask源碼初探

先看下FutureTask中部分屬性:

FutureTask屬性.png
public class FutureTask<V> implements RunnableFuture<V> {
    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;

    private Callable<V> callable;
    private Object outcome;
    private volatile Thread runner;
    private volatile WaitNode waiters;
}
  1. state

當(dāng)前task狀態(tài),共有7中類型。
NEW: 當(dāng)前任務(wù)尚未執(zhí)行
COMPLETING: 當(dāng)前任務(wù)正在結(jié)束,尚未完全結(jié)束,一種臨界狀態(tài)
NORMAL:當(dāng)前任務(wù)正常結(jié)束
EXCEPTIONAL: 當(dāng)前任務(wù)執(zhí)行過程中發(fā)生了異常。
CANCELLED: 當(dāng)前任務(wù)被取消
INTERRUPTING: 當(dāng)前任務(wù)中斷中..
INTERRUPTED: 當(dāng)前任務(wù)已中斷

  1. callble

用戶提交任務(wù)傳遞的Callable,自定義call方法,實現(xiàn)業(yè)務(wù)邏輯

  1. outcome

任務(wù)結(jié)束時,outcome保存執(zhí)行結(jié)果或者異常信息。

  1. runner

當(dāng)前任務(wù)被線程執(zhí)行期間,保存當(dāng)前任務(wù)的線程對象引用

  1. waiters

因為會有很多線程去get當(dāng)前任務(wù)的結(jié)果,所以這里使用了一種stack數(shù)據(jù)結(jié)構(gòu)來保存

FutureTask.run()實現(xiàn)原理

我們已經(jīng)知道在線程池runWorker()中最終會調(diào)用到FutureTask.run()方法中,我們就來看下它的執(zhí)行原理吧:

run()執(zhí)行邏輯.png

具體代碼如下:

public class FutureTask<V> implements RunnableFuture<V> {
    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 = null;
            int s = state;
            if (s >= INTERRUPTING)
                handlePossibleCancellationInterrupt(s);
        }
    }
}

首先是判斷FutureTaskstate狀態(tài),必須是NEW才可以繼續(xù)執(zhí)行。

然后通過CAS修改runner引用為當(dāng)前線程。

接著執(zhí)行用戶自定義的call()方法,將返回結(jié)果設(shè)置到result中,result可能為正常返回也可能為異常信息。這里主要是調(diào)用set()/setException()

FutureTask.set()實現(xiàn)原理

set()方法的實現(xiàn)很簡單,直接看下代碼:

public class FutureTask<V> implements RunnableFuture<V> {
    protected void set(V v) {
        if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
            outcome = v;
            UNSAFE.putOrderedInt(this, stateOffset, NORMAL);
            finishCompletion();
        }
    }
}

call()返回的數(shù)據(jù)賦值給全局變量outcome上,然后修改state狀態(tài)為NORMAL,最后調(diào)用finishCompletion()來做掛起線程的喚醒操作,這個方法等到get()后面再來講解。

FutureTask.get()實現(xiàn)原理

get().png

接著看下代碼:

public class FutureTask<V> implements RunnableFuture<V> {
    public V get() throws InterruptedException, ExecutionException {
        int s = state;
        if (s <= COMPLETING)
            s = awaitDone(false, 0L);
        return report(s);
    }
}

如果FutureTaskstateNORMAL或者COMPLETING,說明當(dāng)前任務(wù)并沒有執(zhí)行完成,調(diào)用get()方法會被阻塞,具體的阻塞邏輯在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)
                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);
        }
    }

這個方法可以說是FutureTask中最核心的方法了,一步步來分析:

如果timed不為空,這說明指定nanos時間還未返回結(jié)果,線程就會退出。

q是一個WaitNode對象,是將當(dāng)前引用線程封裝在一個stack數(shù)據(jù)結(jié)構(gòu)中,WaitNode對象屬性如下:

 static final class WaitNode {
    volatile Thread thread;
    volatile WaitNode next;
    WaitNode() { thread = Thread.currentThread(); }
}

接著判斷當(dāng)前線程是否中斷,如果中斷則拋出中斷異常。

下面就進(jìn)入一輪輪的if... else if...判斷邏輯,我們還是采用分支的方式去分析。

分支一:if (s > COMPLETING) {

此時get()方法已經(jīng)有結(jié)果了,無論是正常返回的結(jié)果,還是異常、中斷、取消等,此時直接返回state狀態(tài),然后執(zhí)行report()方法。

分支二:else if (s == COMPLETING)

條件成立,說明當(dāng)前任務(wù)接近完成狀態(tài),這里讓當(dāng)前線程再釋放cpu,進(jìn)行下一輪搶占cpu

分支三:else if (q == null)

第一次自旋執(zhí)行,WaitNode還沒有初始化,初始化q=new WaitNode();

分支四:else if (!queued){

queued代表當(dāng)前線程是否入棧,如果沒有入棧則進(jìn)行入棧操作,順便將全局變量waiters指向棧頂元素。

分支五/六:LockSupport.park

如果設(shè)置了超時時間,則使用parkNanos來掛起當(dāng)前線程,否則使用park()

經(jīng)過這么一輪自旋循環(huán)后,如果執(zhí)行call()還沒有返回結(jié)果,那么調(diào)用get()方法的線程都會被掛起。

被掛起的線程會等待run()返回結(jié)果后依次喚醒,具體的執(zhí)行邏輯在finishCompletion()中。

最終stack結(jié)構(gòu)中數(shù)據(jù)如下:

WaitNode.png

FutureTask.finishCompletion()實現(xiàn)原理

finishCompletion().png

具體實現(xiàn)代碼如下:

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;
                q = next;
            }
            break;
        }
    }

    done();

    callable = null;
}

代碼實現(xiàn)很簡單,看過get()方法后,我們知道所有調(diào)用get()方法的線程,在run()還沒有返回結(jié)果前,都會保存到一個有WaitNode構(gòu)成的statck數(shù)據(jù)結(jié)構(gòu)中,而且每個線程都會被掛起。

這里是遍歷waiters棧頂元素,然后依次查詢起next節(jié)點進(jìn)行喚醒,喚醒后的節(jié)點接著會往后調(diào)用report()方法。

FutureTask.report()實現(xiàn)原理

report().png

具體代碼如下:

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

這個方法很簡單,因為執(zhí)行到了這里,說明當(dāng)前state狀態(tài)肯定大于COMPLETING,判斷如果是正常返回,那么返回outcome數(shù)據(jù)。

如果state是取消狀態(tài),拋出CancellationException異常。

如果狀態(tài)都不滿足,則說明執(zhí)行中出現(xiàn)了差錯,直接拋出ExecutionException

FutureTask.cancel()實現(xiàn)原理

cancel().png
public boolean cancel(boolean mayInterruptIfRunning) {
    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 {
                UNSAFE.putOrderedInt(this, stateOffset, INTERRUPTED);
            }
        }
    } finally {
        finishCompletion();
    }
    return true;
}

cancel()方法的邏輯很簡單,就是修改state狀態(tài)為CANCELLED,然后調(diào)用finishCompletion()來喚醒等待的線程。

這里如果mayInterruptIfRunning,就會先中斷當(dāng)前線程,然后再去喚醒等待的線程。

總結(jié)

FutureTask的實現(xiàn)原理其實很簡單,每個方法基本上都畫了一個簡單的流程圖來方便立即。

后面還打算分享一個BlockingQueue相關(guān)的源碼解讀,這樣線程池也可以算是完結(jié)了。

在這之前可能會先分享一個SpringCloud常見配置代碼分析、最佳實踐等手冊,方便工作中使用,也是對之前看過的源碼一種總結(jié)。敬請期待!

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

友情鏈接更多精彩內(nèi)容