【Java】CompletableFuture学习记录

介绍

业务场景：查询商品详情页的逻辑比较复杂，有些数据还需要远程调用，必然需要花费更多的时间。

假如商品详情页的每个查询，需要如下标注的时间才能完成。那么，用户需要 5.5s 后才能看到商品详情页的内容。很显然是不能接受的。如果有多个线程同时完成这 6 步操作，也许只需要 1.5s 即可完成响应。

Future 是 Java 5 添加的类，用来描述一个异步计算的结果。你可以使用isDone方法检查计算是否完成，或者使用get阻塞住调用线程，直到计算完成返回结果，你也可以使用cancel 方法停止任务的执行。

虽然Future以及相关使用方法提供了异步执行任务的能力，但是对于结果的获取却是很不方便，只能通过阻塞或者轮询的方式得到任务的结果。阻塞的方式显然和我们的异步编程的初衷相违背，轮询的方式又会耗费无谓的 CPU 资源，而且也不能及时地得到计算结果，为什么不能用观察者设计模式当计算结果完成及时通知监听者呢？

很多语言，比如 Node.js，采用回调的方式实现异步编程。Java 的一些框架，比如Netty，自己扩展了 Java 的 Future接口，提供了addListener等多个扩展方法；Google guava 也提供了通用的扩展 Future；Scala 也提供了简单易用且功能强大的 Future/Promise 异步编程模式。

作为正统的 Java 类库，是不是应该做点什么，加强一下自身库的功能呢？

在 Java 8 中, 新增加了一个包含 50 个方法左右的类: CompletableFuture，提供了非常强大的Future 的扩展功能，可以帮助我们简化异步编程的复杂性，提供了函数式编程的能力，可以通过回调的方式处理计算结果，并且提供了转换和组合 CompletableFuture 的方法。CompletableFuture 类实现了 Future 接口，所以你还是可以像以前一样通过get方法阻塞或者轮询的方式获得结果，但是这种方式不推荐使用。

CompletableFuture 和 FutureTask 同属于 Future 接口的实现类，都可以获取线程的执行结果。

创建异步对象

CompletableFuture 提供了四个静态方法来创建一个异步操作。

1、runXxxx 都是没有返回结果的，supplyXxx 都是可以获取返回结果的
2、可以传入自定义的线程池，否则就用默认的线程池；

public class CompletableFutureTest {
    public static void main(String[] args) throws ExecutionException, InterruptedException {
        ExecutorService executorService = Executors.newFixedThreadPool(10);

        CompletableFuture<Integer> future = CompletableFuture.supplyAsync(() -> {
            System.out.println("异步任务执行");
            return 1;
        }, executorService);

        System.out.println("异步任务返回值：" + future.get());
        System.out.println("主线程执行");
        executorService.shutdown();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

运行结果：

public class CompletableFutureTest {
    public static void main(String[] args) throws ExecutionException, InterruptedException {
        ExecutorService executorService = Executors.newFixedThreadPool(10);

        CompletableFuture<Void> future = CompletableFuture.runAsync(() -> {
            System.out.println("异步任务执行,无返回值");
        }, executorService);

        System.out.println("异步任务返回值：" + future.get());
        System.out.println("主线程执行");
        executorService.shutdown();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

运行结果：

计算完成时回调方法

whenComplete 可以处理正常和异常的计算结果，exceptionally 处理异常情况。
whenComplete 和 whenCompleteAsync 的区别：
whenComplete：是执行当前任务的线程执行继续执行 whenComplete 的任务。whenCompleteAsync：是执行把 whenCompleteAsync 这个任务继续提交给线程池来进行执行。

public class CompletableFutureTest {
    public static void main(String[] args) throws ExecutionException, InterruptedException {
        ExecutorService executorService = Executors.newFixedThreadPool(10);

        CompletableFuture<Integer> future = CompletableFuture.supplyAsync(() -> {
            return 1;
        }, executorService).whenComplete((res, throwable) -> {
            System.out.println("接收supplyAsync处理结果：" + res);
            if (throwable != null) {
                System.out.println("supplyAsync出现异常：" + throwable);
            }
        });

        executorService.shutdown();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

运行结果：

方法不以 Async 结尾，意味着 Action 使用相同的线程执行，而 Async 可能会使用其他线程执行（如果是使用相同的线程池，也可能会被同一个线程选中执行）

handle 方法

和 complete 一样，可对结果做最后的处理（可处理异常），可改变返回值。

public class CompletableFutureTest {
    public static void main(String[] args) throws ExecutionException, InterruptedException {
        ExecutorService executorService = Executors.newFixedThreadPool(10);

        CompletableFuture<Integer> future = CompletableFuture.supplyAsync(() -> {
            return 1 / 0;
        }, executorService).handle((res, throwable) -> {
            System.out.println("接收supplyAsync处理结果" + res);
            if (throwable != null) {
                System.out.println("接收supplyAsync异常：" + throwable);
            }
            return 10;
        });

        System.out.println("返回默认值" + future.get());
        executorService.shutdown();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

线程串行化方法

thenApply 方法：当一个线程依赖另一个线程时，获取上一个任务返回的结果，并返回当前任务的返回值。
thenAccept 方法：消费处理结果。接收任务的处理结果，并消费处理，无返回结果。
thenRun 方法：只要上面的任务执行完成，就开始执行 thenRun，只是处理完任务后，执行thenRun 的后续操作

        /*
        thenRunAsync()：不能获取上一步的执行结果，无返回值
         */
        CompletableFuture<Void> future1 = CompletableFuture.supplyAsync(() -> {
            System.out.println("异步任务1执行");
            return 10;
        }, executorService).thenRunAsync(() -> {
            System.out.println("异步任务2执行");
        }, executorService);
1
2
3
4
5
6
7
8
9

        /*
        thenAcceptAsync()：可以获取上一步的执行结果，无返回值
         */
        CompletableFuture<Void> future2 = CompletableFuture.supplyAsync(() -> {
            System.out.println("异步任务1执行");
            return 10;
        }, executorService).thenAcceptAsync(res -> {
            System.out.println("异步任务2执行，拿到任务1的返回结果" + res);
        }, executorService);
1
2
3
4
5
6
7
8
9

        /*
        thenApplyAsync()：可以获取上一步的执行结果，可以返回值
         */
        CompletableFuture<Integer> future2 = CompletableFuture.supplyAsync(() -> {
            System.out.println("异步任务1执行");
            return 10;
        }, executorService).thenApplyAsync(res -> {
            System.out.println("异步任务2执行，拿到任务1的返回结果" + res);
            return 20;
        }, executorService);
1
2
3
4
5
6
7
8
9
10

两任务组合 - 都要完成

两个任务必须都完成，触发该任务。

thenCombine：组合两个 future，获取两个 future 的返回结果，并返回当前任务的返回值
thenAcceptBoth：组合两个 future，获取两个 future 任务的返回结果，然后处理任务，没有返回值。
runAfterBoth：组合两个 future，不需要获取 future 的结果，只需两个future 处理完任务后，处理该任务。

两个任务future2 和 future3 都要干完的情况

        CompletableFuture<Integer> future2 = CompletableFuture.supplyAsync(() -> {
            System.out.println("异步任务1执行");
            return 10;
        }, executorService);

        CompletableFuture<Integer> future3 = CompletableFuture.supplyAsync(() -> {
            System.out.println("异步任务2执行");
            return 20;
        }, executorService);

        /*
        future2和future3都执行完成后，在进行操作
        runAfterBothAsync不能感知到前两个异步任务的返回结果
         */
        CompletableFuture<Void> future = future2.runAfterBothAsync(future2, () -> {
            System.out.println("任务3开始");
        }, executorService);
        System.out.println(future2.get());
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

        future2.thenAcceptBothAsync(future3, (res1, res2) -> {
            System.out.println("任务1和任务2返回结果" + res1 + res2);
        }, executorService);
1
2
3

        future2.thenCombineAsync(future3, (res1, res) -> {
            return 30;
        }, executorService);
1
2
3

两任务组合 - 一个完成

当两个任务中，任意一个 future 任务完成的时候，执行任务。

applyToEither：两个任务有一个执行完成，获取它的返回值，处理任务并有新的返回值。acceptEither：两个任务有一个执行完成，获取它的返回值，处理任务，没有新的返回值。runAfterEither：两个任务有一个执行完成，不需要获取 future 的结果，处理任务，也没有返回值。

多任务组合

allOf：等待所有任务完成
anyOf：只要有一个任务完成