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
投稿猜你喜欢
一个简单的微服务架构图本文设计的 Spring Cloud 版本以及用到的 Spring Cloud 组件Spring Cloud Hoxt- Fragment必须是依存于Activity而存在的，因此Activity的生命周期会直接影响到Fragment的生命周期。官网这张图很好的
- 将int数组转化为Integer数组这里使用java8的stream来进行转化，详细步骤如下所示：//初始化int数组int[] nums
- 线程组线程组可以批量管理线程和线程组对象。一级关联例子如下，建立一级关联。public class MyThread43 implement
- 因为某个项目需要，为团队其他兄弟姐妹开发了一个 XML 分析处理器，并将其设计为一个类库，提供相应的 API 接口。为了方便大家的使用，需要
- 本文实例为大家分享了Android实现声音采集回声与回声消除的具体代码，供大家参考，具体内容如下一、回声产生的原因回声（或称回音）是指障碍物
- 本文实例讲述了Android编程之控件状态配置文件。分享给大家供大家参考，具体如下：<selector xmlns:android=&
- C sharp (#) 数据类型获取这里研究一下关于c#中如何获取变量类型的问题。首先我们研究一下如何获取单个变量的类型// 问题一：获取单
- 正好用到。mark一下背景org.springframework.beans及org.springframework.context这两个包
- 这几天Java项目中需要用到Redis，于是学习了一下使用Jedis来操作Redis服务器的相关知识，下面为具体的配置和代码。1、Maven
- 在 Java 语言中的类初始化块 文章中我们简单的介绍了下 Java 中的实例初始化块 ( IIB )。不过我觉得介绍的有点简单了，于是，再
- eclipse中的javac命令与java命令一、eclipse的javac命令：当eclipse对.java(源文件)文件进行保存操作时(
- 1、回顾一下JDK * 的核心参数如果我们要为target类创建一个【JDK * 对象】，那么我们必须要传入如下三个核心参数加载targ
- 一、问题描述LBS位置服务是android应用中重要的功能，应用越来越广泛，下面我们逐步学习和实现lbs相关的应用如定位、地图、导航等，首先
- 什么是事务处理事务是计算机应用中不可或缺的组件模型，它保证了用户操作的原子性 ( Atomicity )、一致性 ( Consistency
- 本文实例讲述了Java 8新增的方法参数反射。分享给大家供大家参考，具体如下：一 点睛Java 8在java.lang.reflect包下新
- Android中socket通信简单实现，供大家参考，具体内容如下socket通信需要有一个服务器和客户端，可以把同一个APP作为服务器跟客
- eclipse的代码提交到git,下载后用新的ide工具IJ 进行开发一、导入项目eclipse里有workSpace 但是在IDEA中没有
- 前言：这两天在整WebApi的服务，由于调用方是Android客户端，Android开发人员也不懂C#语法，API里面的接口也不能直接给他们
- 1.使用的是maven项目，添加依赖<!-- mybatis-plus begin --> <depend
