【Spring系列】DeferredResult异步处理

💝💝💝欢迎来到我的博客，很高兴能够在这里和您见面！希望您在这里可以感受到一份轻松愉快的氛围，不仅可以获得有趣的内容和知识，也可以畅所欲言、分享您的想法和见解。

• 推荐:kwan 的首页,持续学习,不断总结,共同进步,活到老学到老
• 导航
  • 檀越剑指大厂系列:全面总结 java 核心技术点,如集合,jvm,并发编程 redis,kafka,Spring,微服务,Netty 等
  • 常用开发工具系列:罗列常用的开发工具,如 IDEA,Mac,Alfred,electerm,Git,typora,apifox 等
  • 数据库系列:详细总结了常用数据库 mysql 技术点,以及工作中遇到的 mysql 问题等
  • 懒人运维系列:总结好用的命令,解放双手不香吗?能用一个命令完成绝不用两个操作
  • 数据结构与算法系列:总结数据结构和算法,不同类型针对性训练,提升编程思维,剑指大厂

非常期待和您一起在这个小小的网络世界里共同探索、学习和成长。💝💝💝 ✨✨ 欢迎订阅本专栏 ✨✨

一.简单介绍

1.DeferredResult 简介

DeferredResult 是 Spring Framework 中用于异步处理请求的一种机制。它允许将处理结果推迟到稍后的时间点，通常用于处理需要较长时间完成的操作，例如异步任务、长时间计算或外部服务调用。

2.功能和特性

1. 异步处理： DeferredResult 允许将请求的处理推迟到稍后的时间，允许应用程序异步地处理请求。

2. 非阻塞： 使用 DeferredResult 不会阻塞容器线程，这有助于提高应用程序的吞吐量。

3. 长轮询： 可以使用 DeferredResult 实现长轮询（long polling）模式，其中客户端发送请求并在服务器端保持挂起状态，直到有数据可用。

二.使用方式

1.Controller 中的方法

Controller 中的方法： 在控制器方法中，返回类型可以是 DeferredResult<T>，其中 T 是要返回的数据类型。

@GetMapping("/async-operation")
public DeferredResult<String> asyncOperation() {DeferredResult<String> deferredResult = new DeferredResult<>();// 在某个异步任务完成后，将结果设置到 DeferredResult 中asyncService.performAsyncOperation().whenComplete((result, throwable) -> deferredResult.setResult(result));return deferredResult;
}

2.异步任务完成后设置结果

异步任务完成后设置结果： 在异步任务完成后，通过 DeferredResult.setResult(result) 将结果设置到 DeferredResult 对象中。

public CompletableFuture<String> performAsyncOperation() {// 异步任务逻辑return CompletableFuture.supplyAsync(() -> "Async operation result");
}

3.自定义线程池

线程池:

public class ThreadPoolUntil {private static final int THREAD_POOL_SIZE = 10;private static ExecutorService executorService = Executors.newFixedThreadPool(THREAD_POOL_SIZE);public static void executeTask(Runnable task) {executorService.submit(task);}public static void shutdown() {executorService.shutdown();}
}

controller:

@ApiOperation(value = "首页-合计列表", nickname = "首页-合计列表")
@PostMapping("/totalList")
public DeferredResult<Payload<List<TotalListDayDTO>>> totalList(@RequestBody TotalListQuery totalListQuery, @RequestHeader(value = "brandDetailNo") String brandDetailNo) {totalListQuery.setBrandDetailNo(brandDetailNo);DeferredResult<Payload<List<TotalListDayDTO>>> deferredResult = new DeferredResult<>(10000L);// 设置超时处理deferredResult.onTimeout(() -> deferredResult.setErrorResult(new Payload("504", "请求超时")));// 设置错误处理deferredResult.onError((Throwable t) -> deferredResult.setErrorResult(new Payload("500", "系统错误")));// 创建任务Runnable task = () -> deferredResult.setResult(new Payload(skuDataBusinessService.totalList(totalListQuery)));ThreadPoolUntil.executeTask(task);return deferredResult;
}

三.原理分析

1.Servlet 异步支持

Servlet 3.0+ 异步支持： DeferredResult 的实现依赖于 Servlet 3.0+ 的异步支持。在处理请求时，容器会将请求转交给异步处理，允许处理线程在异步操作完成前释放。

2.DeferredResult 中介

DeferredResult 作为中介： DeferredResult 充当控制器方法和异步任务之间的中介，使得控制器方法可以在异步任务完成后设置结果。

四.注意事项

1.超时处理

超时处理： 可以设置 DeferredResult 的超时时间，如果异步操作在超时时间内未完成，可以通过设置超时处理逻辑来处理。

deferredResult.setTimeout(5000); // 设置超时时间为5秒
deferredResult.onTimeout(() -> {// 处理超时逻辑deferredResult.setErrorResult("Operation timed out");
});

2.异常处理

异常处理： 需要在异步任务中捕获可能的异常，并在 DeferredResult 中设置错误结果。

asyncService.performAsyncOperation().whenComplete((result, throwable) -> {if (throwable != null) {deferredResult.setErrorResult("An error occurred: " + throwable.getMessage());} else {deferredResult.setResult(result);}});

3.不适用于所有场景

不适用于所有场景： DeferredResult 适用于长时间运行的操作，但并不是适用于所有场景。对于一些简单和快速的操作，同步处理可能更加合适。

总体而言，DeferredResult 是 Spring 中处理异步请求的强大工具，可以帮助改善应用程序的性能和用户体验，特别是在需要处理长时间运行操作的情况下。

觉得有用的话点个赞 👍🏻 呗。
❤️❤️❤️本人水平有限，如有纰漏，欢迎各位大佬评论批评指正！😄😄😄

💘💘💘如果觉得这篇文对你有帮助的话，也请给个点赞、收藏下吧，非常感谢!👍 👍 👍

🔥🔥🔥Stay Hungry Stay Foolish 道阻且长,行则将至,让我们一起加油吧！🌙🌙🌙