Spring Boot异步调用@Async过程详解

 更新时间:2019年11月07日 11:12:57   作者:杨小格子  
这篇文章主要介绍了Spring Boot异步调用@Async过程详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下

在实际开发中,有时候为了及时处理请求和进行响应,我们可能会多任务同时执行,或者先处理主任务,也就是异步调用,异步调用的实现有很多,例如多线程、定时任务、消息队列等,

我们来讲讲@Async异步方法调用。

一、@Async使用演示

@Async是Spring内置注解,用来处理异步任务,在SpringBoot中同样适用,且在SpringBoot项目中,除了boot本身的starter外,不需要额外引入依赖。

而要使用@Async,需要在启动类上加上@EnableAsync主动声明来开启异步方法。

@EnableAsync
@SpringBootApplication
public class SpringbootApplication {

  public static void main(String[] args) {
    SpringApplication.run(SpringbootApplication.class, args);
  }
}

现假设有3个任务需要去处理,分别对应AsyncTask类的taskOne、taskTwo、taskThree方法,这里做了线程的sleep来模拟实际运行。

@Slf4j
@Component
public class AsyncTask {

  private Random random = new Random();
  
  public void taskOne() throws InterruptedException {
    long start = System.currentTimeMillis();
    Thread.sleep(random.nextInt(10000));
    long end = System.currentTimeMillis();
    log.info("任务一执行完成耗时{}秒", (end - start)/1000f);
  }
  
  public void taskTwo() throws InterruptedException {
    long start = System.currentTimeMillis();
    Thread.sleep(random.nextInt(10000));
    long end = System.currentTimeMillis();
    log.info("任务二执行完成耗时{}秒", (end - start)/1000f);
  }
  
  public void taskThree() throws InterruptedException {
    long start = System.currentTimeMillis();
    Thread.sleep(random.nextInt(10000));
    long end = System.currentTimeMillis();
    log.info("任务三执行完成耗时{}秒", (end - start)/1000f);
  }
}

然后编写测试类,由于@Async注解需要再Spring容器启动后才能生效,所以这里讲测试类放到了SpringBoot的test包下,使用了SpringBootTest。

@Slf4j
@RunWith(SpringRunner.class)
@SpringBootTest(classes = SpringbootApplication.class)
public class AsyncTaskTest {

  @Autowired
  private AsyncTask asyncTask;

  @Test
  public void doAsyncTasks(){
    try {
      long start = System.currentTimeMillis();
      asyncTask.taskOne();
      asyncTask.taskTwo();
      asyncTask.taskThree();
      Thread.sleep(5000);
      long end = System.currentTimeMillis();
      log.info("主程序执行完成耗时{}秒", (end - start)/1000f);
    } catch (InterruptedException e) {
      e.printStackTrace();
    }
  }

}

运行测试方法,可以在控制台看到任务一二三按顺序执行,最后主程序完成,这和我们的预期一样,因为我们没有任何额外的处理,他们就是普通的方法,按编码顺序依次执行。

而如果要使任务并发执行,我们只需要在任务方法上使用@Async注解即可,需要注意的是@Async所修饰的方法不要定义为static类型,这样异步调用不会生效。

@Slf4j
@Component
public class AsyncTask {

  private Random random = new Random();

  //@Async所修饰的函数不要定义为static类型,这样异步调用不会生效
  @Async
  public void taskOne() throws InterruptedException {
    long start = System.currentTimeMillis();
    Thread.sleep(random.nextInt(10000));
    long end = System.currentTimeMillis();
    log.info("任务一执行完成耗时{}秒", (end - start)/1000f);
  }

  @Async
  public void taskTwo() throws InterruptedException {
    long start = System.currentTimeMillis();
    Thread.sleep(random.nextInt(10000));
    long end = System.currentTimeMillis();
    log.info("任务二执行完成耗时{}秒", (end - start)/1000f);
  }

  @Async
  public void taskThree() throws InterruptedException {
    long start = System.currentTimeMillis();
    Thread.sleep(random.nextInt(10000));
    long end = System.currentTimeMillis();
    log.info("任务三执行完成耗时{}秒", (end - start)/1000f);
  }

}

然后我们在运行测试类,这个时候输出可能就五花八门了,任意任务都可能先执行完成,也有可能有的方法因为主程序关闭而没有输出。

二、Future获取异步执行结果

上面演示了@Async,但是有时候除了需要任务并发调度外,我们还需要获取任务的返回值,且在多任务都执行完成后再结束主任务,这个时候又该怎么处理呢?

在多线程里通过Callable和Future可以获取返回值,这里也是类似的,我们使用Future返回方法的执行结果,AsyncResult是Future的一个实现类。

@Slf4j
@Component
public class FutureTask {

  private Random random = new Random();

  //@Async所修饰的函数不要定义为static类型,这样异步调用不会生效
  @Async
  public Future<String> taskOne() throws InterruptedException {
    long start = System.currentTimeMillis();
    Thread.sleep(random.nextInt(10000));
    long end = System.currentTimeMillis();
    log.info("任务一执行完成耗时{}秒", (end - start)/1000f);
    return new AsyncResult <>("任务一Ok");
  }

  @Async
  public Future<String> taskTwo() throws InterruptedException {
    long start = System.currentTimeMillis();
    Thread.sleep(random.nextInt(10000));
    long end = System.currentTimeMillis();
    log.info("任务二执行完成耗时{}秒", (end - start)/1000f);
    return new AsyncResult <>("任务二OK");
  }

  @Async
  public Future<String> taskThree() throws InterruptedException {
    long start = System.currentTimeMillis();
    Thread.sleep(random.nextInt(10000));
    long end = System.currentTimeMillis();
    log.info("任务三执行完成耗时{}秒", (end - start)/1000f);
    return new AsyncResult <>("任务三Ok");
  }
}

在AsyncResult中:

  • isDone()方法可以用于判断异步方法是否执行完成,若任务完成,则返回true
  • get()方法可用于获取任务执行后返回的结果
  • cancel(boolean mayInterruptIfRunning)可用于取消任务,参数mayInterruptIfRunning表示是否允许取消正在执行却没有执行完毕的任务,如果设置true,则表示可以取消正在执行过程中的任务
  • isCancelled()方法表示任务是否被取消成功,如果在任务正常完成前被取消成功,则返回 true
  • get(long timeout, TimeUnit unit)用来获取执行结果,如果在指定时间内,还没获取到结果,就直接返回null
@Slf4j
@RunWith(SpringRunner.class)
@SpringBootTest(classes = SpringbootApplication.class)
public class AsyncTaskTest {

  @Autowired
  private FutureTask futureTask;

  @Test
  public void doFutureTasks(){
    try {
      long start = System.currentTimeMillis();
      Future <String> future1 = futureTask.taskOne();
      Future <String> future2 = futureTask.taskTwo();
      Future <String> future3 = futureTask.taskThree();
      //3个任务执行完成之后再执行主程序
      do {
        Thread.sleep(100);
      } while (future1.isDone() && future2.isDone() && future3.isDone());
      log.info("获取异步方法的返回值:{}", future1.get());
      Thread.sleep(5000);
      long end = System.currentTimeMillis();
      log.info("主程序执行完成耗时{}秒", (end - start)/1000f);
    } catch (InterruptedException e) {
      e.printStackTrace();
    } catch (ExecutionException e) {
      e.printStackTrace();
    }
  }
}

运行测试类,我们可以看到任务一二三异步执行了,主任务最后执行完成,而且可以获取到任务的返回信息。

源码地址:https://github.com/imyanger/springboot-project/tree/master/p23-springboot-async

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • 一文搞懂 MyBatis的事务管理机制

    一文搞懂 MyBatis的事务管理机制

    MyBatis是一款优秀的持久层框架,相信很多Java后端开发人员对它都不会陌生。本文将从事务概述、MyBatis实现事务的方式、事务实现源码分析方面详细解析MyBatis的事务管理机制,需要的朋友可以参考下
    2023-05-05
  • Spring工作原理简单探索

    Spring工作原理简单探索

    这篇文章主要介绍了Spring工作原理简单探索,涉及Springaop与IOC,动态代理静态代理,反射等相关内容,具有一定参考价值,需要的朋友可以了解下。
    2017-11-11
  • Spring Boot优雅地处理404异常问题

    Spring Boot优雅地处理404异常问题

    这篇文章主要介绍了Spring Boot优雅地处理404异常问题,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-11-11
  • 浅谈Java中向上造型向下造型和接口回调中的问题

    浅谈Java中向上造型向下造型和接口回调中的问题

    这篇文章主要介绍了浅谈Java中向上造型向下造型和接口回调中的问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-08-08
  • Java日常练习题,每天进步一点点(61)

    Java日常练习题,每天进步一点点(61)

    下面小编就为大家带来一篇Java基础的几道练习题(分享)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧,希望可以帮到你
    2021-08-08
  • JAVA中Collections工具类sort()排序方法

    JAVA中Collections工具类sort()排序方法

    这篇文章主要介绍了JAVA中Collections工具类sort()排序方法,非常具有实用价值,需要的朋友可以参考下。
    2016-11-11
  • Springboot中的@ComponentScan注解使用解析

    Springboot中的@ComponentScan注解使用解析

    这篇文章主要介绍了Springboot中的@ComponentScan注解使用解析,@ComponentScan用于类或接口上主要是指定扫描路径,spring会把指定路径下带有指定注解的类注册到IOC容器中,需要的朋友可以参考下
    2024-01-01
  • java开发建造者模式验证实例详解

    java开发建造者模式验证实例详解

    这篇文章主要为大家介绍了java开发中建造者模式的验证实例详解,文中附含详细示例代码,有需要的朋友可以借鉴参考下,希望能够有所帮助
    2021-10-10
  • Java计时器StopWatch实现方法代码实例

    Java计时器StopWatch实现方法代码实例

    这篇文章主要介绍了Java计时器StopWatch实现方法代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-07-07
  • Java事件监听机制讲解

    Java事件监听机制讲解

    今天小编就为大家分享一篇关于Java事件监听机制讲解,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-02-02

最新评论