Future 模式之 CompletableFuture

來醉一場發表於2019-03-04

CompletableFuture 是Java 8 新增加的Api,該類實現，Future和CompletionStage兩個介面，提供了非常強大的Future的擴充套件功能，可以幫助我們簡化非同步程式設計的複雜性，提供了函數語言程式設計的能力，可以通過回撥的方式處理計算結果，並且提供了轉換和組合CompletableFuture的方法。

一、主動完成計算

public T get()

該方法為阻塞方法，會等待計算結果完成
public T get(long timeout,TimeUnit unit)

有時間限制的阻塞方法
public T getNow(T valueIfAbsent)

立即獲取方法結果，如果沒有計算結束則返回傳的值
public T join()

和 get() 方法類似也是主動阻塞執行緒，等待計算結果。和get() 方法有細微的差別

public class ThreadUtil {
    public static void sleep(long ms) {
        try {
            Thread.sleep(ms);
        } catch (InterruptedException e) {
            e.printStackTrace();
            throw new RuntimeException(e.getMessage());
        }
    }
}

複製程式碼

public static void main(String[] args) {

     CompletableFuture<Integer> future = CompletableFuture.supplyAsync(() -> {
            ThreadUtil.sleep(200);
            return 10 / 0;
    });
//       System.out.println(future.join());
//       System.out.println(future.get());
    System.out.println(future.getNow(10));
}
複製程式碼

public boolean complete(T value)

立即完成計算，並把結果設定為傳的值，返回是否設定成功

如果 CompletableFuture 沒有關聯任何的Callback、非同步任務等，如果呼叫get方法，那會一直阻塞下去，可以使用complete方法主動完成計算

public static void main(String[] args) throws Exception {
    CompletableFuture<Integer> future = new CompletableFuture<>();
//        future.get();
    future.complete(10);
}
複製程式碼

public boolean completeExceptionally(Throwable ex) 立即完成計算，並丟擲異常

二、執行非同步任務

建立一個非同步任務

public static CompletableFuture completedFuture(U value)

建立一個有初始值的CompletableFuture
public static CompletableFuture runAsync(Runnable runnable)
public static CompletableFuture runAsync(Runnable runnable, Executor executor)
public static CompletableFuture supplyAsync(Supplier supplier)
public static CompletableFuture supplyAsync(Supplier supplier, Executor executor)

以上四個方法中，以 Async 結尾並且沒有 Executor 引數的，會預設使用 ForkJoinPool.commonPool() 作為它的執行緒池執行非同步程式碼。以run開頭的，因為以 Runable 型別為引數所以沒有返回值。示例：

    public static void main(String[] args) throws ExecutionException, InterruptedException {
        CompletableFuture<Void> future1 = CompletableFuture.runAsync(() -> System.out.println("runAsync"));
        CompletableFuture<String> future2 = CompletableFuture.supplyAsync(() -> "supplyAsync");
        
        System.out.println(future1.get());
        System.out.println(future2.get());
    }
複製程式碼

結果：

runAsync
null
supplyAsync
複製程式碼

三、計算完成時對結果的處理 whenComplete/exceptionally/handle

當CompletableFuture的計算結果完成，或者丟擲異常的時候，我們可以執行特定的Action。主要是下面的方法：

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

引數型別為 BiConsumer<? super T, ? super Throwable> 會獲取上一步計算的計算結果和異常資訊。以Async結尾的方法可能會使用其它的執行緒去執行,如果使用相同的執行緒池，也可能會被同一個執行緒選中執行,以下皆相同。

   public static void main(String[] args) throws Exception {
    CompletableFuture<Integer> future = CompletableFuture.supplyAsync(() -> {
        ThreadUtil.sleep(100);
        return 20;
    }).whenCompleteAsync((v, e) -> {
        System.out.println(v);
        System.out.println(e);
    });
    System.out.println(future.get());
}
複製程式碼

public CompletableFuture exceptionally(Function<Throwable,? extends T> fn)

該方法是對異常情況的處理，當函式異常時應該的返回值

    public static void main(String[] args) throws Exception {
        CompletableFuture<Integer> future = CompletableFuture.supplyAsync(() -> {
            ThreadUtil.sleep(100);
            return 10 / 0;
        }).whenCompleteAsync((v, e) -> {
            System.out.println(v);
            System.out.println(e);
        }).exceptionally((e) -> {
            System.out.println(e.getMessage());
            return 30;
        });
        System.out.println(future.get());
    }
複製程式碼

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

handle 方法和whenComplete方法類似，只不過接收的是一個 BiFunction<? super T,Throwable,? extends U> fn 型別的引數，因此有 whenComplete 方法和轉換的功能 (thenApply)

    public static void main(String[] args) throws ExecutionException, InterruptedException {
        CompletableFuture<Integer> future = CompletableFuture
                .supplyAsync(() -> 10 / 0)
                .handle((t, e) -> {
                    System.out.println(e.getMessage());
                    return 10;
                });

        System.out.println(future.get());
    }
複製程式碼

四、結果處理轉換 thenApply

CompletableFuture 由於有回撥，可以不必等待一個計算完成而阻塞著呼叫縣城，可以在一個結果計算完成之後緊接著執行某個Action。我們可以將這些操作串聯起來。

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

 public static void main(String[] args) throws ExecutionException, InterruptedException {
        CompletableFuture<Integer> future = CompletableFuture
                .supplyAsync(() -> 1)
                .thenApply((a) -> {
                    System.out.println(a);//1
                    return a * 10;
                }).thenApply((a) -> {
                    System.out.println(a);//10
                    return a + 10;
                }).thenApply((a) -> {
                    System.out.println(a);//20
                    return a - 5;
                });
        System.out.println(future.get());//15
    }
複製程式碼

這些方法不是馬上執行的，也不會阻塞，而是前一個執行完成後繼續執行下一個。

和 handle 方法的區別是，handle 會處理正常計算值和異常，不會丟擲異常。而 thenApply 只會處理正常計算值，有異常則丟擲。

五、純消費 thenAccept/thenAcceptBoth/thenRun

單純的去消費結果而不會返回新的值，因些計算結果為 Void;

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

    public static void main(String[] args) throws ExecutionException, InterruptedException {
        
        CompletableFuture<Void> future = CompletableFuture
                .supplyAsync(() -> 1)
                .thenAccept(System.out::println) //消費 上一級返回值 1
                .thenAcceptAsync(System.out::println); //上一級沒有返回值 輸出null
                
        System.out.println(future.get()); //消費函式沒有返回值 輸出null
    }
複製程式碼

public CompletableFuture thenAcceptBoth(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)
public CompletableFuture thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)
public CompletableFuture thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action, Executor executor)

和 thenAccept 相比，引數型別多了一個 CompletionStage<? extends U> other,以上方法會接收上一個CompletionStage返回值，和當前的一個。

    public static void main(String[] args) throws ExecutionException, InterruptedException {
        CompletableFuture
                .supplyAsync(() -> 1)
                .thenAcceptBoth(CompletableFuture.supplyAsync(() -> 2), (a, b) -> {
                    System.out.println(a);
                    System.out.println(b);
                }).get();
    }
複製程式碼

public CompletableFuture runAfterBoth(CompletionStage<?> other, Runnable action)

runAfterBoth 和以上方法不同，傳一個 Runnable 型別的引數，不接收上一級的返回值

更徹底的：

public CompletableFuture thenRun(Runnable action)
public CompletableFuture thenRunAsync(Runnable action)
public CompletableFuture thenRunAsync(Runnable action, Executor executor)

以上是徹底的純消費，完全忽略計算結果

六、組合 thenCompose/thenCombine

public CompletableFuture thenCompose(Function<? super T,? extends CompletionStage> fn)
public CompletableFuture thenComposeAsync(Function<? super T,? extends CompletionStage> fn)
public CompletableFuture thenComposeAsync(Function<? super T,? extends CompletionStage> fn, Executor executor)

以上接收型別為 Function<? super T,? extends CompletionStage> fn ,fn 接收上一級返回的結果，並返回一個新的 CompletableFuture

   public static void main(String[] args) throws ExecutionException, InterruptedException {

        CompletableFuture<Integer> future = CompletableFuture
                .supplyAsync(() -> 1)
                .thenApply((a) -> {
                    ThreadUtil.sleep(1000);
                    return a + 10;
                })
                .thenCompose((s) -> {
                    System.out.println(s); //11
                    return CompletableFuture.supplyAsync(() -> s * 5);
                });

        System.out.println(future.get());//55
    }
複製程式碼

public <U,V> CompletableFuture thenCombine(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
public <U,V> CompletableFuture thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
public <U,V> CompletableFuture thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn, Executor executor)

兩個CompletionStage是並行執行的，它們之間並沒有先後依賴順序，other並不會等待先前的CompletableFuture執行完畢後再執行。

public static void main(String[] args) throws ExecutionException, InterruptedException {

        Random random = new Random();
        CompletableFuture<Integer> future = CompletableFuture
                .supplyAsync(() -> {
                    ThreadUtil.sleep(random.nextInt(1000));
                    System.out.println("supplyAsync");
                    return 2;
                }).thenApply((a) -> {
                    ThreadUtil.sleep(random.nextInt(1000));
                    System.out.println("thenApply");
                    return a * 3;
                })
                .thenCombine(CompletableFuture.supplyAsync(() -> {
                    ThreadUtil.sleep(random.nextInt(1000));
                    System.out.println("thenCombineAsync");
                    return 10;
                }), (a, b) -> {
                    System.out.println(a);
                    System.out.println(b);
                    return a + b;
                });

        System.out.println(future.get());
    }
複製程式碼

thenCombine 和 supplyAsync 不一定哪個先哪個後，是並行執行的。

七、acceptEither / applyToEither

public CompletableFuture acceptEither(CompletionStage<? extends T> other, Consumer<? super T> action)
public CompletableFuture acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action)
public CompletableFuture acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action, Executor executor)

先看示例：

    public static void main(String[] args) throws ExecutionException, InterruptedException {
        Random random = new Random();
        CompletableFuture
                .supplyAsync(() -> {
                    ThreadUtil.sleep(random.nextInt(1000));
                    return "A";
                })
                .acceptEither(CompletableFuture.supplyAsync(() -> {
                    ThreadUtil.sleep(random.nextInt(1000));
                    return "B";
                }), System.out::println)
                .get();
    }
複製程式碼

以上程式碼有時輸出A，有時輸出B，哪個Future先執行完就會根據它的結果計算。

acceptEither方法是當任意一個 CompletionStage 完成的時候，action 這個消費者就會被執行。這個方法返回 CompletableFuture

public CompletableFuture applyToEither(CompletionStage<? extends T> other, Function<? super T,U> fn)
public CompletableFuture applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T,U> fn)
public CompletableFuture applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T,U> fn, Executor executor)

applyToEither 方法是當任意一個 CompletionStage 完成的時候，fn會被執行，它的返回值會當作新的CompletableFuture的計算結果。

acceptEither 沒有返回值，applyToEither 有返回值

八、allOf / anyOf

public static CompletableFuture allOf(CompletableFuture<?>... cfs)

這個方法的意思是把有方法都執行完才往下執行，沒有返回值

   public static void main(String[] args) throws ExecutionException, InterruptedException {

        Random random = new Random();
        CompletableFuture.allOf(
                CompletableFuture.runAsync(() -> {
                    ThreadUtil.sleep(random.nextInt(1000));
                    System.out.println(1);
                }),
                CompletableFuture.runAsync(() -> {
                    ThreadUtil.sleep(random.nextInt(1000));
                    System.out.println(2);
                }))
                .get();

    }
複製程式碼

有時輸出1 2 有時輸出 2 1

public static CompletableFuture anyOf(CompletableFuture<?>... cfs)

任務一個方法執行完都往下執行，返回一個Object型別的值

  public static void main(String[] args) throws ExecutionException, InterruptedException {
        Random random = new Random();

        Object obj = CompletableFuture.anyOf(
                CompletableFuture.supplyAsync(() -> {
                    ThreadUtil.sleep(random.nextInt(1000));
                    return 1;
                }),
                CompletableFuture.supplyAsync(() -> {
                    ThreadUtil.sleep(random.nextInt(1000));
                    return 2;
                })).get();

        System.out.println(obj);
    }
複製程式碼

輸出結果有時為1 有時間為 2

Future和CompletableFuture的理解
2024-10-23
Future模式
2018-09-29
模式
Java非同步程式設計：CompletableFuture與Future的對比
2024-09-01
Java非同步程式設計
java 多執行緒設計模式之future
2013-11-07
Java執行緒設計模式
非同步技巧之CompletableFuture
2018-07-11
非同步
Rust非同步之Future
2020-06-09
Rust非同步
SpringBoot 對Future模式的支援
2019-01-08
Spring Boot模式
Future --- 多執行緒設計模式
2017-07-10
執行緒設計模式
Flutter之Future原理解析
2020-06-22
Flutter
java之使用CompletableFuture入門2
2024-10-07
Java
【併發程式設計】Future模式新增Callback及Promise 模式
2019-05-16
程式設計模式Promise
深入理解［Future模式］原理與技術
2018-09-22
模式
Java併發程式設計-Future系列之Future的介紹和基本用法
2019-03-26
Java程式設計
Java併發之Executor + Callable + Future
2017-12-21
Java
說一說併發設計模式—Future（非同步）
2019-03-04
設計模式非同步
Java非同步之《我call()，Future在哪裡》
2020-07-31
Java非同步
Flutter篇之你真的會使用Future嗎？
2019-07-19
Flutter
CompletableFuture Demo
2024-03-08
Java多執行緒之Callable,Future,FutureTask
2019-04-02
Java執行緒
java多執行緒系列之future機制
2017-10-13
Java執行緒
Guava future
2018-11-01
Guava
Java 8 CompletableFuture
2019-02-28
Java
future promise shared_future簡單使用
2020-12-08
Promise
【併發程式設計】Future模式及JDK中的實現
2019-02-22
程式設計模式JDK
java8 之CompletableFuture -- 如何構建非同步應用
2019-05-27
Java非同步
Future學習
2020-04-05
Java 8 CompletableFuture 教程
2019-01-19
Java
Java8 CompletableFuture
2020-09-08
Java
CompletableFuture 使用總結
2022-12-27
Java CompletableFuture 詳解
2016-04-17
Java
CompletableFuture 使用指南
2024-06-17
completablefuture-examples：Java 20個CompletableFuture API案例程式碼片段
2022-03-15
JavaAPI
Java的Future介面
2022-02-28
Java
The Future of the English [Supplementary Exercises]
2024-10-04
CompletableFuture學習總結
2024-05-09
執行緒執行之 Runnable Callable Future ，FutureTask ExcutorService概覽
2018-07-17
執行緒
非同步程式設計 CompletableFuture
2022-03-21
非同步程式設計
Java中ExecutorService與CompletableFuture指南
2024-03-22
Java