前言
在日常开发过程中，会遇到一些需求是和主业务逻辑低耦合的，不要求和主业务逻辑同步进行，比如记录日志信息、发送消息通知电子邮件、生成PDF合同和导出报表等需求，而且，这些需求往往处理起来比较耗时。这个时候就需要开启一个新线程去处理这些耗时多的业务，让主线程异步的执行其他业务。
在Spring Boot项目中通过注解开启异步线程，仅仅需要做两件事情：① 在启动类添加注解@EnableAsync，开启异步调用，②在方法上添加注解@Async("threadPool")，其中，threadPool为自定义线程池，可以使用系统默认线程池。
自定义线程池
在Spring Boot项目中自定义线程池：
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
import java.util.concurrent.Executor;
import java.util.concurrent.ThreadPoolExecutor;
/**
* 自定义线程池
*
* @author Wiener
* @date 2020/7/17 16:44
*/
@EnableAsync
@Configuration
public class TaskPoolConfig {
@Bean("east7TaskExecutor")
public Executor taskExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
executor.setCorePoolSize(10);
executor.setMaxPoolSize(20);
executor.setQueueCapacity(200);
executor.setKeepAliveSeconds(60);
executor.setThreadNamePrefix("east7Task-");
executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
executor.setWaitForTasksToCompleteOnShutdown(true);
executor.setAwaitTerminationSeconds(60);
return executor;
}
}
由于这个配置类中添加了@EnableAsync注解，故在项目启动类中就不必再次添加了。下面枚举ThreadPoolTaskExecutor中各个属性的含义：
- corePoolSize：线程池创建时候初始化的线程数；
- maxPoolSize：线程池最大的线程数，只有在缓冲队列满了之后才会申请超过核心线程数的线程；
- queueCapacity：用来设置缓冲队列的容量，Set the capacity for the ThreadPoolExecutor's BlockingQueue.
- keepAliveSeconds：允许线程的空闲时间60秒，当超过了核心线程数外的线程在空闲时间到达之后会被销毁；
- threadNamePrefix：线程池名的前缀，用于快速定位当前任务所在的线程池；
- rejectedExecutionHandler：线程池对拒绝任务的处理策略，这里采用了CallerRunsPolicy；
- waitForTasksToCompleteOnShutdown：默认值为false，这里赋值true，用来设置线程池关闭的时候等待所有任务都完成再继续销毁其他的Bean，这样这些异步任务的销毁就会先于其它对象（如数据库连接池对象）销毁；
- awaitTerminationSeconds：设置线程池中任务的等待时间，如果超过这个时间还没有销毁就强制销毁，以确保应用最后能够被关闭，而不被阻塞。
实践
在未自定义线程池的时候，Spring Boot默认使用SimpleAsyncTaskExecutor这个线程池，但此线程池不是真正意义上的线程池，因为线程不重用，每次调用都会创建一个新的线程。下面通过自定义线程池演示如何使用异步注解调用hello函数。示例代码：
@GetMapping("/testSync")
public String testSync() {
userService.hello();
String date = LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
logger.info("testSync 方法继续执行，当前时间：{}", date);
return "执行结束";
}
在userService及其实现类添加函数hello()，并且使用自定义线程池执行异步任务：
@Async ("east7TaskExecutor")
@Override
public void hello() {
try {
logger.info("同学们，课间休息时间到了");
Thread.sleep(3000);
String date = LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
logger.info("休息结束，继续上课，当前时间：{}", date);
} catch (InterruptedException e) {
logger.error("执行失败", e);
}
}
启动项目，请求testSync()，在控制台可以看到如下执行结果，说明添加异步执行功能成功。
testSync 方法继续执行，当前时间：2020-07-17 16:22:19
同学们，课间休息时间到了
休息结束，继续上课，当前时间：2020-07-17 16:22:22
在控制台中可以找到包含关键字east7Task的如下类似日志，说明执行任务时使用了自定义的线程池。
INFO 9904 --- [east7Task-2]
Reference