CompletableFuture詳解

在JDK1.5已經提供了Future和Callable的實現,可以用於阻塞式獲取結果,如果想要異步獲取結果,通常都會以輪詢的方式去獲取結果,如下:

//定義一個異步任務
Future<String> future = executor.submit(()->{
       Thread.sleep(2000);
       return "hello world";
});
//輪詢獲取結果
while (true){
    if(future.isDone()) {
         System.out.println(future.get());
         break;
     }
 }

從上面的形式看來輪詢的方式會耗費無謂的CPU資源，而且也不能及時地得到計算結果.所以要實現真正的異步,上述這樣是完全不夠的,在Netty中,我們隨處可見異步編程

ChannelFuture f = serverBootstrap.bind(port).sync();
f.addListener(new GenericFutureListener<Future<? super Void>>() {
                @Override
                public void operationComplete(Future<? super Void> future) throws Exception {
                    System.out.println("complete");
                }
            });

    而JDK1.8中的CompletableFuture就為我們提供了異步函數式編程,CompletableFuture提供了非常強大的Future的擴展功能，可以幫助我們簡化異步編程的復雜性，提供了函數式編程的能力，可以通過回調的方式處理計算結果，並且提供了轉換和組合CompletableFuture的方法。

1. 創建CompletableFuture對象

    CompletableFuture提供了四個靜態方法用來創建CompletableFuture對象：

public static CompletableFuture<Void>   runAsync(Runnable runnable)
public static CompletableFuture<Void>   runAsync(Runnable runnable, Executor executor)
public static <U> CompletableFuture<U>  supplyAsync(Supplier<U> supplier)
public static <U> CompletableFuture<U>  supplyAsync(Supplier<U> supplier, Executor executor)

Asynsc表示異步,而supplyAsync與runAsync不同在與前者異步返回一個結果,后者是void.第二個函數第二個參數表示是用我們自己創建的線程池,否則采用默認的ForkJoinPool.commonPool()作為它的線程池.其中Supplier是一個函數式接口,代表是一個生成者的意思,傳入0個參數,返回一個結果.(更詳細的可以看我另一篇文章)

CompletableFuture<String> future = CompletableFuture.supplyAsync(()->{
            return "hello world";
  });
System.out.println(future.get());  //阻塞的獲取結果  ''helllo world"

2. 主動計算

    以下4個方法用於獲取結果

//同步獲取結果
public T    get()
public T    get(long timeout, TimeUnit unit)
public T    getNow(T valueIfAbsent)
public T    join()

getNow有點特殊，如果結果已經計算完則返回結果或者拋出異常，否則返回給定的valueIfAbsent值。join()與get()區別在於join()返回計算的結果或者拋出一個unchecked異常(CompletionException)，而get()返回一個具體的異常.

• 主動觸發計算.

public boolean complete(T  value)
public boolean completeExceptionally(Throwable ex)

上面方法表示當調用CompletableFuture.get()被阻塞的時候,那么這個方法就是結束阻塞,並且get()獲取設置的value.

 

public static CompletableFuture<Integer> compute() {
        final CompletableFuture<Integer> future = new CompletableFuture<>();
        return future;
    }
    public static void main(String[] args) throws Exception {
        final CompletableFuture<Integer> f = compute();
        class Client extends Thread {
            CompletableFuture<Integer> f;
            Client(String threadName, CompletableFuture<Integer> f) {
                super(threadName);
                this.f = f;
            }
            @Override
            public void run() {
                try {
                    System.out.println(this.getName() + ": " + f.get());
                } catch (InterruptedException e) {
                    e.printStackTrace();
                } catch (ExecutionException e) {
                    e.printStackTrace();
                }
            }
        }
        new Client("Client1", f).start();
        new Client("Client2", f).start();
        System.out.println("waiting");
        //設置Future.get()獲取到的值
        f.complete(100);
        //以異常的形式觸發計算
        //f.completeExceptionally(new Exception());
        Thread.sleep(1000);
    }

3. 計算結果完成時的處理

public CompletableFuture<T>     whenComplete(BiConsumer<? super T,? super Throwable> action)
public CompletableFuture<T>     whenCompleteAsync(BiConsumer<? super T,? super Throwable> action)
public CompletableFuture<T>     whenCompleteAsync(BiConsumer<? super T,? super Throwable> action, Executor executor)
public CompletableFuture<T>     exceptionally(Function<Throwable,? extends T> fn)

上面4個方法是當計算階段結束的時候觸發,BiConsumer有兩個入參,分別代表計算返回值,另外一個是異常.無返回值.方法不以Async結尾，意味着Action使用相同的線程執行，而Async可能會使用其它的線程去執行(如果使用相同的線程池，也可能會被同一個線程選中執行)。

 

future.whenCompleteAsync((v,e)->{
       System.out.println("return value:"+v+"  exception:"+e);
 });

• handle()

public <U> CompletableFuture<U>     handle(BiFunction<? super T,Throwable,? extends U> fn)
public <U> CompletableFuture<U>     handleAsync(BiFunction<? super T,Throwable,? extends U> fn)
public <U> CompletableFuture<U>     handleAsync(BiFunction<? super T,Throwable,? extends U> fn, Executor executor)

與whenComplete()不同的是這個函數返回CompletableFuture並不是原始的CompletableFuture返回的值,而是BiFunction返回的值.

4. CompletableFuture的組合

• thenApply
  當計算結算完成之后,后面可以接繼續一系列的thenApply,來完成值的轉化.

public <U> CompletableFuture<U>     thenApply(Function<? super T,? extends U> fn)
public <U> CompletableFuture<U>     thenApplyAsync(Function<? super T,? extends U> fn)
public <U> CompletableFuture<U>     thenApplyAsync(Function<? super T,? extends U> fn, Executor executor)

它們與handle方法的區別在於handle方法會處理正常計算值和異常，因此它可以屏蔽異常，避免異常繼續拋出。而thenApply方法只是用來處理正常值，因此一旦有異常就會拋出。

CompletableFuture<String> future = CompletableFuture.supplyAsync(()->{
            
            return "hello world";
        });

CompletableFuture<String> future3 = future.thenApply((element)->{
            return element+"  addPart";
        }).thenApply((element)->{
            return element+"  addTwoPart";
        });
        System.out.println(future3.get());//hello world  addPart  addTwoPart

5. CompletableFuture的Consumer

只對CompletableFuture的結果進行消費,無返回值,也就是最后的CompletableFuture是void.

public CompletableFuture<Void>  thenAccept(Consumer<? super T> action)
public CompletableFuture<Void>  thenAcceptAsync(Consumer<? super T> action)
public CompletableFuture<Void>  thenAcceptAsync(Consumer<? super T> action, Executor executor)

 

//入參為原始的CompletableFuture的結果.
CompletableFuture future4 = future.thenAccept((e)->{
            System.out.println("without return value");
        });
future4.get();

• thenAcceptBoth

這個方法用來組合兩個CompletableFuture,其中一個CompletableFuture等待另一個CompletableFuture的結果.

CompletableFuture<String> future = CompletableFuture.supplyAsync(()->{
            return "hello world";
        });
CompletableFuture future5 =  future.thenAcceptBoth(CompletableFuture.completedFuture("compose"),
                (x, y) -> System.out.println(x+y));//hello world compose

6. Either和ALL

    thenAcceptBoth是當兩個CompletableFuture都計算完成，而我們下面要了解的方法applyToEither是當任意一個CompletableFuture計算完成的時候就會執行。

Random rand = new Random();
        CompletableFuture<Integer> future9 = CompletableFuture.supplyAsync(() -> {
            try {
                Thread.sleep(1000 + rand.nextInt(1000));
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
            return 100;
        });
        CompletableFuture<Integer> future10 = CompletableFuture.supplyAsync(() -> {
            try {
                Thread.sleep(1000 + rand.nextInt(1000));
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
            return 200;
        });
        //兩個中任意一個計算完成,那么觸發Runnable的執行
        CompletableFuture<String> f =  future10.applyToEither(future9,i -> i.toString());
        //兩個都計算完成,那么觸發Runnable的執行
        CompletableFuture f1 = future10.acceptEither(future9,(e)->{
            System.out.println(e);
        });
        System.out.println(f.get());

    如果想組合超過2個以上的CompletableFuture,allOf和anyOf可能會滿足你的要求.allOf方法是當所有的CompletableFuture都執行完后執行計算。anyOf方法是當任意一個CompletableFuture執行完后就會執行計算，計算的結果相同。

總結

有了CompletableFuture之后,我們自己實現異步編程變得輕松很多,這個類也提供了許多方法來組合CompletableFuture.結合Lambada表達式來用,變得很輕松. 

f的whenComplete的內容由哪個線程來執行，取決於哪個線程X執行了f.complete()。但是當X線程執行了f.complete()的時候，whenComplete還沒有被執行到的時候（就是事件還沒有注冊的時候），那么X線程就不會去同步執行whenComplete的回調了。這個時候哪個線程執行到了whenComplete的事件注冊的時候，就由哪個線程自己來同步執行whenComplete的事件內容。

而whenCompleteAsync的場合，就簡單很多。一句話就是線程池里面拿一個空的線程或者新啟一個線程來執行回調。和執行f.complete的線程以及執行whenCompleteAsync的線程無關。

 

轉自：https://www.jianshu.com/p/547d2d7761db

參考：https://blog.csdn.net/leon_wzm/article/details/80560081