Spring Boot 异步框架的使用详解
作者：JavaDog 发布时间：2022-11-14 23:10:38
1. 前言
随着数据量和调用量的增长，用户对应用的性能要求越来越高。另外，在实际的服务中，还存在着这样的场景：系统在组装数据的时候，对于数据的各个部分的获取实际上是没有前后依赖关系的。这些问题都很容易让我们想到将这些同步调用全都改造为异步调用。不过自己实现起来比较麻烦，还容易出错。好在Spring已经提供了该问题的解决方案，而且使用起来十分方便。
2.Spring异步执行框架的使用方法
2.1 maven 依赖
Spring异步执行框架的相关bean包含在spring-context和spring-aop模块中，所以只要引入上述的模块即可。
2.2 开启异步任务支持
Spring提供了@EnableAsync的注解来标注是否启用异步任务支持。使用方式如下:
@Configuration
@EnableAsync
public class AppConfig {
}
Note: @EnableAsync必须要配合@Configuration使用，否则会不生效
2.3 方法标记为异步调用
将同步方法的调用改为异步调用也很简单。对于返回值为void的方法，直接加上@Async注解即可。对于有返回值的方法，除了加上上述的注解外，还需要将方法的返回值修改为Future类型和将返回值用AsyncResult包装起来。如下所示：
// 无返回值的方法直接加上注解即可。
@Async
public void method1() {
...
}
// 有返回值的方法需要修改返回值。
@Async
public Future<Object> method2() {
...
return new AsyncResult<>(Object);
}
2.4 方法调用
对于void的方法，和普通的调用没有任何区别。对于非void的方法，由于返回值是Future类型，所以需要用get()方法来获取返回值。如下所示：
public static void main(String[] args) {
service.method1();
Future<Object> futureResult = service.method2();
Object result;
try {
result = futureResult.get();
} catch (InterruptedException | ExecutionException e) {
...
}
}
3. 原理简介
这块的源码的逻辑还是比较简单的，主要是Spring帮我们生成并管理了一个线程池，然后方法调用的时候使用 * 将方法的执行包装为Callable类型并提交到线程池中执行。核心的实现逻辑在AsyncExecutionInterceptor类的invoke()方法中。如下所示：
@Override
public Object invoke(final MethodInvocation invocation) throws Throwable {
Class<?> targetClass = (invocation.getThis() != null ? AopUtils.getTargetClass(invocation.getThis()) : null);
Method specificMethod = ClassUtils.getMostSpecificMethod(invocation.getMethod(), targetClass);
final Method userDeclaredMethod = BridgeMethodResolver.findBridgedMethod(specificMethod);
AsyncTaskExecutor executor = determineAsyncExecutor(userDeclaredMethod);
if (executor == null) {
throw new IllegalStateException(
"No executor specified and no default executor set on AsyncExecutionInterceptor either");
}
Callable<Object> task = new Callable<Object>() {
@Override
public Object call() throws Exception {
try {
Object result = invocation.proceed();
if (result instanceof Future) {
return ((Future<?>) result).get();
}
}
catch (ExecutionException ex) {
handleError(ex.getCause(), userDeclaredMethod, invocation.getArguments());
}
catch (Throwable ex) {
handleError(ex, userDeclaredMethod, invocation.getArguments());
}
return null;
}
};
return doSubmit(task, executor, invocation.getMethod().getReturnType());
}
4.自定义taskExecutor及异常处理
4.1自定义taskExecutor
Spring查找TaskExecutor逻辑是：
1. 如果Spring context中存在唯一的TaskExecutor bean，那么就使用这个bean。
2. 如果1中的bean不存在，那么就会查找是否存在一个beanName为taskExecutor且是java.util.concurrent.Executor实例的bean，有则使用这个bean。
3. 如果1、2中的都不存在，那么Spring就会直接使用默认的Executor，即SimpleAsyncTaskExecutor。
在第2节的实例中，我们直接使用的是Spring默认的TaskExecutor。但是对于每一个新的任务，SimpleAysncTaskExecutor都是直接创建新的线程来执行，所以无法重用线程。具体的执行的代码如下：
@Override
public void execute(Runnable task, long startTimeout) {
Assert.notNull(task, "Runnable must not be null");
Runnable taskToUse = (this.taskDecorator != null ? this.taskDecorator.decorate(task) : task);
if (isThrottleActive() && startTimeout > TIMEOUT_IMMEDIATE) {
this.concurrencyThrottle.beforeAccess();
doExecute(new ConcurrencyThrottlingRunnable(taskToUse));
}
else {
doExecute(taskToUse);
}
}
protected void doExecute(Runnable task) {
Thread thread = (this.threadFactory != null ? this.threadFactory.newThread(task) : createThread(task));
thread.start();
}
所以我们在使用的时候，最好是使用自定义的TaskExecutor。结合上面描述的Spring查找TaskExecutor的逻辑，最简单的自定义的方法是使用@Bean注解。示例如下：
// ThreadPoolTaskExecutor的配置基本等同于线程池
@Bean("taskExecutor")
public Executor getAsyncExecutor() {
ThreadPoolTaskExecutor taskExecutor = new ThreadPoolTaskExecutor();
taskExecutor.setMaxPoolSize(MAX_POOL_SIZE);
taskExecutor.setCorePoolSize(CORE_POOL_SIZE);
taskExecutor.setQueueCapacity(CORE_POOL_SIZE * 10);
taskExecutor.setThreadNamePrefix("wssys-async-task-thread-pool");
taskExecutor.setWaitForTasksToCompleteOnShutdown(true);
taskExecutor.setAwaitTerminationSeconds(60 * 10);
taskExecutor.setRejectedExecutionHandler(new ThreadPoolExecutor.AbortPolicy());
return taskExecutor;
}
另外，Spring还提供了一个AsyncConfigurer接口，通过实现该接口，除了可以实现自定义Executor以外，还可以自定义异常的处理。代码如下：
@Configuration
@Slf4j
public class AsyncConfig implements AsyncConfigurer {
private static final int MAX_POOL_SIZE = 50;
private static final int CORE_POOL_SIZE = 20;
@Override
@Bean("taskExecutor")
public Executor getAsyncExecutor() {
ThreadPoolTaskExecutor taskExecutor = new ThreadPoolTaskExecutor();
taskExecutor.setMaxPoolSize(MAX_POOL_SIZE);
taskExecutor.setCorePoolSize(CORE_POOL_SIZE);
taskExecutor.setQueueCapacity(CORE_POOL_SIZE * 10);
taskExecutor.setThreadNamePrefix("async-task-thread-pool");
taskExecutor.setWaitForTasksToCompleteOnShutdown(true);
taskExecutor.setAwaitTerminationSeconds(60 * 10);
taskExecutor.setRejectedExecutionHandler(new ThreadPoolExecutor.AbortPolicy());
return taskExecutor;
}
@Override
public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
return (ex, method, params) -> log.error("invoke async method occurs error. method: {}, params: {}",
method.getName(), JSON.toJSONString(params), ex);
}
}
Note:
Spring还提供了一个AsyncConfigurerSupport类，该类也实现了AsyncConfigurer接口，且方法的返回值都是null，旨在提供一个方便的实现。
当getAsyncExecutor()方法返回null的时候，Spring会使用默认的处理器（强烈不推荐）。
当getAsyncUncaughtExceptionHandler()返回null的时候，Spring会使用SimpleAsyncUncaughtExceptionHandler来处理异常，该类会打印出异常的信息。
所以对该类的使用，最佳的实践是继承该类，并且覆盖实现getAsyncExecutor()方法。
4.2 异常处理
Spring异步框架对异常的处理如下所示：
// 所在类：AsyncExecutionAspectSupport
protected void handleError(Throwable ex, Method method, Object... params) throws Exception {
if (Future.class.isAssignableFrom(method.getReturnType())) {
ReflectionUtils.rethrowException(ex);
}
else {
// Could not transmit the exception to the caller with default executor
try {
this.exceptionHandler.handleUncaughtException(ex, method, params);
}
catch (Throwable ex2) {
logger.error("Exception handler for async method '" + method.toGenericString() +
"' threw unexpected exception itself", ex2);
}
}
}
从代码来看，如果返回值是Future类型，那么直接将异常抛出。如果返回值不是Future类型（基本上包含的是所有返回值void类型的方法，因为如果方法有返回值，必须要用Future包装起来），那么会调用handleUncaughtException方法来处理异常。
注意：在handleUncaughtException()方法中抛出的任何异常，都会被Spring Catch住，所以没有办法将void的方法再次抛出并传播到上层调用方的！！！
关于Spring 这个设计的缘由我的理解是：既然方法的返回值是void，就说明调用方不关心方法执行是否成功，所以也就没有必要去处理方法抛出的异常。如果需要关心异步方法是否成功，那么返回值改为boolean就可以了。
4.4 最佳实践的建议
@Async可以指定方法执行的Executor，用法：@Async("MyTaskExecutor")。推荐指定Executor，这样可以避免因为Executor配置没有生效而Spring使用默认的Executor的问题。
实现接口AsyncConfigurer的时候，方法getAsyncExecutor()必须要使用@Bean，并指定Bean的name。如果不使用@Bean，那么该方法返回的Executor并不会被Spring管理。用java doc api的原话是：is not a fully managed Spring bean.（具体含义没有太理解，不过亲测不加这个注解无法正常使用）
由于其本质上还是基于代理实现的，所以如果一个类中有A、B两个异步方法，而A中存在对B的调用，那么调用A方法的时候，B方法不会去异步执行的。
在异步方法上标注@Transactional是无效的。
future.get()的时候，最好使用get(long timeout, TimeUnit unit)方法，避免长时间阻塞。
ListenableFuture和CompletableFuture也是推荐使用的，他们相比Future，提供了对异步调用的各个阶段或过程进行介入的能力。
来源：https://juejin.im/post/5c3fe71ff265da61223a966c
0
投稿猜你喜欢
- 本文实例讲述了Java编程实现判断网上邻居文件是否存在的方法。分享给大家供大家参考，具体如下：由于java不支持通过//192.168.19
- 在生产环境中，需要实时或定期监控服务的可用性。spring-boot 的actuator（监控）功能提供了很多监控所需的接口。简单的配置和使
java沙箱环境测试支付宝支付接口?准备工作,登陆支付宝开放平台,进入沙箱环境开放平台链接:https://developers.alipa- 在本篇博文中，我们主要讲解一下 IntelliJ IDEA 安装目录中的一些核心文件的功能及用法：如上图所示，我们定位到了 IntelliJ
- 1. 需要事先将jar包 放在kettle 的 libext 目录，kettle 在启动时会自动加载libext 目录下的所有 jar 包。
- 什么是进程？电脑中时会有很多单独运行的程序，每个程序有一个独立的进程，而进程之间是相互独立存在的。比如下图中的QQ、酷狗播放器、电脑管家等等
- java 中遍历取值异常（Hashtable Enumerator）解决办法用迭代器取值时抛出的异常：java.util.NoSuchEle
- 1.概述Spring Boot Admin是一个Web应用程序，用于管理和监视Spring Boot应用程序。每个应用程序都被视为客户端，并
- Java 日期转换涉及的核心类：Date类、SimpleDateFormat类、Calendar类一、 Date型与long型Date型转换
- 本文实例为大家分享了使用aop实现全局异常处理的具体代码，供大家参考，具体内容如下日常业务中存在的问题使用大量的try/catch来捕获异常
- java 数据类型：在Java中，数据类型分为两大种：基本数据类型（值类型）和包装类型（引用数据类型）。基本数据类型不是对象，不能调用toS
- 该配置基于IDEA2020.1版本,如后续有版本更新或者配置变更,再更新idea64.exe.vmoptions配置为提供IDEA启动速度和
- PipedOutputStream和PipedInputStream在java中，PipedOutputStream和PipedInputS
- 由于众所周知的原因，maven的库在中国大陆非常慢。我在百度上搜到的大部分文章都是直接在~/.m2/settings.xml 加入以下内容&
- 资源加载器使用Java，您可以使用当前线程的classLoader并尝试加载文件，但是Spring Framework为您提供了更为优雅的解
- 前言《英文猜词游戏》代码行数没有超过200行，是之前为了背英语单词，特意研发的小游戏。主要设计1.事先准备单词文本。2.为了让玩家能与程序互
- 介绍：kaptcha 是谷歌开源的非常实用的验证码生成工具一、导入jar包<!-- kaptcha验证码 --><depe
- Mybatis映射文件mapper.xml的注释问题从昨天夜晚9点到今天中午，一直被项目bug所困惑，中间这段时间一直未解决这个问题，也咨询
- 本文实例讲述了C#控制图像旋转和翻转的方法。分享给大家供大家参考。具体实现方法如下：using System;using System.Co
- 前言：线性表（linear list）是n个具有相同特性的数据元素的有限序列。线性表是一种在实际中广泛使用的数据结构，常见的线性表：顺序表、
