（手機橫屏看原始碼更方便）

問題

（1）自己動手寫的執行緒池如何支援帶返回值的任務呢？

（2）如果任務執行的過程中丟擲異常了該怎麼處理呢？

簡介

上一章我們自己動手寫了一個執行緒池，但是它是不支援帶返回值的任務的，那麼，我們自己能否實現呢？必須可以，今天我們就一起來實現帶返回值任務的執行緒池。

前情回顧

首先，讓我們先回顧一下上一章寫的執行緒池：

（1）它包含四個要素：核心執行緒數、最大執行緒數、任務佇列、拒絕策略；

（2）它具有執行無返回值任務的能力；

（3）它無法處理有返回值的任務；

（4）它無法處理任務執行的異常（執行緒中的異常不會丟擲到執行緒外）；

那麼，我們能不能在現有的基礎上實現其下面兩項能力呢？讓我們一起來試一試吧！

有返回值和無返回值的任務到底有何不同？

答案很明顯，就是一個有返回值，一個無返回值，用虛擬碼來表示就是下面這樣：

    // 無返回值
    threadPool.execute(()->{
        System.out.println(1);
    });
    // 有返回值，分兩步走
    // 1. 提交任務到執行緒池中
    SomeClass result = threadPool.execute(()->{
        System.out.println(1);
        return 1;
    });
    // 2. 等待任務的結果返回
    Object value = result.get();
    
 

無返回值的任務提交了就完事，主執行緒並不Care它到底有沒有執行完，並不關心它是不是丟擲異常，主執行緒Just提交執行緒到執行緒池中，其餘什麼都不管。

有返回值的任務就不一樣了，主執行緒首先要提交任務到執行緒池中，它需要使用到任務執行的結果，所以它必須等待任務執行完畢才能拿到任務執行的結果。

那麼，為什麼不直接在execute的時候就等待任務執行完畢呢？這樣的話那不就跟序列沒啥區別了，還不如直接在主執行緒執行任務呢，還少了執行緒切換的資源消耗。

之所以要分成兩步，是因為主執行緒並不一定需要立即獲取返回值，在需要用到返回值的時候才去get，這樣就可以在提交任務和獲取返回值之間幹些其它的事情，提高效率。

所以，提交任務的時候不需要阻塞，get返回值的時候才可能需要阻塞，如果get的時候任務已經執行完畢了，這時候也不需要阻塞，如果get的時候任務還未執行完畢，那就要阻塞等待任務執行完畢才能獲取到返回值。

實現分析

首先，無返回值的任務我們直接使用的Runnable函式式介面，有返回值的任務有沒有現成的介面呢？還真有，那就是Callable介面，它有個返回值。

@FunctionalInterface
public interface Callable<v> {
    V call() throws Exception;
}

其次，提交任務的時候需要有個返回值，它是在將來用來獲取任務執行結果的，實際上它也是新任務的一種能力，可以使用它對任務進行包裝，使其具有返回值的能力。

public interface Future<t> {
    T get();
}

再次，我們需要給現有的執行緒池增加一種新的能力，根據單一職責原則，我們定義一個新的介面來承載這種能力。

public interface FutureExecutor extends Executor {
    <t> Future<t> submit(Callable<t> command);
}

然後，我們需要一種新的任務，它既具有舊任務的執行能力（run()方法），又具有新任務的返回值能力（get()方法），所以我們造一個“將來的任務”對提交的任務進行包裝，使其具有返回值的能力。

public class FutureTask<t> implements Runnable, Future<t> {

    /**
     * 真正的任務
     */
    private Callable<t> task;
    
    public FutureTask(Callable<t> task) {
        this.task = task;
    }

    @Override
    public void run() {
        // 具體實現...
    }

    @Override
    public T get() {
        // 具體實現...
    }
}

最後，我們只要對原有的執行緒池進行擴充套件，將提交的任務包裝成“將來獲取返回值的任務”，還是使用原來的方法去執行，然後返回這個將來的任務即可。

根據開閉原則，【本篇文章由公眾號“彤哥讀原始碼”原創】原來的程式碼我們不做任何修改，擴充套件新的子類來實現新的能力。

public class MyThreadPoolFutureExecutor extends MyThreadPoolExecutor implements FutureExecutor, Executor {

    public MyThreadPoolFutureExecutor(String name, int coreSize, int maxSize, BlockingQueue<runnable> taskQueue, RejectPolicy rejectPolicy) {
        super(name, coreSize, maxSize, taskQueue, rejectPolicy);
    }

    @Override
    public <t> Future<t> submit(Callable<t> task) {
        // 包裝成將來獲取返回值的任務
        FutureTask<t> futureTask = new FutureTask&lt;&gt;(task);
        // 還是使用原來的執行能力
        execute(futureTask);
        // 返回將來的任務，只需要返回其get返回值的能力即可
        // 所以這裡返回的是Future而不是FutureTask型別
        return futureTask;
    }
}

好了，到這裡整體的邏輯我們就已經比較清晰地實現完了，還剩下最關鍵的部分，這個“將來的任務”的兩個能力要如何實現。

將來的任務

將來的任務，具有兩個能力：一是執行真正任務的能力，二是將來獲取返回值的能力。

public class FutureTask<t> implements Runnable, Future<t> {
    @Override
    public void run() {
        // 具體實現...
    }

    @Override
    public T get() {
        // 具體實現...
    }
}

首先，我們要明確一件事，任務的執行是執行緒池中，獲取返回值是在主執行緒中，它們是在兩個執行緒中執行的，而且誰先誰後我們無法確定。

其次，如果run()在get()之前執行，我們需要告訴get()任務已經執行完畢了，所以需要一個狀態來通知這個事，還需要一個變數來承載任務執行的返回值。

    /**
     * 任務執行的狀態，0未開始，1正常完成，2異常完成
     * 也可以使用volatile+Unsafe實現CAS操作
     */
    private AtomicInteger state = new AtomicInteger(NEW);
    private static final int NEW = 0;
    private static final int FINISHED = 1;
    private static final int EXCEPTION = 2;
    /**
     * 任務執行的結果【本篇文章由公眾號“彤哥讀原始碼”原創】
     * 如果執行正常，返回結果為T
     * 如果執行異常，返回結果為Exception
     */
    private Object result;

再次，如果get()在run()之前執行，那就需要阻塞等待run()執行完畢才能拿到返回值，所以需要儲存呼叫者（主執行緒），get()的時候park阻塞住，run()完成了unpark喚醒它來拿返回值。

    /**
     * 呼叫者執行緒
     * 也可以使用volatile+Unsafe實現CAS操作
     */
    private AtomicReference<thread> caller = new AtomicReference&lt;&gt;();

然後，我們先來看看run()方法的邏輯，它其實就是先執行真正的任務，然後修改狀態為完成，並儲存任務的返回值，如果儲存了主執行緒，還要喚醒它。

    @Override
    public void run() {
        // 如果狀態不是NEW，說明執行過了，直接返回
        if (state.get() != NEW) {
            return;
        }
        try {
            // 執行任務【本篇文章由公眾號“彤哥讀原始碼”原創】
            T r = task.call();
            // CAS更新state的值為FINISHED
            // 如果更新成功，就把r賦值給result
            // 如果更新失敗，說明state的值不為NEW了，也就是任務已經執行過了
            if (state.compareAndSet(NEW, FINISHED)) {
                this.result = r;
                // finish()必須放在修改state裡面，見下面的分析
                finish();
            }
        } catch (Exception e) {
            // 如果CAS更新state的值為EXCEPTION成功，就把e賦值給result
            // 如果CAS更新失敗，說明state的值不為NEW了，也就是任務已經執行過了
            if (state.compareAndSet(NEW, EXCEPTION)) {
                this.result = e;
                // finish()必須放在修改state裡面，見下面的分析
                finish();
            }
        }
    }

    private void finish() {
        // 檢查呼叫者是否為空，如果不為空，喚醒它
        // 呼叫者在呼叫get()方法的進入阻塞狀態
        for (Thread c; (c = caller.get()) != null;) {
            if (caller.compareAndSet(c, null)) {
                LockSupport.unpark(c);
            }
        }
    }

最後，我們再看看get()方法，如果任務還未執行，就阻塞等待任務的執行；如果任務已經執行完畢了，直接拿返回值即可；但是，還有一種情況，get()方法執行的過程中run()方法也在執行，所以get()方法中的每一步都要檢查狀態的值有沒有變化。

@Override
    public T get() {
        int s = state.get();
        // 如果任務還未執行完成，判斷當前執行緒是否要進入阻塞狀態
        if (s == NEW) {
            // 標識呼叫者執行緒是否被標記過
            boolean marked = false;
            for (;;) {
                // 重新獲取state的值
                s = state.get();
                // 如果state大於NEW說明完成了，跳出迴圈
                if (s > NEW) {
                    break;
                    // 此處必須把caller的CAS更新和park()方法分成兩步處理，不能把park()放在CAS裡面
                } else if (!marked) {
                    // 嘗試更新呼叫者執行緒
                    // 試想斷點停在此處【本篇文章由公眾號“彤哥讀原始碼”原創】
                    // 此時state為NEW，讓run()方法執行到底，它不會執行finish()中的unpark()方法
                    // 這時開啟斷點，這裡會更新caller成功，但是迴圈從頭再執行一遍發現state已經變了，
                    // 直接在上面的if(s>NEW)處跳出迴圈了，因為finish()在修改state內部
                    marked = caller.compareAndSet(null, Thread.currentThread());
                } else {
                    // 呼叫者執行緒更新之後park當前執行緒
                    // 試想斷點停在此處
                    // 此時state為NEW，讓run()方法執行到底，因為上面的caller已經設定值了，
                    // 所以會執行finish()方法中的unpark()方法，
                    // 這時再開啟斷點，這裡不會park信
                    // 見unpark()方法的註釋，上面寫得很清楚：
                    // 如果執行緒執行了park()方法，那麼執行unpark()方法會喚醒那個執行緒
                    // 如果先執行了unpark()方法，那麼執行緒下一次執行park()方法將不會阻塞
                    LockSupport.park();
                }
            }
        }

        if (s == FINISHED) {
            return (T) result;
        }
        throw new RuntimeException((Throwable) result);
    }

在我們的實現中，如果任務執行的過程丟擲異常了，也是通過result返回給主執行緒，這樣主執行緒就拿到了這個異常，它就可以做相應的處理了。

好了，完整的實現到此結束，不知道你領悟了沒有。

測試用例

最後奉上測試程式碼：

public class MyThreadPoolFutureExecutorTest {
    public static void main(String[] args) {
        FutureExecutor threadPool = new MyThreadPoolFutureExecutor("test", 2, 4, new ArrayBlockingQueue<>(6), new DiscardRejectPolicy());
        List<future<integer>&gt; list = new ArrayList&lt;&gt;();
        for (int i = 0; i &lt; 100; i++) {
            int num = i;
            Future<integer> future = threadPool.submit(() -&gt; {
                Thread.sleep(1000);
                System.out.println("running: " + num);
                return num;
            });
            list.add(future);
        }

        for (Future<integer> future : list) {
            System.out.println("runned: " + future.get());
        }
    }
}

執行結果：

thread name: core_test2
thread name: test4
thread name: test3
discard one task
thread name: core_test1
discard one task
...省略被拒絕的任務
【本篇文章由公眾號“彤哥讀原始碼”原創】
discard one task
running: 0
running: 1
running: 8
running: 9
runned: 0
runned: 1
running: 4
running: 2
running: 3
running: 5
runned: 2
runned: 3
runned: 4
runned: 5
running: 6
running: 7
runned: 6
runned: 7
runned: 8
runned: 9

總結

（1）有返回值的任務是通過包裝成將來的任務來實現的，這個任務既具有基本的執行能力，又具有將來獲取返回值的能力；

（2）任務執行的異常跟任務正常的返回值是通過同一個返回值返回到主執行緒的，主執行緒根據狀態判斷是異常還是正常值；

（3）我們的實現中運用了單一職責原則、開閉原則等設計原則，對原有程式碼沒有造成任何的入侵；

彩蛋

手寫執行緒池目前只打算寫這兩章，後面開始進入jdk原生執行緒池的原始碼分析，敬請期待。

另外，需要手寫執行緒池完整原始碼的同學請關注我的公眾號“彤哥讀原始碼”，在後臺回覆“MyThreadPool”（不帶引號）即可領取手寫執行緒池完整原始碼，注意大小寫不要弄錯哦，否則彤哥是不會給你的哈。

歡迎關注我的公眾號“彤哥讀原始碼”，檢視更多原始碼系列文章, 與彤哥一起暢遊原始碼的海洋。

</integer></integer></future<integer></thread></t></t></t></t></t></t></runnable></t></t></t></t></t></t></t>