CompletableFuture真香，可以替代CountDownLatch！

点击上方“芋道源码”，选择“设为星标”

管她前浪，还是后浪？

能浪的浪，才是好浪！

每天 10:33 更新文章，每天掉亿点点头发...

源码精品专栏

 

• 原创 | Java 2021 超神之路，很肝~
  

• 中文详细注释的开源项目
  

• RPC 框架 Dubbo 源码解析

• 网络应用框架 Netty 源码解析
  

• 消息中间件 RocketMQ 源码解析
  

• 数据库中间件 Sharding-JDBC 和 MyCAT 源码解析

• 作业调度中间件 Elastic-Job 源码解析

• 分布式事务中间件 TCC-Transaction 源码解析

• Eureka 和 Hystrix 源码解析

• Java 并发源码

来源：小姐姐味道

• 背景

• 一系列静态方法

• 这些花样有很多

• when 和 handle

• 替代 CountDownLatch

• 总结

---

背景

之前我们提到了 Future 和 Promise。Future 相当于一个占位符，代表一个操作将来的结果。一般通过 get 可以直接阻塞得到结果，或者让它异步执行然后通过 callback 回调结果。

但如果回调中嵌入了回调呢？如果层次很深，就是回调地狱。

Java 中的 CompletableFuture 其实就是 Promise，用来解决回调地狱问题。Promise 是为了让代码变得优美而存在的。

有多优美？这么说吧，一旦你使用了 CompletableFuture，就会爱不释手，就像初恋女友一样，天天想着她。

基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序，支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

• 项目地址：https://github.com/YunaiV/ruoyi-vue-pro

• 视频教程：https://doc.iocoder.cn/video/

一系列静态方法

从它的源代码中，我们可以看到，CompletableFuture 直接提供了几个便捷的静态方法入口。其中有 run 和 supply 两组。

run 的参数是 Runnable，而 supply 的参数是 Supplier。前者没有返回值，而后者有，否则没有什么两样。

这两组静态函数，都提供了传入自定义线程池的功能。如果你用的不是外置的线程池，那么它就会使用默认的 ForkJoin 线程池。默认的线程池，大小和用途你是控制不了的，所以还是建议自己传递一个。

典型的代码，写起来是这个样子：

CompletableFuture<String> future = CompletableFuture.supplyAsync(()->{
 return "test";
});
String result = future.join();

拿到 CompletableFuture 后，你就可以做更多的花样。

基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 实现的后台管理系统 + 用户小程序，支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

• 项目地址：https://github.com/YunaiV/yudao-cloud

• 视频教程：https://doc.iocoder.cn/video/

这些花样有很多

我们说面说了，CompletableFuture 的主要作用，就是让代码写起来好看。配合 Java8 之后的 Stream 流，可以把整个计算过程抽象成一个流。

前面任务的计算结果，可以直接作为后面任务的输入，就像是管道一样。

thenApply
thenApplyAsync
thenAccept
thenAcceptAsync
thenRun
thenRunAsync
thenCombine
thenCombineAsync
thenCompose
thenComposeAsync

比如，下面代码的执行结果是 99，并不因为是异步就打乱代码执行的顺序了。

CompletableFuture<Integer> cf = CompletableFuture.supplyAsync(() -> 10)
                .thenApplyAsync((e) -> {
                    try {
                        Thread.sleep(10000);
                    } catch (InterruptedException ex) {
                        ex.printStackTrace();
                    }
                    return e * 10;
                }).thenApplyAsync(e -> e - 1);

cf.join();
System.out.println(cf.get());

同样的，函数的作用还要看 then 后面的动词：

• apply 有入参和返回值，入参为前置任务的输出

• accept 有入参无返回值，会返回 CompletableFuture

• run 没有入参也没有返回值，同样会返回 CompletableFuture

• combine 形成一个复合的结构，连接两个 CompletableFuture，并将它们的2个输出结果，作为 combine 的输入

• compose 将嵌套的 CompletableFuture 平铺开，用来串联两个 CompletableFuture

when 和 handle

上面的函数列表，其实还有很多。比如：

whenComplete

when 的意思，就是任务完成时候的回调。比如我们上面的例子，打算在完成任务后，输出一个 done。它也是属于只有入参没有出参的范畴，适合放在最后一步进行观测。

CompletableFuture<Integer> cf = CompletableFuture.supplyAsync(() -> 10)
                .thenApplyAsync((e) -> {
                    try {
                        Thread.sleep(1000);
                    } catch (InterruptedException ex) {
                        ex.printStackTrace();
                    }
                    return e * 10;
                }).thenApplyAsync(e -> e - 1)
                .whenComplete((r, e)->{
                    System.out.println("done");
                })
                ;

cf.join();
System.out.println(cf.get());

handle 和 exceptionally 的作用，和 whenComplete 是非常像的。

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

public <U> CompletionStage<U> handle(BiFunction<? super T, Throwable, ? extends U> fn);

CompletableFuture 的任务是串联的，如果它的其中某一步骤发生了异常，会影响后续代码的运行的。

exceptionally 从名字就可以看出，是专门处理这种情况的。比如，我们强制某个步骤除以 0，发生异常，捕获后返回 -1，它将能够继续运行。

CompletableFuture<Integer> cf = CompletableFuture.supplyAsync(() -> 10)
                .thenApplyAsync(e->e/0)
                .thenApplyAsync(e -> e - 1)
                .exceptionally(ex->{
                    System.out.println(ex);
                    return -1;
                });

cf.join();
System.out.println(cf.get());

handle 更加高级一些，因为它除了一个异常参数，还有一个正常的入参。处理方法也都类似，不再赘述。

当然，CompletableFuture 的函数不仅仅这些，还有更多，根据函数名称很容易能够了解到它的作用。它还可以替换复杂的 CountDownLatch，这要涉及到几个比较难搞的函数。

替代 CountDownLatch

考虑下面一个场景。某一个业务接口，需要处理几百个请求，请求之后再把这些结果给汇总起来。

如果顺序执行的话，假设每个接口耗时 100ms，那么 100 个接口，耗时就需要 10 秒。假如我们并行去获取的话，那么效率就会提高。

使用 CountDownLatch 可以解决：

ExecutorService executor = Executors.newFixedThreadPool(5);

CountDownLatch countDown = new CountDownLatch(requests.size());
for(Request request:requests){
    executor.execute(()->{
        try{
        //some opts
        }finally{
            countDown.countDown();
        }
    });
}
countDown.await(200,TimeUnit.MILLISECONDS);

我们使用 CompletableFuture 来替换它：

ExecutorService executor = Executors.newFixedThreadPool(5);

List<CompletableFuture<Result>> futureList = requests
    .stream()
    .map(request->
        CompletableFuture.supplyAsync(e->{
            //some opts
        },executor))
    .collect(Collectors.toList());

CompletableFuture<Void> allCF = CompletableFuture.allOf(futureList.toArray(new CompletableFuture[0]));

allCF.join();

我们这里用到了一个主要的函数，那就是 allOf，用来把所有的 CompletableFuture 组合在一起；类似的还有 anyOf，表示只运行其中一个。

常用的，还有三个函数：

• thenAcceptBoth：处理两个任务的情况，有两个任务结果入参，无返回值

• thenCombine：处理两个任务的情况，有入参有返回值，最喜欢

• runAfterBoth：处理两个任务的情况，无入参，无返回值

总结

自从认识了 CompletableFuture，我已经很少硬编码 Future 了。相对于各种回调的嵌套，CompletableFuture 为我们提供了更直观、更优美的 API。在“多个任务等待完成状态”这个应用场景，CompletableFuture 已经成了我的首选。

唯一的问题是，它的函数有点多，你需要熟悉一小段时间。另外，有一个小小的问题，个人觉得，这个类如果叫做 Promise 的话，就能够和 JS 的统一起来，算是锦上添花吧。

---

---

欢迎加入我的知识星球，一起探讨架构，交流源码。加入方式，长按下方二维码噢：

已在知识星球更新源码解析如下：

最近更新《芋道 SpringBoot 2.X 入门》系列，已经 101 余篇，覆盖了 MyBatis、Redis、MongoDB、ES、分库分表、读写分离、SpringMVC、Webflux、权限、WebSocket、Dubbo、RabbitMQ、RocketMQ、Kafka、性能测试等等内容。

提供近 3W 行代码的 SpringBoot 示例，以及超 4W 行代码的电商微服务项目。

获取方式：点“在看”，关注公众号并回复 666 领取，更多内容陆续奉上。

文章有帮助的话，在看，转发吧。
谢谢支持哟 (*^__^*）