一、🌈CompletableFuture简介 CompletableFuture结合了Future的优点,提供了非常强大的Future的扩展功能,可以帮助我们简化异步编程的复杂性,提供了函数式编程的能力,可以通过回调的方
CompletableFuture
结合了Future
的优点,提供了非常强大的Future
的扩展功能,可以帮助我们简化异步编程的复杂性,提供了函数式编程的能力,可以通过回调的方式处理计算结果,并且提供了转换和组合CompletableFuture
的方法。CompletableFuture
被设计在Java
中进行异步编程。异步编程意味着在主线程之外创建一个独立的线程,与主线程分隔开,并在上面运行一个非阻塞的任务,然后通知主线程进展,成功或者失败。CompletableFuture
是由Java8
引入的,在Java8
之前我们一般通过Future
实现异步。
Future
用于表示异步计算的结果,只能通过阻塞或者轮询的方式获取结果,而且不支持设置回调方法,Java8
之前若要设置回调一般会使用guava
的ListenableFuture
。CompletableFuture
对Future
进行了扩展,可以通过设置回调的方式处理计算结果,同时也支持组合操作,支持进一步的编排,同时一定程度解决了回调地狱的问题。
使用Future局限性
从本质上说,Future表示一个异步计算的结果。它提供了isDone()
来检测计算是否已经完成,并且在计算结束后,可以通过get()
方法来获取计算结果。在异步计算中,Future
确实是个非常优秀的接口。但是,它的本身也确实存在着许多限制:
Future
只提供了get()
方法来获取结果,并且是阻塞的。所以,除了等待你别无他法;Future
却没有提供这样的能力;Future
中这是无能为力的;Future
接口中没有关于异常处理的方法;方法 | 说明 | 描述 |
---|---|---|
boolean | cancel (boolean mayInterruptIfRunning) | 尝试取消执行此任务。 |
V | get() | 如果需要等待计算完成,然后检索其结果。 |
V | get(long timeout, TimeUnit unit) | 如果需要,最多等待计算完成的给定时间,然后检索其结果(如果可用)。 |
boolean | isCancelled() | 如果此任务在正常完成之前取消,则返回 true 。 |
boolean | isDone() | 如果此任务完成,则返回 true 。 |
public class CompletableFuture implements Future, CompletionStage {}复制代码
jdk1.8
才新加入的一个实现类CompletableFuture
,而CompletableFuture
实现了两个接口(如上面代码所示):Future
、CompletionStage
,意味着可以像以前一样通过阻塞或者轮询的方式获得结果。
Future
表示异步计算的结果,CompletionStage
用于表示异步执行过程中的一个步骤Stage
,这个步骤可能是由另外一个CompletionStage
触发的,随着当前步骤的完成,也可能会触发其他一系列CompletionStage
的执行。从而我们可以根据实际业务对这些步骤进行多样化的编排组合,CompletionStage
接口正是定义了这样的能力,我们可以通过其提供的thenAppy、thenCompose
等函数式编程方法来组合编排这些步骤。
CompletableFuture
实现了Future
接口,并在此基础上进行了丰富地扩展,完美地弥补了Future
上述的种种问题。更为重要的是,CountDownLatch
等工具类也可以实现任务的编排,但需要复杂的逻辑处理,不仅耗费精力且难以维护。CompletionStage
接口提供了更多方法来更好的实现异步编排,并且大量的使用了JDK8
引入的函数式编程概念。由stage
执行的计算可以表示为Function,Consumer或Runnable
(使用名称分别包括apply 、accept或run
的方法 ),具体取决于它是否需要参数和/或产生结果。 例如:
stage.thenApply(x -> square(x)).thenAccept(x -> System.out.print(x)).thenRun(() -> System.out.println()); 复制代码
1️⃣ 执行比较耗时的操作时,尤其是那些依赖一个或多个远程服务的操作,使用异步任务可以改善程序的性能,加快程序的响应速度;
2️⃣ 使用CompletableFuture
类,它提供了异常管理的机制,让你有机会抛出、管理异步任务执行种发生的异常;
3️⃣ 如果这些异步任务之间相互独立,或者他们之间的的某一些的结果是另一些的输入,你可以讲这些异步任务构造或合并成一个。
举个常见的案例🌰,在APP
查询首页信息的时候,一般会涉及到不同的rpc
远程调用来获取很多用户相关信息数据,比如:商品banner轮播图信息、用户message消息信息、用户权益信息、用户优惠券信息 等,假设每个rpc invoke()
耗时是250ms
,那么基于同步的方式获取到话,算下来接口的RT
至少大于1s,这响应时长对于首页来说是万万不能接受的,因此,我们这种场景就可以通过多线程异步的方式去优化。
根据CompletableFuture
依赖数量,可以分为以下几类:零依赖、单依赖、双重依赖和多重依赖 。
零依赖
下图Future1、Future2
都是零依赖的体现:
单依赖:仅依赖于一个CompletableFuture
下图Future3、Future5
都是单依赖的体现,分别依赖于Future1
和Future2
:
双重依赖:同时依赖于两个CompletableFuture
下图Future4
即为双重依赖的体现,同时依赖于Future1
和Future2
:
多重依赖:同时依赖于多个CompletableFuture
下图Future6
即为多重依赖的体现,同时依赖于Future3
、Future4
和Future5
:
类似这种多重依赖的流程来说,结果依赖于三个步骤:Future3、Future4、Future5
,这种多元依赖可以通过allOf()
或anyOf()
方法来实现,区别是当需要多个依赖全部完成时使用allOf()
,当多个依赖中的任意一个完成即可时使用anyOf()
,如下代码所示:
CompletableFuture Future6 = CompletableFuture.allOf(Future3, Future4, Future5);CompletableFuture result = Future6.thenApply(v -> { //这里的join并不会阻塞,因为传给thenApply的函数是在Future3、Future4、Future5全部完成时,才会执行 。 result3 = Future3.join(); result4 = Future4.join(); result5 = Future5.join(); // 返回result3、result4、result5组装后结果 return assamble(result3, result4, result5);});复制代码
在分析CompletableFuture
异步编排之前,我跟大家理清一下CompletionStage
接口下 (thenRun、thenApply、thenAccept、thenCombine、thenCompose)、(handle、whenComplete、exceptionally) 相关方法的实际用法和它们之间的区别是什么? 带着你的想法💭往下看吧!!!
thenRun
:【执行】直接开启一个异步线程执行任务,不接收任何参数,回调方法没有返回值;thenApply
:【提供】可以提供返回值,接收上一个任务的执行结果,作为下一个Future
的入参,回调方法是有返回值的;thenAccept
:【接收】可以接收上一个任务的执行结果,作为下一个Future
的入参,回调方法是没有返回值的;thenCombine
:【结合】可以结合不同的Future
的返回值,做为下一个Future
的入参,回调方法是有返回值的;thenCompose
:【组成】将上一个Future
实例结果传递给下一个实例中。✔异步回调建议使用自定义线程池
@Configurationpublic class ThreadPoolConfig { @Bean(value = "customAsyncTaskExecutor") public ThreadPoolTaskExecutor asyncThreadPoolExecutor() { ThreadPoolTaskExecutor threadPoolTaskExecutor = new ThreadPoolTaskExecutor(); threadPoolTaskExecutor.setCorePoolSize(5); threadPoolTaskExecutor.setMaxPoolSize(10); threadPoolTaskExecutor.seTKEepAliveSeconds(60); threadPoolTaskExecutor.setQueueCapacity(2048); threadPoolTaskExecutor.setWaitForTasksToCompleteOnShutdown(true); threadPoolTaskExecutor.setThreadNamePrefix("customAsyncTaskExecutor-"); threadPoolTaskExecutor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy()); return threadPoolTaskExecutor; } @Bean(value = "threadPoolExecutor") public ThreadPoolExecutor threadPoolExecutor() { ThreadPoolExecutor threadPoolExecutor = new ThreadPoolExecutor(10, 10, 60L, TimeUnit.SECONDS, new ArrayBlockingQueue<>(10000), new ThreadPoolExecutor.CallerRunsPolicy()); return threadPoolExecutor; }}复制代码
如果所有异步回调都会共用该CommonPool
,核心与非核心业务都竞争同一个池中的线程,很容易成为系统瓶颈。手动传递线程池参数可以更方便的调节参数,并且可以给不同的业务分配不同的线程池,以求资源隔离,减少不同业务之间的相互干扰。所以,强烈建议你要根据不同的业务类型创建不同的线程池,以避免互相干扰。通过自定义线程池customAsyncTaskExecutor
,后面不同的异步编排方法,我们可以通过指定对应的线程池。
1️⃣ runAsync()、thenRun()
@RestControllerpublic class CompletableFutureCompose { @Resource private ThreadPoolTaskExecutor customAsyncTaskExecutor; @RequestMapping(value = "/thenRun") public void thenRun() { CompletableFuture.runAsync(() -> { System.out.println("thread name:" + Thread.currentThread().getName() + " first step..."); }, customAsyncTaskExecutor).thenRun(() -> { System.out.println("thread name:" + Thread.currentThread().getName() + " second step..."); }).thenRunAsync(() -> { System.out.println("thread name:" + Thread.currentThread().getName() + " third step..."); }); }}复制代码
接口输出结果:
thread name:customAsyncTaskExecutor-1 first step...thread name:customAsyncTaskExecutor-1 second step...thread name:ForkJoinPool.commonPool-worker-3 third step...复制代码
2️⃣ thenApply()
@RequestMapping(value = "/thenApply")public void thenApply() { CompletableFuture.supplyAsync(() -> { System.out.println("thread name:" + Thread.currentThread().getName() + " first step..."); return "hello"; }, customAsyncTaskExecutor).thenApply((result1) -> { String targetResult = result1 + " austin"; System.out.println("first step result: " + result1); System.out.println("thread name:" + Thread.currentThread().getName() + " second step..., targetResult: " + targetResult); return targetResult; });}复制代码
接口输出结果:
thread name:customAsyncTaskExecutor-2 first step...first step result: hello// thenApply虽然没有指定线程池,但是默认是复用它上一个任务的线程池的thread name:customAsyncTaskExecutor-2 second step..., targetResult: hello austin复制代码
3️⃣ thenAccept()
@RequestMapping(value = "/thenAccept")public void thenAccept() { CompletableFuture.supplyAsync(() -> { System.out.println("thread name:" + Thread.currentThread().getName() + " first step..."); return "hello"; }, customAsyncTaskExecutor).thenAccept((result1) -> { String targetResult = result1 + " austin"; System.out.println("first step result: " + result1); System.out.println("thread name:" + Thread.currentThread().getName() + " second step..., targetResult: " + targetResult); });}复制代码
接口输出结果:
thread name:customAsyncTaskExecutor-3 first step...first step result: hello// thenAccept在没有指定线程池的情况下,并未复用它上一个任务的线程池thread name:Http-NIO-10032-exec-9 second step..., targetResult: hello austin复制代码
thenAccept()
和thenApply()
的用法实际上基本上一致,区别在于thenAccept()
回调方法是没有返回值的,而thenApply()
回调的带返回值的。
🌈细心的朋友可能会发现,上面thenApply()
和thenAccept()
请求线程池在不指定的情况下,两者的不同表现,thenApply()
在不指定线程池的情况下,会沿用上一个Future
指定的线程池customAsyncTaskExecutor
,而thenAccept()
在不指定线程池的情况,并没有复用上一个Future
设置的线程池,而是重新创建了新的线程来实现异步调用。
4️⃣ thenCombine()
@RequestMapping(value = "/thenCombine")public void thenCombine() { CompletableFuture future1 = CompletableFuture.supplyAsync(() -> { System.out.println("执行future1开始..."); return "Hello"; }, asyncThreadPoolExecutor); CompletableFuture future2 = CompletableFuture.supplyAsync(() -> { System.out.println("执行future2开始..."); return "World"; }, asyncThreadPoolExecutor); future1.thenCombine(future2, (result1, result2) -> { String result = result1 + " " + result2; System.out.println("获取到future1、future2聚合结果:" + result); return result; }).thenAccept(result -> System.out.println(result));}复制代码
接口访问,打印结果:
thread name:customAsyncTaskExecutor-4 执行future1开始...thread name:customAsyncTaskExecutor-5 执行future2开始...thread name:http-nio-10032-exec-8 获取到future1、future2聚合结果:Hello WorldHello World复制代码
5️⃣ thenCompose()
我们先有future1
,然后和future2
组成一个链:future1 -> future2
,然后又组合了future3
,形成链:future1 -> future2 -> future3
。这里有个隐藏的点:future1、future2、future3
它们完全没有数据依赖关系,我们只不过是聚合了它们的结果。
@RequestMapping(value = "/thenCompose")public void thenCompose() { CompletableFuture.supplyAsync(() -> { // 第一个Future实例结果 System.out.println("thread name:" + Thread.currentThread().getName() + " 执行future1开始..."); return "Hello"; }, customAsyncTaskExecutor).thenCompose(result1 -> CompletableFuture.supplyAsync(() -> { // 将上一个Future实例结果传到这里 System.out.println("thread name:" + Thread.currentThread().getName() + " 执行future2开始..., 第一个实例结果:" + result1); return result1 + " World"; })).thenCompose(result12 -> CompletableFuture.supplyAsync(() -> { // 将第一个和第二个实例结果传到这里 System.out.println("thread name:" + Thread.currentThread().getName() + " 执行future3开始..., 第一第二个实现聚合结果:" + result12); String targetResult = result12 + ", I am austin!"; System.out.println("最终输出结果:" + targetResult); return targetResult; }));}复制代码
接口访问,打印结果:
thread name:customAsyncTaskExecutor-1 执行future1开始...thread name:ForkJoinPool.commonPool-worker-3 执行future2开始..., 第一个实例结果:Hellothread name:ForkJoinPool.commonPool-worker-3 执行future3开始..., 第一第二个实现聚合结果:Hello World最终输出结果:Hello World, I am austin!复制代码
💥Note:thenCombine() VS thenCompose(),两者之间的区别
thenCombine
结合的两个CompletableFuture
没有依赖关系,且第二个CompletableFuture
不需要等第一个CompletableFuture
执行完成才开始。thenCompose()
可以两个CompletableFuture
对象,并将前一个任务的返回结果作为下一个任务的参数,它们之间存在着先后顺序。thenCombine()
会在两个任务都执行完成后,把两个任务的结果合并。两个任务是并行执行的,它们之间并没有先后依赖顺序。
// 返回一个新的CompletableFuture,由线程池ForkJoinPool.commonPool()中运行的任务异步完成,不会返回结果。public static CompletableFuture runAsync(Runnable runnable);// 返回一个新的CompletableFuture,运行任务时可以指定自定义线程池来实现异步,不会返回结果。public static CompletableFuture runAsync(Runnable runnable, Executor executor);// 返回由线程池ForkJoinPool.commonPool()中运行的任务异步完成的新CompletableFuture,可以返回异步线程执行之后的结果。public static CompletableFuture supplyAsync(Supplier supplier);public static CompletableFuture supplyAsync(Supplier supplier, Executor executor);复制代码
CompletableFuture
有两种方式实现异步,一种是supply
开头的方法,一种是run
开头的方法:
supply
开头:该方法可以返回异步线程执行之后的结果;run
开头:该方法不会返回结果,就只是执行线程任务。public T get()public T get(long timeout, TimeUnit unit)public T getNow(T valueIfAbsent)public T join()public CompletableFuture
使用方式,演示🌰:
CompletableFuture future = new CompletableFuture<>();Integer integer = future.get();复制代码
get()
:阻塞式获取执行结果,如果任务还没有完成则会阻塞等待知直到任务执行完成get(long timeout, TimeUnit unit)
:带超时的阻塞式获取执行结果getNow()
:如果已完成,立刻返回执行结果,否则返回给定的valueIfAbsent
join()
:该方法和get()
方法作用一样, 不抛异常的阻塞式获取异步执行结果allOf()
:当给定的所有CompletableFuture
都完成时,返回一个新的CompletableFuture
anyOf()
:当给定的其中一个CompletableFuture
完成时,返回一个新的CompletableFuture
💥Note:
join()
和get()
方法都是 阻塞式 调用它们的线程(通常为主线程)来获取CompletableFuture
异步之后的返回值。- 两者的区别在于
join()
返回计算的结果或者抛出一个unchecked
异常CompletionException
,而get()
返回一个具体的异常。
当使用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)复制代码
使用CompletableFuture
编写代码时,异常处理很重要,CompletableFuture
提供了三种方法来处理它们:handle()、whenComplete() 和 exceptionly()。
handle
:返回一个新的CompletionStage
,当该阶段正常或异常完成时,将使用此阶段的结果和异常作为所提供函数的参数执行,不会将内部异常抛出。whenComplete
:返回与此阶段具有相同结果或异常的新CompletionStage
,该阶段在此阶段完成时执行给定操作。与方法handle
不同,会将内部异常往外抛出。exceptionally
:返回一个新的CompletableFuture
,CompletableFuture
提供了异常捕获回调exceptionally
,相当于同步调用中的try/catch
。@Autowiredprivate RemoteDictService remoteDictService;public CompletableFuture getDictDataAsync(long dictId) { CompletableFuture resultFuture = remoteDictService.findDictById(dictId); // 业务方法,内部会发起异步rpc调用 return resultFuture .exceptionally(error -> { //通过exceptionally捕获异常,打印日志并返回默认值 log.error("RemoteDictService.getDictDataAsync Exception dictId = {}", dictId, error); return null; });}复制代码
handle() VS whenComplete(), 两者之间的区别
whenComplete
不消费异常,而handle
消费异常Two method fORMs support processing whether the triggering stage completed normally or exceptionally:
Method {whenComplete} allows injection of an action regardless of outcome, otherwise preserving the outcome in its completion.
Method {handle} additionally allows the stage to compute a replacement result that may enable further processing by other dependent stages.
翻译过来就是:
两种方法形式支持处理触发阶段是否 正常完成 或 异常完成:
whenComplete
:可以访问当前CompletableFuture
的 结果 和 异常 作为参数,使用它们并执行您想要的操作。此方法并不能转换完成的结果,会内部抛出异常。handle
:当此阶段正常或异常完成时,将使用此阶段的结果和异常作为所提供函数的参数来执行。当此阶段完成时,以 该阶段的结果 和 该阶段的异常 作为参数调用给定函数,并且函数的结果用于完成返回的阶段,不会把异常外抛出来。这里我通过代码演示一下:
public class CompletableFutureExceptionHandler { public static CompletableFuture handle(int a, int b) { return CompletableFuture.supplyAsync(() -> a / b) .handle((result, ex) -> { if (null != ex) { System.out.println("handle error: " + ex.getMessage()); return 0; } else { return result; } }); } public static CompletableFuture whenComplete(int a, int b) { return CompletableFuture.supplyAsync(() -> a / b) .whenComplete((result, ex) -> { if (null != ex) { System.out.println("whenComplete error: " + ex.getMessage()); } }); } public static void main(String[] args) { try { System.out.println("success: " + handle(10, 5).get()); System.out.println("fail: " + handle(10, 0).get()); } catch (Exception e) { System.out.println("catch exception= " + e.getMessage()); } System.out.println("------------------------------------------------------------------"); try { System.out.println("success: " + whenComplete(10, 5).get()); System.out.println("fail: " + whenComplete(10, 0).get()); } catch (Exception e) { System.out.println("catch exception=" + e.getMessage()); } }}复制代码
运行结果如下显示:
success: 2handle error: java.lang.ArithmeticException: / by zerofail: 0------------------------------------------------------------------success: 2whenComplete error: java.lang.ArithmeticException: / by zerocatch exception=java.lang.ArithmeticException: / by zero复制代码
✔可以看到,handle
处理,当程序发生异常的时候,即便是catch
获取异常期望输出,但是并未跟实际预想那样,原因是handle
不会把内部异常外抛出来,而whenComplete
会将内部异常抛出。
🔥Note:关于异步线程池(十分重要)
异步回调方法可以选择是否传递线程池参数
Executor
,这里为了实现线程池隔离,当不传递线程池时,默认会使用ForkJoinPool
中的公共线程池CommonPool
,这个线程池默认创建的线程数是CPU
的核数,如果所有的异步回调共享一个线程池,核心与非核心业务都竞争同一个池中的线程,那么一旦有任务执行一些很慢的I/O
操作,就会导致线程池中所有线程都阻塞在I/O
操作上,很容易成为系统瓶颈,影响整个系统的性能。因此,💥💥 建议强制传线程池,且根据实际情况做线程池隔离,减少不同业务之间的相互干扰。
@RestController@RequestMapping("/index")public class IndexWEBController { @Resource private ThreadPoolExecutor asyncThreadPoolExecutor; @RequestMapping(value = "/homeIndex", method = {RequestMethod.POST, RequestMethod.GET}) public String homeIndex(@RequestParam(required = false) String userId, @RequestParam(value = "lang") String lang) { ResultData result = new ResultData<>(); // 获取Banner轮播图信息 CompletableFuture> future1 = CompletableFuture.supplyAsync(() -> this.buildBanners(userId, lang), asyncThreadPoolExecutor); // 获取用户message通知信息 CompletableFuture future2 = CompletableFuture.supplyAsync(() -> this.buildNotifications(userId, lang), asyncThreadPoolExecutor); // 获取用户权益信息 CompletableFuture> future3 = CompletableFuture.supplyAsync(() -> this.buildBenefits(userId, lang), asyncThreadPoolExecutor); // 获取优惠券信息 CompletableFuture> future4 = CompletableFuture.supplyAsync(() -> this.buildCoupons(userId), asyncThreadPoolExecutor); CompletableFuture allOfFuture = CompletableFuture.allOf(futrue1, futrue2, futrue3, future4); HomeVo finalHomeVO = homeVO; CompletableFuture resultFuture = allOfFuture.thenApply(v -> { try { finalHomeVo.setBanners(future1.get()); finalHomeVo.setNotifications(future2.get()); finalHomeVo.setBenefits(future3.get()); finalHomeVo.setCoupons(future4.get()); return finalHomeVO; } catch (Exception e) { logger.error("[Error] assemble homeVO data error: {}", e); throw new RuntimeException(e); } }); homeVO = resultFuture.join(); result.setData(homeVO); return writeJSON(result); }}复制代码
@SneakyThrowspublic List buildBanners(String userId, String lang) { // 模拟请求耗时0.5秒 Thread.sleep(500); return new List();}@SneakyThrowspublic List buildNotifications(String userId, String lang) { // 模拟请求耗时0.5秒 Thread.sleep(500); return new List();}@SneakyThrowspublic List buildBenefits(String userId, String lang) { // 模拟请求耗时0.5秒 Thread.sleep(500); return new List();}@SneakyThrowspublic List buildCoupons(String userId) { // 模拟请求耗时0.5秒 Thread.sleep(500); return new List();}复制代码
本篇文章主要是介绍了
CompletableFuture
使用原理和相关不同方法的场景化使用,以及通过不同的实例演示了异步回调的过程,好了,今天的分享就到此结束了,如果文章对你有所帮助,欢迎 点赞👍+评论💬+收藏❤
来源地址:https://blog.csdn.net/ww2651071028/article/details/129485158
--结束END--
本文标题: CompletableFuture实现异步编排全面分析和总结
本文链接: https://lsjlt.com/news/414923.html(转载时请注明来源链接)
有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341
2024-04-01
2024-04-03
2024-04-03
2024-01-21
2024-01-21
2024-01-21
2024-01-21
2023-12-23
回答
回答
回答
回答
回答
回答
回答
回答
回答
回答
0