深入理解spring boot异步调用方式@Async

更新时间：2017年07月13日 09:42:42 作者：沉淀

Spring为任务调度与异步方法执行提供了注解支持。通过在方法上设置@Async注解，可使得方法被异步调用。下面这篇文章主要给大家介绍了关于spring boot异步调用方式@Async的相关资料，需要的朋友可以参考下。

本文主要给大家介绍了关于spring boot异步调用方式@Async的相关内容，分享出来供大家参考学习，下面来一起看看详细的介绍：

1.使用背景

在日常开发的项目中，当访问其他人的接口较慢或者做耗时任务时，不想程序一直卡在耗时任务上，想程序能够并行执行，我们可以使用多线程来并行的处理任务，也可以使用spring提供的异步处理方式@Async。

2.异步处理方式

调用之后，不返回任何数据。
调用之后，返回数据，通过Future来获取返回数据

3.@Async不返回数据

使用@EnableAsync启用异步注解

@Configuration
@EnableAsync
@Slf4j
public class AsyncConfig{
}

在异步处理的方法dealNoReturnTask上添加注解@Async

@Component
@Slf4j
public class AsyncTask {

 @Async
 public void dealNoReturnTask(){
  log.info("Thread {} deal No Return Task start", Thread.currentThread().getName());
  try {
   Thread.sleep(3000);
  } catch (InterruptedException e) {
   e.printStackTrace();
  }
  log.info("Thread {} deal No Return Task end at {}", Thread.currentThread().getName(), System.currentTimeMillis());
 }
}

Test测试类：

@SpringBootTest(classes = SpringbootApplication.class)
@RunWith(SpringJUnit4ClassRunner.class)
@Slf4j
public class AsyncTest {

 @Autowired
 private AsyncTask asyncTask;

 @Test
 public void testDealNoReturnTask(){
  asyncTask.dealNoReturnTask();
  try {
   log.info("begin to deal other Task!");
   Thread.sleep(10000);
  } catch (InterruptedException e) {
   e.printStackTrace();
  }
 }

日志打印结果为：

begin to deal other Task!
AsyncExecutorThread-1 deal No Return Task start
AsyncExecutorThread-1 deal No Return Task end at 1499751227034

从日志中我们可以看出，方法dealNoReturnTask()是异步执行完成的。

dealNoReturnTask()设置sleep 3s是为了模拟耗时任务

testDealNoReturnTask()设置sleep 10s是为了确认异步是否执行完成

4.@Async返回数据

异步调用返回数据，Future表示在未来某个点获取执行结果，返回数据类型可以自定义

 @Async
 public Future<String> dealHaveReturnTask() {
  try {
   Thread.sleep(3000);
  } catch (InterruptedException e) {
   e.printStackTrace();
  }
  JSONObject jsonObject = new JSONObject();
  jsonObject.put("thread", Thread.currentThread().getName());
  jsonObject.put("time", System.currentTimeMillis());
  return new AsyncResult<String>(jsonObject.toJSONString());
 }

测试类用isCancelled判断异步任务是否取消，isDone判断任务是否执行结束

 @Test
 public void testDealHaveReturnTask() throws Exception {

  Future<String> future = asyncTask.dealHaveReturnTask();
  log.info("begin to deal other Task!");
  while (true) {
   if(future.isCancelled()){
    log.info("deal async task is Cancelled");
    break;
   }
   if (future.isDone() ) {
    log.info("deal async task is Done");
    log.info("return result is " + future.get());
    break;
   }
   log.info("wait async task to end ...");
   Thread.sleep(1000);
  }
 }

日志打印如下，我们可以看出任务一直在等待异步任务执行完毕，用future.get()来获取异步任务的返回结果

begin to deal other Task!
wait async task to end ...
wait async task to end ...
wait async task to end ...
wait async task to end ...
deal async task is Done
return result is {"thread":"AsyncExecutorThread-1","time":1499752617330}

4.异常处理
我们可以实现AsyncConfigurer接口，也可以继承AsyncConfigurerSupport类来实现

在方法getAsyncExecutor()中创建线程池的时候，必须使用 executor.initialize() ，不然在调用时会报线程池未初始化的异常。

如果使用threadPoolTaskExecutor()来定义bean，则不需要初始化

@Configuration
@EnableAsync
@Slf4j
public class AsyncConfig implements AsyncConfigurer {

// @Bean
// public ThreadPoolTaskExecutor threadPoolTaskExecutor(){
//  ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
//  executor.setCorePoolSize(10);
//  executor.setMaxPoolSize(100);
//  executor.setQueueCapacity(100);
//  return executor;
// }

 @Override
 public Executor getAsyncExecutor() {
  ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
  executor.setCorePoolSize(10);
  executor.setMaxPoolSize(100);
  executor.setQueueCapacity(100);
  executor.setThreadNamePrefix("AsyncExecutorThread-");
  executor.initialize(); //如果不初始化，导致找到不到执行器
  return executor;
 }
 @Override
 public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
  return new AsyncExceptionHandler();
 }
}

异步异常处理类：

@Slf4j
public class AsyncExceptionHandler implements AsyncUncaughtExceptionHandler {
 @Override
 public void handleUncaughtException(Throwable ex, Method method, Object... params) {
  log.info("Async method: {} has uncaught exception,params:{}", method.getName(), JSON.toJSONString(params));

  if (ex instanceof AsyncException) {
   AsyncException asyncException = (AsyncException) ex;
   log.info("asyncException:{}",asyncException.getErrorMessage());
  }

  log.info("Exception :");
  ex.printStackTrace();
 }
}

异步处理异常类：

@Data
@AllArgsConstructor
public class AsyncException extends Exception {
 private int code;
 private String errorMessage;
}

在无返回值的异步调用中，异步处理抛出异常，AsyncExceptionHandler的handleUncaughtException()会捕获指定异常，原有任务还会继续运行，直到结束。
在有返回值的异步调用中，异步处理抛出异常，会直接抛出异常，异步任务结束，原有处理结束执行。

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作能带来一定的帮助，如果有疑问大家可以留言交流，谢谢大家对脚本之家的支持。

您可能感兴趣的文章:

Spring事务失效的原因及解决方案
本文主要介绍了Spring事务失效的原因及解决方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
2024-07-07
Spring根据XML配置文件 p名称空间注入属性的实例
下面小编就为大家分享一篇Spring根据XML配置文件 p名称空间注入属性的实例，具有很好的参考价值。希望对大家有所帮助
2017-11-11
Java泛型＜T＞ T、 T、＜T＞的用法小结
T在Java泛型中,被称作类型变量, 有的方法返回值是<T> T,有的是T,区别在哪里,本文主要介绍了Java泛型＜T＞ T、 T、＜T＞的用法小结,具有一定的参考价值,感兴趣的可以了解下
2023-12-12
IDEA提示 add *** to custom tags问题及解决
文章介绍了如何在文档注释中添加自定义注解（@xxx）,并提供了添加和删除注解的方法,总结了个人经验,希望对大家有所帮助
2024-12-12
SpringBoot开启异步调用方法
这篇文章主要为大家详细介绍了SpringBoot开启异步调用方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-09-09
Springboot如何统一处理Filter异常
这篇文章主要介绍了Springboot如何统一处理Filter异常问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2023-12-12
Java中List排序的三种实现方法实例
其实Java针对数组和List的排序都有实现,对数组而言你可以直接使用Arrays.sort,对于List和Vector而言,你可以使用Collections.sort方法,下面这篇文章主要给大家介绍了关于Java中List排序的三种实现方法,需要的朋友可以参考下
2021-12-12
java简明例举讲解泛型
这篇文章主要介绍了Java的泛型，针对利用继承来实现通用程序设计所产生的问题，泛型提供了更好的解决方案，需要的朋友可以参考一下
2022-04-04
注册中心配置了spring security后客户端启动报错
这篇文章主要为大家介绍了注册中心配置了spring security后客户端启动报错问题解决，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-07-07
Java对象方法的调用执行过程详解
这篇文章主要介绍了Java对象方法的调用执行过程，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-02-02

深入理解spring boot异步调用方式@Async

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具