前言

在日常開發過程中，會遇到一些需求是和主業務邏輯低耦合的，不要求和主業務邏輯同步進行，比如記錄日志信息、發送消息通知電子郵件、生成PDF合同和導出報表等需求，而且，這些需求往往處理起來比較耗時。這個時候就需要開啟新線程處理這些耗時多的業務，為主業務邏輯以最快速度執行完畢保駕護航。

在Spring Boot項目中通過注解開啟異步線程，僅僅需要做兩件事情：① 在啟動類添加注解@EnableAsync，開啟異步調用，②在方法上添加注解@Async("yourThreadPool")，其中，yourThreadPool為自定義線程池，可以使用系統默認線程池。

自定義線程池

在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中各個屬性的含義：

1. corePoolSize：線程池創建時候初始化的線程數；
2. maxPoolSize：線程池最大的線程數，只有在緩沖隊列滿了之后才會申請超過核心線程數的線程；
3. queueCapacity：用來設置緩沖隊列的容量，Set the capacity for the ThreadPoolExecutor's BlockingQueue.
4. keepAliveSeconds：允許線程的空閑時間60秒，當超過了核心線程數外的線程在空閑時間到達之后會被銷毀；
5. threadNamePrefix：線程池名的前綴，用于快速定位當前任務所在的線程池；
6. rejectedExecutionHandler：線程池對拒絕任務的處理策略，這里采用了CallerRunsPolicy；
7. waitForTasksToCompleteOnShutdown：默認值為false，這里賦值true，用來設置線程池關閉的時候等待所有任務都完成再繼續銷毀其他的Bean，這樣這些異步任務的銷毀就會先于其它對象（如數據庫連接池對象）銷毀；
8. 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

https://mp.weixin.qq.com/s?__biz=MzIxNDEyMzE3OQ%3D%3D&mid=2247487853&idx=1&sn=f399a94d70ebe603aa62f789fac945fc&scene=45#wechat_redirect

總結

以上是生活随笔為你收集整理的Spring注解之@Async：Spring Boot实现异步调用的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。