Java多线程工具CompletableFuture

前言

写多线程程序的时候，我们都知道Future代表着我们在执行一个线程并且期望从这个线程中拿到我们想要的结果，它提供了get方法可以获取结果。但是Future有一些不足之处：

• 如果想要对Future的结果做进一步的操作，需要阻塞当前线程

• 多个Future不能被链式的执行，每个Future的结果都是独立的，期望对一个Future的结果做另外一件异步的事情；

• 没有异常处理策略，如果Future执行失败了，需要手动捕捉

为了解决以上问题，JDK给我们提供了一个好用的工具类CompletableFuture，它实现了Future和CompletionStage接口，针对Future的不足之处给出了相应的处理方式。

• Future代表一个异步执行的结果。

• CompletionStage代表是由其它CompletionStage执行后得到的结果，可能是执行完成，也可能是执行终止的结果，但是 是另外一个CompletionStage后的内容，然后可以继续作为下一个CompletionStage来使用。保证执行结果肯定还是CompletionStage

个人理解每一个异步执行可以看做一个CompletionStage，这个执行可以给下一个CompletionStage继续使用。虽然执行是异步的，但是CompletionStage是连续的。

使用方式

最简单的使用方式，异步执行，无需结果：

// 可以执行Executors异步执行，如果不指定，默认使用ForkJoinPool
CompletableFuture.runAsync(() -> System.out.println("Hello CompletableFuture!"));

异步执行，同时返回结果：

// 同样可以指定线程池
CompletableFuture<String> stringCompletableFuture = CompletableFuture.supplyAsync(() -> "Hello CompletableFuture!");
System.out.println(stringCompletableFuture.get());

CompletableFuture操作

上面简单的使用使用Java的多线程也可以做到，CompletableFuture肯定提供了比上面功能更强大的操作。

异步获取上一步的结果，并进行接下来的操作：

• thenRun:   不需要上一步的结果，直接直接新的操作

• thenAccept：获取上一步异步处理的内容，进行新的操作

• thenApply: 获取上一步的内容，然后产生新的内容

所有加上Async后缀的，代表新的处理操作仍然是异步的。Async的操作都可以指定Executors进行处理

// 演示代码
       CompletableFuture
                .supplyAsync(() -> "Hello CompletableFuture!")
                // 针对上一步的结果做处理，产生新的结果
                .thenApplyAsync(s -> s.toUpperCase())
                // 针对上一步的结果做处理，不返回结果
                .thenAcceptAsync(s -> System.out.println(s))
                // 不需要上一步返回的结果，直接进行操作
                .thenRunAsync(() -> System.out.println("end"));
        ;

现在还剩余几个不容易一眼就看出来用途的方法：

• thenCompose

• thenCombine

thenCompose

与thenApply功能相近，但是thenCompose另外一个参数返回的必须是一个CompletionStage对象，这种约定使得在返回CompletionStage会自动的将步骤进行拆解，举一个具体的案例：

如下，可以看出如果返回的内容是CompletionStage时，compose可以自动的进行拆开处理：

• CompletableFuture<CompletionStage> apply

• CompletableFuture compose

当我们的service返回类型为CompletionStage时，如果想要组合多个service，那么使用thenCompose

			CompletableFuture<CompletionStage<String>> apply = CompletableFuture
                .supplyAsync(() -> "Hello CompletableFuture!")
                .thenApply(new Function<String, CompletionStage<String>>() {
                    @Override
                    public CompletionStage apply(String s) {
                        return CompletableFuture.supplyAsync(() -> "abc");
                    }
                });


        CompletableFuture<String> compose = CompletableFuture
                .supplyAsync(() -> "Hello CompletableFuture!")
                .thenCompose(new Function<String, CompletionStage<String>>() {
                    @Override
                    public CompletionStage<String> apply(String s) {
                        return CompletableFuture.supplyAsync(() -> "abc");
                    }
                });

thenCombine

当我们有两个CompletionStage时，需要对两个的结果进行整合处理，然后计算得出一个新的结果。

• thenCompose是对上一个CompletionStage的结果进行处理，返回结果，并且返回类型必须是CompletionStage。

• thenCombine是得到第一个CompletionStage的结果，然后拿到当前的CompletionStage，两者的结果进行处理。

        CompletableFuture<Integer> heightAsync = CompletableFuture.supplyAsync(() -> 172);

        CompletableFuture<Double> weightAsync = CompletableFuture.supplyAsync(() -> 65)
                .thenCombine(heightAsync, new BiFunction<Integer, Integer, Double>() {
                    @Override
                    public Double apply(Integer wight, Integer height) {
                        return wight * 10000.0 / (height * height);
                    }
                })
                ;

thenAcceptBoth

需要两个异步CompletableFuture的结果，两者都完成的时候，才进入thenAcceptBoth回调。

// thenAcceptBoth案例：
        CompletableFuture
                .supplyAsync(() -> "Hello CompletableFuture!")
                .thenAcceptBoth(CompletableFuture.supplyAsync(() -> "abc"), new BiConsumer<String, String>() {
                		// 参数一为我们刚开始运行时的CompletableStage，新传入的作为第二个参数
                    @Override
                    public void accept(String s, String s2) {
                        System.out.println("param1=" + s + ", param2=" + s2);
                    }
                });
// 结果：param1=Hello CompletableFuture!, param2=abc

acceptEither

当我们有两个回调在处理的时候，任何完成都可以使用，两者结果没有关系，那么使用acceptEither。

两个异步线程谁先执行完成，用谁的结果，其余类型的方法也是如此。

// 返回abc
CompletableFuture
                .supplyAsync(() -> {
                    SleepUtils.sleep(100);
                    return "Hello CompletableFuture!";
                })
                .acceptEither(CompletableFuture.supplyAsync(() -> "abc"), new Consumer<String>() {
                    @Override
                    public void accept(String s) {
                        System.out.println(s);
                    }
                });
// 返回Hello CompletableFuture!       
CompletableFuture
                .supplyAsync(() -> "Hello CompletableFuture!")
                .acceptEither(CompletableFuture.supplyAsync(() -> {
                    SleepUtils.sleep(100);
                    return "abc";
                }), new Consumer<String>() {
                    @Override
                    public void accept(String s) {
                        System.out.println(s);
                    }
                });

allOf && anyOf

allOf：当传入的CompletionStage全部都执行完成的时候，看做完成

anyOf: 当传入的任何一个CompletionStage完成的时候看做完成。

异常处理

当我们使用CompleteFuture进行链式调用的时候，多个异步回调中，如果有一个执行出现问题，那么接下来的回调都会停止，所以需要一种异常处理策略。

exceptionally

exceptionally是当出现错误时，给我们机会进行恢复，自定义返回内容。

        CompletableFuture.supplyAsync(() -> {
            throw new RuntimeException("发生错误");
        }).exceptionally(throwable -> {
            log.error("调用错误 {}", throwable.getMessage(), throwable);
            return "异常处理内容";
        });

handle

exceptionally是只有发生异常时才会执行，而handle则是不管是否发生错误都会执行。

CompletableFuture.supplyAsync(() -> {
    return "abc";
})
.handle((r,err) -> {
    log.error("调用错误 {}", err.getMessage(), err);
    // 对结果做额外的处理
    return r;
})
;

最后

一般情况下上述简单的API已经满足绝大部分的场景了，如果有更复杂的诉求，可继续深入研究。

参考：

https://www.cnblogs.com/txmfz/p/11266411.html

https://www.callicoder.com/java-8-completablefuture-tutorial/