java8-CompleableFuture的使用1

背景

1. 硬件的極速發展，多核心CPU司空見慣；分佈式的軟件架構司空見慣；
2. 功能API大多采用混聚的方式把基礎服務的內容連接在一塊兒，方便用戶生活。

拋出了兩個問題：

1. 如何發揮多核能力；
2. 切分大型任務，讓每一個子任務並行運行；

併發和並行的區別

項目	區別1	實現技術
並行	每一個任務跑在單獨的cpu核心上	分支合併框架，並行流
併發	不一樣任務共享cpu核心，基於時間片調度	CompletableFuture

Future接口

java5開始引入。未來某個時刻發生的事情進行建模。
進行一個異步計算，返回一個執行運算的結果引用，當運算結束後，這個引用能夠返回給調用方。
能夠使用Future把哪些潛在耗時的任務放到異步線程中，讓主線程繼續執行其餘有價值的工做，不在白白等待。

下面是一個例子：使用Future，可讓兩個任務併發的運行，而後匯聚結果；

package com.test.completable;

import com.google.common.base.Stopwatch;

import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

/**
 * 說明：Future應用實例
 * @author carter
 * 建立時間： 2019年11月18日 10:53
 **/

public class FutureTest {

    static final ExecutorService pool = Executors.newFixedThreadPool(2);


    public static void main(String[] args) {
        Stopwatch stopwatch = Stopwatch.createStarted();

        Future<Long> longFuture = pool.submit(() -> doSomethingLongTime());

        doSomething2();
        try {
            final Long longValue = longFuture.get(3, TimeUnit.SECONDS);
            System.out.println(Thread.currentThread().getName() + " future return value :" + longValue + " : " + stopwatch.stop());
        } catch (InterruptedException e) {
            e.printStackTrace();
        } catch (ExecutionException e) {
            e.printStackTrace();
        } catch (TimeoutException e) {
            e.printStackTrace();
        }
        pool.shutdown();
    }

    private static void doSomething2() {
        Stopwatch stopwatch = Stopwatch.createStarted();
        try {
            TimeUnit.SECONDS.sleep(3);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }

        System.out.println(Thread.currentThread().getName() + " doSomething2 :" + stopwatch.stop());
    }

    private static Long doSomethingLongTime() {
        Stopwatch stopwatch = Stopwatch.createStarted();
        try {
            TimeUnit.SECONDS.sleep(3);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }

        System.out.println(Thread.currentThread().getName() + " doSomethingLongTime : " + stopwatch.stop());
        return 1000L;
    }


}

無法編寫簡介的併發代碼。描敘能力不夠；好比以下場景：

1. 將兩個異步計算的結果合併爲一個，這兩個異步計算之間互相獨立，可是第二個有依賴第一個結果。
2. 等待Future中全部的任務都完成；
3. 僅等待Future集合中最快結束的任務完成，並返回它的結果；
4. 經過編程的方式完成一個Future任務的執行；
5. 響應Future的完成事件。

基於這個缺陷，java8中引入了CompletableFuture 類；

實現異步API

技能點：

1. 提供異步API;
2. 修改同步的API爲異步的API,如何使用流水線把兩個任務合併爲一個異步計算操做；
3. 響應式的方式處理異步操做的完成事件；

類型	區別	是否堵塞
同步API	調用方在被調用運行的過程當中等待，被調用方運行結束後返回，調用方取得返回值後繼續運行	堵塞
異步API	調用方和被調用方是異步的，調用方不用等待被調用方返回結果	非堵塞

package com.test.completable;

import com.google.common.base.Stopwatch;
import com.google.common.base.Ticker;

import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;

/**
 * 說明：異步調用計算價格的方法
 * @author carter
 * 建立時間： 2019年11月18日 13:32
 **/

public class Test {

    public static void main(String[] args) {
        Shop shop = new Shop("BestShop");

        Stopwatch stopwatch = Stopwatch.createStarted();
        Stopwatch stopwatch2 = Stopwatch.createStarted();

        Future<Double> doubleFuture = shop.getPriceFuture("pizza");

        System.out.println("getPriceFuture return after: " + stopwatch.stop());

        doSomethingElse();
        try{
            final Double price = doubleFuture.get();
            System.out.println("price is " + price + " return after: " + stopwatch2.stop());
        } catch (InterruptedException e) {
            e.printStackTrace();
        } catch (ExecutionException e) {
            e.printStackTrace();
        }
    }

    private static void doSomethingElse() {
        Stopwatch stopwatch = Stopwatch.createStarted();
        DelayUtil.delay();
        System.out.println("doSomethingElse " + stopwatch.stop());

    }


}

錯誤處理

若是計算價格的方法產生了錯誤，提示錯誤的異常會被如今在試圖計算商品價格的當前線程的範圍內，最終計算的異步線程會被殺死，這會致使get方法返回結果的客戶端永久的被等待。

如何避免異常被掩蓋， completeExceptionally會把CompletableFuture內發生的問題拋出去。

private static void test2() {
        Shop shop = new Shop("BestShop");

        Stopwatch stopwatch = Stopwatch.createStarted();
        Stopwatch stopwatch2 = Stopwatch.createStarted();

        Future<Double> doubleFuture = shop.getPriceFutureException("pizza");

        System.out.println("getPriceFuture return after: " + stopwatch.stop());

        doSomethingElse();
        try{
            final Double price = doubleFuture.get();
            System.out.println("price is " + price + " return after: " + stopwatch2.stop());
        } catch (InterruptedException e) {
            e.printStackTrace();
        } catch (ExecutionException e) {
            e.printStackTrace();
        }
    }

方法改造：

//異步方式查詢產品價格,異常拋出去
    public Future<Double> getPriceFutureException(String product){


        final CompletableFuture<Double> doubleCompletableFuture = new CompletableFuture<>();

        new Thread(()->{try {
            doubleCompletableFuture.complete(alculatePriceException(product));
        }catch (Exception ex){
            doubleCompletableFuture.completeExceptionally(ex);
        }
        }).start();

        return doubleCompletableFuture;
    }

無堵塞

即讓多個線程去異步並行或者併發的執行任務，計算完以後匯聚結果；

private static void test3(String productName) {
        Stopwatch stopwatch = Stopwatch.createStarted();
        final List<String> stringList = Stream.of(new Shop("華強北"), new Shop("益田假日廣場"), new Shop("香港九龍城"), new Shop("京東商城"))
                .map(item -> String.format("商店:%s的商品：%s 售價是：%s", item.getName(), productName, item.getPrice(productName)))
                .collect(Collectors.toList());

        System.out.println(stringList);
        System.out.println("test3 done in  " + stopwatch.stop());


    }

    private static void test3_parallelStream(String productName) {
        Stopwatch stopwatch = Stopwatch.createStarted();
        final List<String> stringList = Stream.of(new Shop("華強北"), new Shop("益田假日廣場"), new Shop("香港九龍城"), new Shop("京東商城"))
                .parallel()
                .map(item -> String.format("商店:%s的商品：%s 售價是：%s", item.getName(), productName, item.getPrice(productName)))
                .collect(Collectors.toList());

        System.out.println(stringList);
        System.out.println("test3_parallelStream done in  " + stopwatch.stop());


    }


    private static void test3_completableFuture(String productName) {
        Stopwatch stopwatch = Stopwatch.createStarted();
        final List<String> stringList = Stream.of(new Shop("華強北"), new Shop("益田假日廣場"), new Shop("香港九龍城"), new Shop("京東商城"))
                .map(item ->CompletableFuture.supplyAsync(()-> String.format("商店:%s的商品：%s 售價是：%s", item.getName(), productName, item.getPrice(productName))))
                .collect(Collectors.toList())
                .stream()
                .map(CompletableFuture::join)
                .collect(Collectors.toList());

        System.out.println(stringList);
        System.out.println("test3_completableFuture done in  " + stopwatch.stop());


    }



    private static void test3_completableFuture_pool(String productName) {
        Stopwatch stopwatch = Stopwatch.createStarted();
        final List<String> stringList = Stream.of(new Shop("華強北"), new Shop("益田假日廣場"), new Shop("香港九龍城"), new Shop("京東商城"))
                .map(item ->CompletableFuture.supplyAsync(()-> String.format("商店:%s的商品：%s 售價是：%s", item.getName(), productName, item.getPrice(productName)),pool))
                .collect(Collectors.toList())
                .stream()
                .map(CompletableFuture::join)
                .collect(Collectors.toList());

        System.out.println(stringList);
        System.out.println("test3_completableFuture done in  " + stopwatch.stop());


    }

代碼中有一個簡單的計算場景，我想查詢4家商店的iphone11售價；

華強北，益田蘋果店，香港九龍城，京東商城；

每一家的查詢大概耗時1s;

任務處理方式	耗時	優缺點說明
順序執行	4秒多	簡單，好理解
並行流	1秒多	沒法定製流內置的線程池，使用簡單，改造簡單
CompletableFuture 默認線程池	2秒多	默認線程池
CompletableFuture 指定線程池	1秒多	指定了線程池，可定製性更好，相比於並行流

多個異步任務的流水線操做

場景： 先計算價格，在拿到折扣，最後計算折扣價格；

private static void test4(String productName) {

        Stopwatch stopwatch = Stopwatch.createStarted();
        final List<String> stringList = Stream.of(new Shop("華強北"), new Shop("益田假日廣場"), new Shop("香港九龍城"), new Shop("京東商城"))
                .map(shop->shop.getPrice_discount(productName))
                .map(Quote::parse)
                .map(DisCount::applyDiscount)
                .collect(Collectors.toList());

        System.out.println(stringList);
        System.out.println("test4 done in  " + stopwatch.stop());


    }

    private static void test4_completableFuture(String productName) {

        Stopwatch stopwatch = Stopwatch.createStarted();
        final List<String> stringList = Stream.of(new Shop("華強北"), new Shop("益田假日廣場"), new Shop("香港九龍城"), new Shop("京東商城"))
                .map(shop->CompletableFuture.supplyAsync(()->shop.getPrice_discount(productName),pool))
                .map(future->future.thenApply( Quote::parse))
                .map(future->future.thenCompose(quote -> CompletableFuture.supplyAsync(()->DisCount.applyDiscount(quote),pool)))
                .collect(Collectors.toList())
                .stream()
                .map(CompletableFuture::join)
                .collect(Collectors.toList());

        System.out.println(stringList);
        System.out.println("test4_completableFuture done in  " + stopwatch.stop());


    }

以上是有依賴關係的兩個任務的聚合，即任務2，依賴任務1的結果。使用的是thenCompose方法；

接下來若是有兩個任務能夠異步執行，最後須要依賴着兩個任務的結果計算獲得最終結果，採用的是thenCombine;

//兩個不一樣的任務，最後須要匯聚結果，採用combine
    private static void test5(String productName) {

        Stopwatch stopwatch = Stopwatch.createStarted();


        Shop shop = new Shop("香港九龍");

      Double pricefinal =  CompletableFuture.supplyAsync(()->shop.getPrice(productName))
                .thenCombine(CompletableFuture.supplyAsync(shop::getRate),(price, rate)->price * rate).join();


        System.out.println("test4 done in  " + stopwatch.stop());


    }

completion事件

讓任務儘快結束，無需等待；
有多個服務來源，你請求多個，誰先返回，就先響應；

結果依次返回：

//等待全部的任務執行完畢； CompletableFuture.allOf()
    public void findPriceStream(String productName){
        List<Shop> shops = Arrays.asList(new Shop("華強北"), new Shop("益田假日廣場"), new Shop("香港九龍城"), new Shop("京東商城"));
        final CompletableFuture[] completableFutureArray = shops.stream()
                .map(shop -> CompletableFuture.supplyAsync(() -> shop.getPrice_discount(productName), pool))
                .map(future -> future.thenApply(Quote::parse))
                .map(future -> future.thenCompose(quote -> CompletableFuture.supplyAsync(() -> DisCount.applyDiscount(quote), pool)))
                .map(f -> f.thenAccept(System.out::println))
                .toArray(size -> new CompletableFuture[size]);


        CompletableFuture.allOf(completableFutureArray).join();

    }

多個來源獲取最快的結果：

//有兩個獲取天氣的途徑，哪一個快最後結果就取哪個
    public static void getWeather(){
        final Object join = CompletableFuture.anyOf(CompletableFuture.supplyAsync(() -> a_weather()), CompletableFuture.supplyAsync(() -> b_weather())).join();

        System.out.println(join);
    }

    private static String b_weather() {
        DelayUtil.delay(3);
        return "bWeather";
    }

    private static String a_weather() {
        DelayUtil.delay(5);
        return "aWeather";
    }

源碼分析

可完備化的未來；CompletableFuture ;

先看簽名：

public class CompletableFuture<T> implements Future<T>, CompletionStage<T> {}

實現了Futrue,CompletionStage接口；
這兩個接口簡單說明一下：

接口	關鍵特性
Future	直接翻譯爲將來,標識把一個任務異步執行，須要的的時候，經過get方法獲取，也能夠取消cancel，此外還提供了狀態查詢方法，isDone, isCancled,實現類是FutureTask
CompletionStage	直接翻譯是完成的階段,提供了函數式編程方法

能夠分爲以下幾類方法

方法	說明
thenApply(Function f)	當前階段正常完成以後，返回一個新的階段，新的階段把當前階段的結果做爲參數輸入;
thenConsume(Consumer c),	當前階段完成以後，結果做爲參數輸入，直接消費掉，獲得不返回結果的完成階段；
thenRun(Runnable action),	不接受參數，只是繼續執行任務，獲得一個新的完成階段；
thenCombine(otherCompletionStage，BiFunction),	當兩個完成階段都完成的時候，執行BIFunction,返回一個新的階段；
thenAcceptBoth(OtherCompletionStage, BiConsumer)	兩個完成階段都完成以後，對兩個結果進行消費；
runAfterBoth(OtherCompletionStage,Runable)	兩個完成階段都完成以後，執行一個動做；
applyToEither(OtherCompletionStage,Function)	兩個完成階段的任何一個執行結束，進入函數操做，並返回一個新的階段
acceptEither(OtherCompletionStage,Consumer)	兩個完成階段的任何一個執行結束，消費掉，返回一個空返回值的完成階段
runAfterEither（OtherCompletionStage,Runable）	兩個完成階段的任何一個結束，執行一個動做，返回一個空返回值的完成階段
thenCompose（Function）	當前階段完成，返回值做爲參數，進行函數運算，而後結果做爲一個新的完成階段
exceptionally（Function）	不管當前階段是否正常完成，消費掉異常，而後返回值做爲一個新的完成階段
whenComplete
handle	不管當前完成階段是否正常結束，都執行一個BIFunction的函數，並返回一個新結果做爲一個新的完成階段
toCompletableFuture	轉換爲ComplatableFuture

裏面的實現細節後面單獨成文章再講。

小結

1. 執行一些比較耗時的操做，尤爲是依賴一個或者多個遠程服務的操做，能夠使用異步任務改善程序的性能，加快程序的響應速度；
2. 使用CompletableFuture你能夠輕鬆的實現異步API;
3. CompletableFuture提供了異常管理機制，讓主線程有機會接管子任務拋出的異常；
4. 把同步API封裝到CompletableFuture中，能夠異步獲得它的結果；
5. 若是異步任務之間互相獨立，而他們之間的某一些結果是另一些的輸入，能夠把這些任務進行compose;
6. 能夠爲CompletableFuture中的任務註冊一個回調函數，當任務執行完畢以後再進行一些其它操做；
7. 你能夠決定何時結束程序的運行，是全部的CompletableFuture任務全部對象執行完畢，或者只要其中任何一個完成便可。

原創不易，轉載請註明出處，歡迎溝通交流。