代码参见：https://github.com/hswsp/spring-framework-tutorial

通常我们开发的程序都是同步调用的，即程序按照代码的顺序一行一行的逐步往下执行，每一行代码都必须等待上一行代码执行完毕才能开始执行。而异步编程则没有这个限制，代码的调用不再是阻塞的。所以在一些情景下，通过异步编程可以提高效率，提升接口的吞吐量。这节将介绍如何在Spring Boot中进行异步编程。

开启异步

新建一个Spring Boot项目，版本为2.1.0.RELEASE，并引入spring-boot-starter-web依赖，项目结构如下所示：

Spring Boot 中的异步调用 - 图1

要开启异步支持，首先得在Spring Boot入口类上加上@EnableAsync注解：

  1. @SpringBootApplication
  2. @EnableAsync
  3. public class DemoApplication {
  4.     public static void main(String[] args) {
  5.         SpringApplication.run(DemoApplication.class, args);
  6.     }
  7. }

接下来开始编写异步方法。

在com.example.demo路径下新建service包，并创建TestService：

  1. @Service
  2. public class TestService {
  4.     private Logger logger = LoggerFactory.getLogger(this.getClass());
  6.     @Async
  7.     public void asyncMethod() {
  8.         sleep();
  9.         logger.info("异步方法内部线程名称：{}", Thread.currentThread().getName());
  10.     }
  12.     public void syncMethod() {
  13.         sleep();
  14.     }
  16.     private void sleep() {
  17.         try {
  18.             TimeUnit.SECONDS.sleep(2);
  19.         } catch (InterruptedException e) {
  20.             e.printStackTrace();
  21.         }
  22.     }
  23. }

上面的Service中包含一个异步方法asyncMethod（开启异步支持后，只需要在方法上加上@Async注解便是异步方法了）和同步方法syncMethod。sleep方法用于让当前线程阻塞2秒钟。

接着在com.example.demo路径下新建controller包，然后创建TestController：

  1. @RestController
  2. public class TestController {
  4.     private Logger logger = LoggerFactory.getLogger(this.getClass());
  6.     @Autowired
  7.     private TestService testService;
  9.     @GetMapping("async")
  10.     public void testAsync() {
  11.         long start = System.currentTimeMillis();
  12.         logger.info("异步方法开始");
  14.         testService.asyncMethod();
  16.         logger.info("异步方法结束");
  17.         long end = System.currentTimeMillis();
  18.         logger.info("总耗时：{} ms", end - start);
  19.     }
  21.     @GetMapping("sync")
  22.     public void testSync() {
  23.         long start = System.currentTimeMillis();
  24.         logger.info("同步方法开始");
  26.         testService.syncMethod();
  28.         logger.info("同步方法结束");
  29.         long end = System.currentTimeMillis();
  30.         logger.info("总耗时：{} ms", end - start);
  31.     }
  32. }

启动项目，访问 http://localhost:8080/sync 请求，控制台输出如下：

Spring Boot 中的异步调用 - 图2

可看到默认程序是同步的，由于sleep方法阻塞的原因，testSync方法执行了2秒钟以上。

访问 http://localhost:8080/async ，控制台输出如下：

Spring Boot 中的异步调用 - 图3

可看到testAsync方法耗时极少，因为异步的原因，程序并没有被sleep方法阻塞，这就是异步调用的好处。同时异步方法内部会新启一个线程来执行，这里线程名称为task - 1。

默认情况下的异步线程池配置使得线程不能被重用，每次调用异步方法都会新建一个线程，我们可以自己定义异步线程池来优化。

自定义异步线程池

在com.example.demo下新建config包，然后创建AsyncPoolConfig配置类：

  1. @Configuration
  2. public class AsyncPoolConfig {
  4.     @Bean
  5.     public ThreadPoolTaskExecutor asyncThreadPoolTaskExecutor(){
  6.         ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
  7.         executor.setCorePoolSize(20);
  8.         executor.setMaxPoolSize(200);
  9.         executor.setQueueCapacity(25);
  10.         executor.setKeepAliveSeconds(200);
  11.         executor.setThreadNamePrefix("asyncThread");
  12.         executor.setWaitForTasksToCompleteOnShutdown(true);
  13.         executor.setAwaitTerminationSeconds(60);
  15.         executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
  17.         executor.initialize();
  18.         return executor;
  19.     }
  20. }

上面我们通过ThreadPoolTaskExecutor的一些方法自定义了一个线程池，这些方法的含义如下所示：

  • corePoolSize：线程池核心线程的数量，默认值为1（这就是默认情况下的异步线程池配置使得线程不能被重用的原因）。
  • maxPoolSize：线程池维护的线程的最大数量，只有当核心线程都被用完并且缓冲队列满后，才会开始申超过请核心线程数的线程，默认值为Integer.MAX_VALUE。
  • queueCapacity：缓冲队列。
  • keepAliveSeconds：超出核心线程数外的线程在空闲时候的最大存活时间，默认为60秒。
  • threadNamePrefix：线程名前缀。
  • waitForTasksToCompleteOnShutdown：是否等待所有线程执行完毕才关闭线程池，默认值为false。
  • awaitTerminationSeconds：waitForTasksToCompleteOnShutdown的等待的时长，默认值为0，即不等待。
  • rejectedExecutionHandler：当没有线程可以被使用时的处理策略（拒绝任务），默认策略为abortPolicy，包含下面四种策略：
    Spring Boot 中的异步调用 - 图4
    1. callerRunsPolicy：用于被拒绝任务的处理程序，它直接在 execute 方法的调用线程中运行被拒绝的任务；如果执行程序已关闭，则会丢弃该任务。
    2. abortPolicy：直接抛出java.util.concurrent.RejectedExecutionException异常。
    3. discardOldestPolicy：当线程池中的数量等于最大线程数时、抛弃线程池中最后一个要执行的任务，并执行新传入的任务。
    4. discardPolicy：当线程池中的数量等于最大线程数时，不做任何动作。

要使用该线程池，只需要在@Async注解上指定线程池Bean名称即可：

  1. @Service
  2. public class TestService {
  3.     ......
  5.     @Async("asyncThreadPoolTaskExecutor")
  6.     public void asyncMethod() {
  7.        ......
  8.     }
  9.     ......
  10. }

重启项目，再次访问 http://localhost:8080/async ，控制台输出入下：

Spring Boot 中的异步调用 - 图5

处理异步回调

如果异步方法具有返回值的话，需要使用Future来接收回调值。我们修改TestService的asyncMethod方法，给其添加返回值：

  1. @Async("asyncThreadPoolTaskExecutor")
  2. public Future<String> asyncMethod() {
  3.     sleep();
  4.     logger.info("异步方法内部线程名称：{}", Thread.currentThread().getName());
  5.     return new AsyncResult<>("hello async");
  6. }

泛型指定返回值的类型，AsyncResult为Spring实现的Future实现类：

Spring Boot 中的异步调用 - 图6

接着改造TestController的testAsync方法：

  1. @GetMapping("async")
  2. public String testAsync() throws Exception {
  3.     long start = System.currentTimeMillis();
  4.     logger.info("异步方法开始");
  6.     Future<String> stringFuture = testService.asyncMethod();
  7.     String result = stringFuture.get();
  8.     logger.info("异步方法返回值：{}", result);
  10.     logger.info("异步方法结束");
  12.     long end = System.currentTimeMillis();
  13.     logger.info("总耗时：{} ms", end - start);
  14.     return stringFuture.get();
  15. }

Future接口的get方法用于获取异步调用的返回值。

重启项目，访问 http://localhost:8080/async 控制台输出如下所示:

Spring Boot 中的异步调用 - 图7

通过返回结果我们可以看出Future的get方法为阻塞方法，只有当异步方法返回内容了，程序才会继续往下执行。get还有一个get(long timeout, TimeUnit unit)重载方法，我们可以通过这个重载方法设置超时时间，即异步方法在设定时间内没有返回值的话，直接抛出java.util.concurrent.TimeoutException异常。

比如设置超时时间为60秒：

  1. String result = stringFuture.get(60, TimeUnit.SECONDS);