首页 > 编程语言 > SpringBoot用@Async注解实现异步任务
2020
12-29

SpringBoot用@Async注解实现异步任务

什么是异步调用？

异步调用是相对于同步调用而言的，同步调用是指程序按预定顺序一步步执行，每一步必须等到上一步执行完后才能执行，异步调用则无需等待上一步程序执行完即可执行。

如何实现异步调用？

多线程，这是很多人第一眼想到的关键词，没错，多线程就是一种实现异步调用的方式。

在非spring目项目中我们要实现异步调用的就是使用多线程方式，可以自己实现Runable接口或者集成Thread类，或者使用jdk1.5以上提供了的Executors线程池。

StrngBoot中则提供了很方便的方式执行异步调用。

异步接口的使用场景

耗时比较长，任务比较多的接口。比方说，文件下载，大文件下载比较耗时，这个时候就可以使用异步接口。

项目示例已上传至GitHub，可见github项目地址。

   在解释异步调用之前，我们先来看同步调用的定义；同步就是整个处理过程顺序执行，当各个过程都执行完毕，并返回结果。 异步调用则是只是发送了调用的指令，调用者无需等待被调用的方法完全执行完毕；而是继续执行下面的流程。

   例如， 在某个调用中，需要顺序调用 A, B, C三个过程方法；如他们都是同步调用，则需要将他们都顺序执行完毕之后，方算作过程执行完毕； 如B为一个异步的调用方法，则在执行完A之后，调用B，并不等待B完成，而是执行开始调用C，待C执行完毕之后，就意味着这个过程执行完毕了。

@Async介绍

基于@Async标注的方法称为异步方法，方法在执行的时候，将会在独立的线程中被执行，调用者无需等待它的完成，即可继续其他的操作。使用时在SpringBoot主配置类中开启异步即可。

@EnableAsync
@SpringBootApplication
public class SpringBootAsyncTestApplication {

无返回值异步方法

@Async
public void asyncMethodWithNoReturnType() {
  try {
    Thread.sleep(3000);
  } catch (InterruptedException e) {
    e.printStackTrace();
  }
  System.out.println("asyncMethodWithNoReturnType...");
}

使用方法比较简单，编写一个测试方法并加上@Async注解即可。

含返回值异步方法

@Async
public Future<String> asyncMethodWithReturnType() {
  try {
  		Thread.sleep(3000);
  		return new AsyncResult<String>("success");
  } catch (InterruptedException e) {
  		e.printStackTrace();
  }
  System.out.println("asyncMethodWithReturnType...");
  return null;
}

返回值利用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;
}

1.cancel方法的作用是取消任务，取消任务成功则返回true，反之返回false。参数 mayInterruptIfRunning 表示是否允许取消正在执行却没有执行完毕的任务。

运行cancel方法取消任务时：

i.若任务已完成：则无论 mayInterruptIfRunning 为 true 或 false，此方法都返回 false，即取消已经完成的任务都会返回false。

i.若任务正在执行：

  •  mayInterruptIfRunning 设置为 true，则返回true。
  • mayInterruptIfRunning 设置为false，则返回false。

iii.如果任务未执行，则无论mayInterruptIfRunning为true还是false，都返回true。

2.isCancelled方法的作用是判断任务是否被取消成功，若在任务正常完成前被取消，则返回 true。

3.isDone方法的作用是判断任务是否已经完成，若任务已完成，则返回true。

4.get()方法的作用是获取执行结果，注意此方法会产生阻塞，等到任务执行完毕后才能获得执行结果。

5.get(long timeout, TimeUnit unit)方法的作用同样是获取执行结果，若在指定时间内还未获取到执行结果，则返回null。

编写测试接口

编写/callWithNoReturnType和/callWithReturnType接口用于查看异步任务的执行过程。

@RestController
public class AsyncController {
  @Autowired
  AsyncService asynSerivce;

  @GetMapping("/callWithNoReturnType")
  public String callWithNoReturnType() {
    asynSerivce.asyncMethodWithNoReturnType();
    return "success";
  }

  @GetMapping("/callWithReturnType")
  public String callWithReturnType() {
    Future<String> future=asynSerivce.asyncMethodWithReturnType();
    try {
      return future.get();
    } catch (InterruptedException e) {
      e.printStackTrace();
    } catch (ExecutionException e) {
      e.printStackTrace();
    }
    return "fail";
  }

运行项目后使用Postman进行接口测试，分别给/callWithNoReturnType和/callWithReturnType接口发送Get请求，调用无返回值的异步方法asyncWithNoReturnType时，会立即返回返回值。但调用含返回值异步方法asyncWithReturnType时，由于我们调用了get()方法，会在等待3000毫秒后，才返回返回值。

到此这篇关于SpringBoot用@Async注解实现异步任务的文章就介绍到这了,更多相关SpringBoot @Async异步内容请搜索自学编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持自学编程网！

编程技巧