欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Spring Boot利用@Async异步调用:使用Future及定义超时详解

程序员文章站 2023-12-14 15:43:34
前言 之前连续写了几篇关于使用@async实现异步调用的内容,也得到不少童鞋的反馈,其中问题比较多的就是关于返回future的使用方法以及对异步执行的超时控制,所以这篇就...

前言

之前连续写了几篇关于使用@async实现异步调用的内容,也得到不少童鞋的反馈,其中问题比较多的就是关于返回future的使用方法以及对异步执行的超时控制,所以这篇就来一起讲讲这两个问题的处理。

如果您对于@async注解的使用还不了解的话,可以看看之前的文章,具体如下:

定义异步任务

首先,我们先使用@async注解来定义一个异步任务,这个方法返回future类型,具体如下:

@slf4j
@component
public class task {
 public static random random = new random();
 @async("taskexecutor")
 public future<string> run() throws exception {
  long sleep = random.nextint(10000);
  log.info("开始任务,需耗时:" + sleep + "毫秒");
  thread.sleep(sleep);
  log.info("完成任务");
  return new asyncresult<>("test");
 }
}

tips:什么是future类型?

future是对于具体的runnable或者callable任务的执行结果进行取消、查询是否完成、获取结果的接口。必要时可以通过get方法获取执行结果,该方法会阻塞直到任务返回结果。

它的接口定义如下:

public interface future<v> {
 boolean cancel(boolean mayinterruptifrunning);
 boolean iscancelled();
 boolean isdone();
 v get() throws interruptedexception, executionexception;
 v get(long timeout, timeunit unit)
  throws interruptedexception, executionexception, timeoutexception;
}

它声明这样的五个方法:

  • cancel方法用来取消任务,如果取消任务成功则返回true,如果取消任务失败则返回false。参数mayinterruptifrunning表示是否允许取消正在执行却没有执行完毕的任务,如果设置true,则表示可以取消正在执行过程中的任务。如果任务已经完成,则无论mayinterruptifrunning为true还是false,此方法肯定返回false,即如果取消已经完成的任务会返回false;如果任务正在执行,若mayinterruptifrunning设置为true,则返回true,若mayinterruptifrunning设置为false,则返回false;如果任务还没有执行,则无论mayinterruptifrunning为true还是false,肯定返回true。
  • iscancelled方法表示任务是否被取消成功,如果在任务正常完成前被取消成功,则返回 true。
  • isdone方法表示任务是否已经完成,若任务完成,则返回true;
  • get()方法用来获取执行结果,这个方法会产生阻塞,会一直等到任务执行完毕才返回;
  • get(long timeout, timeunit unit)用来获取执行结果,如果在指定时间内,还没获取到结果,就直接返回null。

也就是说future提供了三种功能:

  1. 判断任务是否完成;
  2. 能够中断任务;
  3. 能够获取任务执行结果。

测试执行与定义超时

在完成了返回future的异步任务定义之后,我们来尝试实现一个单元测试来使用这个future完成任务的执行,比如:

@slf4j
@runwith(springjunit4classrunner.class)
@springboottest
public class applicationtests {
 @autowired
 private task task;
 @test
 public void test() throws exception {
  future<string> futureresult = task.run();
  string result = futureresult.get(5, timeunit.seconds);
  log.info(result);
 }
}

上面的代码中,我们在get方法中还定义了该线程执行的超时时间,通过执行这个测试我们可以观察到执行时间超过5秒的时候,这里会抛出超时异常,该执行线程就能够因执行超时而释放回线程池,不至于一直阻塞而占用资源。

完整示例:

读者可以根据喜好选择下面的两个仓库中查看chapter4-1-4项目:

github:https://github.com/dyc87112/springboot-learning/

gitee:https://gitee.com/didispace/springboot-learning/

本地下载:http://xiazai.jb51.net/201805/yuanma/springboot-learning(jb51.net).rar

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对的支持。

上一篇:

下一篇: