Spring注解之@Async:Spring Boot实现异步调用
前言
在日常開發(fā)過(guò)程中,會(huì)遇到一些需求是和主業(yè)務(wù)邏輯低耦合的,不要求和主業(yè)務(wù)邏輯同步進(jìn)行,比如記錄日志信息、發(fā)送消息通知電子郵件、生成PDF合同和導(dǎo)出報(bào)表等需求,而且,這些需求往往處理起來(lái)比較耗時(shí)。這個(gè)時(shí)候就需要開啟新線程處理這些耗時(shí)多的業(yè)務(wù),為主業(yè)務(wù)邏輯以最快速度執(zhí)行完畢保駕護(hù)航。
在Spring Boot項(xiàng)目中通過(guò)注解開啟異步線程,僅僅需要做兩件事情:① 在啟動(dòng)類添加注解@EnableAsync,開啟異步調(diào)用,②在方法上添加注解@Async("yourThreadPool"),其中,yourThreadPool為自定義線程池,可以使用系統(tǒng)默認(rèn)線程池。
自定義線程池
在Spring Boot項(xiàng)目中自定義線程池:
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;
}
}
由于這個(gè)配置類中添加了@EnableAsync注解,故在項(xiàng)目啟動(dòng)類中就不必再次添加了。下面枚舉ThreadPoolTaskExecutor中各個(gè)屬性的含義:
- corePoolSize:線程池創(chuàng)建時(shí)候初始化的線程數(shù);
- maxPoolSize:線程池最大的線程數(shù),只有在緩沖隊(duì)列滿了之后才會(huì)申請(qǐng)超過(guò)核心線程數(shù)的線程;
- queueCapacity:用來(lái)設(shè)置緩沖隊(duì)列的容量,Set the capacity for the ThreadPoolExecutor's BlockingQueue.
- keepAliveSeconds:允許線程的空閑時(shí)間60秒,當(dāng)超過(guò)了核心線程數(shù)外的線程在空閑時(shí)間到達(dá)之后會(huì)被銷毀;
- threadNamePrefix:線程池名的前綴,用于快速定位當(dāng)前任務(wù)所在的線程池;
- rejectedExecutionHandler:線程池對(duì)拒絕任務(wù)的處理策略,這里采用了CallerRunsPolicy;
- waitForTasksToCompleteOnShutdown:默認(rèn)值為false,這里賦值true,用來(lái)設(shè)置線程池關(guān)閉的時(shí)候等待所有任務(wù)都完成再繼續(xù)銷毀其他的Bean,這樣這些異步任務(wù)的銷毀就會(huì)先于其它對(duì)象(如數(shù)據(jù)庫(kù)連接池對(duì)象)銷毀;
- awaitTerminationSeconds:設(shè)置線程池中任務(wù)的等待時(shí)間,如果超過(guò)這個(gè)時(shí)間還沒(méi)有銷毀就強(qiáng)制銷毀,以確保應(yīng)用最后能夠被關(guān)閉,而不被阻塞。
實(shí)踐
在未自定義線程池的時(shí)候,Spring Boot默認(rèn)使用SimpleAsyncTaskExecutor這個(gè)線程池,但此線程池不是真正意義上的線程池,因?yàn)榫€程不重用,每次調(diào)用都會(huì)創(chuàng)建一個(gè)新的線程。下面通過(guò)自定義線程池演示如何使用異步注解調(diào)用hello函數(shù)。示例代碼:
@GetMapping("/testSync")
public String testSync() {
userService.hello();
String date = LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
logger.info("testSync 方法繼續(xù)執(zhí)行,當(dāng)前時(shí)間:{}", date);
return "執(zhí)行結(jié)束";
}
在userService及其實(shí)現(xiàn)類添加函數(shù)hello(),并且使用自定義線程池執(zhí)行異步任務(wù):
@Async ("east7TaskExecutor")
@Override
public void hello() {
try {
logger.info("同學(xué)們,課間休息時(shí)間到了");
Thread.sleep(3000);
String date = LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
logger.info("休息結(jié)束,繼續(xù)上課,當(dāng)前時(shí)間:{}", date);
} catch (InterruptedException e) {
logger.error("執(zhí)行失敗", e);
}
}
啟動(dòng)項(xiàng)目,請(qǐng)求testSync(),在控制臺(tái)可以看到如下執(zhí)行結(jié)果,說(shuō)明添加異步執(zhí)行功能成功。
testSync 方法繼續(xù)執(zhí)行,當(dāng)前時(shí)間:2020-07-17 16:22:19
同學(xué)們,課間休息時(shí)間到了
休息結(jié)束,繼續(xù)上課,當(dāng)前時(shí)間:2020-07-17 16:22:22
在控制臺(tái)中可以找到包含關(guān)鍵字east7Task的如下類似日志,說(shuō)明執(zhí)行任務(wù)時(shí)使用了自定義的線程池。
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
總結(jié)
以上是生活随笔為你收集整理的Spring注解之@Async:Spring Boot实现异步调用的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: 携程黄金会员有什么用
- 下一篇: 在银行贷款十万一年要多少利息