Spring boot注解@Async線程池實例詳解
這篇文章主要介紹了Spring boot注解@Async線程池實例詳解,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下
從Spring3開始提供了@Async注解,該注解可以被標注在方法上,以便異步地調(diào)用該方法。調(diào)用者將在調(diào)用時立即返回,方法的實際執(zhí)行將提交給Spring TaskExecutor的任務(wù)中,由指定的線程池中的線程執(zhí)行。
1. TaskExecutor
Spring異步線程池的接口類,其實質(zhì)是java.util.concurrent.Executor
Spring 已經(jīng)實現(xiàn)的異常線程池:
1. SimpleAsyncTaskExecutor:不是真的線程池,這個類不重用線程,每次調(diào)用都會創(chuàng)建一個新的線程。
2. SyncTaskExecutor:這個類沒有實現(xiàn)異步調(diào)用,只是一個同步操作。只適用于不需要多線程的地方
3. ConcurrentTaskExecutor:Executor的適配類,不推薦使用。如果ThreadPoolTaskExecutor不滿足要求時,才用考慮使用這
個類
4. SimpleThreadPoolTaskExecutor:是Quartz的SimpleThreadPool的類。線程池同時被quartz和非quartz使用,才需要使用此類
5. ThreadPoolTaskExecutor :最常使用,推薦。 其實質(zhì)是對java.util.concurrent.ThreadPoolExecutor的包裝
2. @EnableAsync @Async
(1) springboot的啟動類,@EnableAsync注解開啟異步調(diào)用
(2) spring對@Async定義異步任務(wù)
異步的方法有3種
1. 最簡單的異步調(diào)用,返回值為void, 基于@Async無返回值調(diào)用,直接在使用類,使用方法(建議在使用方法)上,加上注解。若需要拋出異常,需手動new一個異常拋出。
2. 帶參數(shù)的異步調(diào)用 異步方法可以傳入?yún)?shù)
3. 異常調(diào)用返回Future,不會被AsyncUncaughtExceptionHandler處理,需要我們在方法中捕獲異常并處理或者在調(diào)用方在調(diào)用Futrue.get時捕獲異常進行處理
3. @Async應(yīng)用默認線程池
spring應(yīng)用默認的線程池,指在@Async注解在使用時,不指定線程池的名稱。查看源碼,@Async的默認線程池為SimpleAsyncTaskExecutor。
默認線程池的弊端
在線程池應(yīng)用中,參考阿里巴巴java開發(fā)規(guī)范:線程池不允許使用Executors去創(chuàng)建,不允許使用系統(tǒng)默認的線程池,推薦通過ThreadPoolExecutor的方式,這樣的處理方式讓開發(fā)的工程師更加明確線程池的運行規(guī)則,規(guī)避資源耗盡的風險。Executors各個方法的弊端:
newFixedThreadPool和newSingleThreadExecutor:主要問題是堆積的請求處理隊列可能會耗費非常大的內(nèi)存,甚至OOM。
newCachedThreadPool和newScheduledThreadPool:要問題是線程數(shù)最大數(shù)是Integer.MAX_VALUE,可能會創(chuàng)建數(shù)量非常多的線程,甚至OOM。
@Async默認異步配置使用的是SimpleAsyncTaskExecutor,該線程池默認來一個任務(wù)創(chuàng)建一個線程,若系統(tǒng)中不斷的創(chuàng)建線程,最終會導(dǎo)致系統(tǒng)占用內(nèi)存過高,引發(fā)OutOfMemoryError錯誤。針對線程創(chuàng)建問題,SimpleAsyncTaskExecutor提供了限流機制,通過concurrencyLimit屬性來控制開關(guān),當concurrencyLimit>=0時開啟限流機制,默認關(guān)閉限流機制即concurrencyLimit=-1,當關(guān)閉情況下,會不斷創(chuàng)建新的線程來處理任務(wù)?;谀J配置,SimpleAsyncTaskExecutor并不是嚴格意義的線程池,達不到線程復(fù)用的功能。
4. @Async應(yīng)用自定義線程池
自定義線程池,可對系統(tǒng)中線程池更加細粒度的控制,方便調(diào)整線程池大小配置,線程執(zhí)行異??刂坪吞幚?。在設(shè)置系統(tǒng)自定義線程池代替默認線程池時,雖可通過多種模式設(shè)置,但替換默認線程池最終產(chǎn)生的線程池有且只能設(shè)置一個(不能設(shè)置多個類繼承AsyncConfigurer)。自定義線程池有如下模式:
- 重新實現(xiàn)接口AsyncConfigurer
- 繼承AsyncConfigurerSupport
- 配置由自定義的TaskExecutor替代內(nèi)置的任務(wù)執(zhí)行器
通過查看Spring源碼關(guān)于@Async的默認調(diào)用規(guī)則,會優(yōu)先查詢源碼中實現(xiàn)AsyncConfigurer這個接口的類,實現(xiàn)這個接口的類為AsyncConfigurerSupport。但默認配置的線程池和異步處理方法均為空,所以,無論是繼承或者重新實現(xiàn)接口,都需指定一個線程池。且重新實現(xiàn) public Executor getAsyncExecutor()方法。
(1)實現(xiàn)接口AsyncConfigurer
@Configuration
public class AsyncConfiguration implements AsyncConfigurer {
@Bean("kingAsyncExecutor")
public ThreadPoolTaskExecutor executor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
int corePoolSize = 10;
executor.setCorePoolSize(corePoolSize);
int maxPoolSize = 50;
executor.setMaxPoolSize(maxPoolSize);
int queueCapacity = 10;
executor.setQueueCapacity(queueCapacity);
executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
String threadNamePrefix = "kingDeeAsyncExecutor-";
executor.setThreadNamePrefix(threadNamePrefix);
executor.setWaitForTasksToCompleteOnShutdown(true);
// 使用自定義的跨線程的請求級別線程工廠類
RequestContextThreadFactory threadFactory = RequestContextThreadFactory.getDefault();
executor.setThreadFactory(threadFactory);
int awaitTerminationSeconds = 5;
executor.setAwaitTerminationSeconds(awaitTerminationSeconds);
executor.initialize();
return executor;
}
@Override
public Executor getAsyncExecutor() {
return executor();
}
@Override
public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
return (ex, method, params) -> ErrorLogger.getInstance().log(String.format("執(zhí)行異步任務(wù)'%s'", method), ex);
}
}
(2)繼承AsyncConfigurerSupport
@Configuration
@EnableAsync
class SpringAsyncConfigurer extends AsyncConfigurerSupport {
@Bean
public ThreadPoolTaskExecutor asyncExecutor() {
ThreadPoolTaskExecutor threadPool = new ThreadPoolTaskExecutor();
threadPool.setCorePoolSize(3);
threadPool.setMaxPoolSize(3);
threadPool.setWaitForTasksToCompleteOnShutdown(true);
threadPool.setAwaitTerminationSeconds(60 * 15);
return threadPool;
}
@Override
public Executor getAsyncExecutor() {
return asyncExecutor;
}
@Override
public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
return (ex, method, params) -> ErrorLogger.getInstance().log(String.format("執(zhí)行異步任務(wù)'%s'", method), ex);
}
}
(3)配置自定義的TaskExecutor
由于AsyncConfigurer的默認線程池在源碼中為空,Spring通過beanFactory.getBean(TaskExecutor.class)先查看是否有線程池,未配置時,通過beanFactory.getBean(DEFAULT_TASK_EXECUTOR_BEAN_NAME, Executor.class),又查詢是否存在默認名稱為TaskExecutor的線程池。所以可在項目中,定義名稱為TaskExecutor的bean生成一個默認線程池。也可不指定線程池的名稱,申明一個線程池,本身底層是基于TaskExecutor.class便可。
比如:
Executor.class:ThreadPoolExecutorAdapter->ThreadPoolExecutor->AbstractExecutorService->ExecutorService->Executor(這樣的模式,最終底層為Executor.class,在替換默認的線程池時,需設(shè)置默認的線程池名稱為TaskExecutor)
Executor.class:ThreadPoolTaskExecutor->SchedulingTaskExecutor->AsyncTaskExecutor->TaskExecutor(這樣的模式,最終底層為TaskExecutor.class,在替換默認的線程池時,可不指定線程池名稱。)
package intellif.configs;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.aop.interceptor.AsyncUncaughtExceptionHandler;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.scheduling.annotation.AsyncConfigurer;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
import org.springframework.stereotype.Component;
import java.util.concurrent.Executor;
import java.util.concurrent.ThreadPoolExecutor;
/**
* @author liuyu
* @className TaskConfiguration
* @date 2019/12/17 11:40
* @description
*/
@Component
public class TaskConfiguration implements AsyncConfigurer {
private static Logger logger = LogManager.getLogger(TaskConfiguration.class);
@Value("${thread.pool.corePoolSize:10}")
private int corePoolSize;
@Value("${thread.pool.maxPoolSize:20}")
private int maxPoolSize;
@Value("${thread.pool.keepAliveSeconds:4}")
private int keepAliveSeconds;
@Value("${thread.pool.queueCapacity:512}")
private int queueCapacity;
@Value("${thread.pool.waitForTasksToCompleteOnShutdown:true}")
private boolean waitForTasksToCompleteOnShutdown;
@Value("${thread.pool.awaitTerminationSeconds:60}")
private int awaitTerminationSeconds;
@Override
public Executor getAsyncExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
//核心線程數(shù)
executor.setCorePoolSize(corePoolSize);
//線程池最大的線程數(shù),只有在緩沖隊列滿了之后,才會申請超過核心線程數(shù)的線程
executor.setMaxPoolSize(maxPoolSize);
//允許線程的空閑時間,當超過了核心線程之外的線程,在空閑時間到達之后會被銷毀
executor.setKeepAliveSeconds(keepAliveSeconds);
////用來緩沖執(zhí)行任務(wù)的隊列
executor.setQueueCapacity(queueCapacity);
//線程池名的前綴,可以用于定位處理任務(wù)所在的線程池
executor.setThreadNamePrefix("taskExecutor-");
//線程池對拒絕任務(wù)的處理策略
executor.setRejectedExecutionHandler((Runnable r, ThreadPoolExecutor exe) -> {
logger.warn("當前任務(wù)線程池隊列已滿.");
});
//該方法用來設(shè)置線程池關(guān)閉的時候等待所有任務(wù)都完成后,再繼續(xù)銷毀其他的Bean,這樣這些異步任務(wù)的銷毀就會先于數(shù)據(jù)庫連接池對象的銷毀。
executor.setWaitForTasksToCompleteOnShutdown(waitForTasksToCompleteOnShutdown);
//該方法用來設(shè)置線程池中,任務(wù)的等待時間,如果超過這個時間還沒有銷毀就強制銷毀,以確保應(yīng)用最后能夠被關(guān)閉,而不是阻塞住。
executor.setAwaitTerminationSeconds(awaitTerminationSeconds);
executor.initialize();
return executor;
}
@Override
public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
return (ex, method, params) -> logger.error("線程池執(zhí)行任務(wù)發(fā)生未知異常.", ex);
}
}
多個線程池
@Async注解,使用系統(tǒng)默認或者自定義的線程池(代替默認線程池)??稍陧椖恐性O(shè)置多個線程池,在異步調(diào)用時,指明需要調(diào)用的線程池名稱,如@Async("new_task")。
5. @Async注解失效原因
沒有過去到代理類,本類調(diào)用時,直接自己內(nèi)部調(diào)用,沒有走代理類
1.沒有在@SpringBootApplication啟動類當中添加注解@EnableAsync注解。
2.異步方法使用注解@Async的返回值只能為void或者Future。
3.沒有走Spring的代理類。因為@Transactional和@Async注解的實現(xiàn)都是基于Spring的AOP,而AOP的實現(xiàn)是基于動態(tài)代理模式實現(xiàn)的。那么注解失效的原因就很明顯了,有可能因為調(diào)用方法的是對象本身而不是代理對象,因為沒有經(jīng)過Spring容器。
解決方法:
這里具體說一下第三種情況的解決方法。
1.注解的方法必須是public方法。
2.方法一定要從另一個類中調(diào)用,也就是從類的外部調(diào)用,類的內(nèi)部調(diào)用是無效的。
3.如果需要從類的內(nèi)部調(diào)用,需要先獲取其代理類,下面上代碼
@Service
public class AsyncService{
public void methodA(){
...
AsyncService asyncServiceProxy = SpringUtil.getBean(AsyncService.class);
asyncServiceProxy .methodB();
...
}
@Async
public void methodB() {
...
}
}
本類中可以定義實現(xiàn)本類中調(diào)用的本類的異步多線程方法;
必須實現(xiàn)的兩種:
- public方法
- 手動獲取spring bean
SpringUtils的工具類,手動獲取bean方法:
package intellif.util;
import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;
/**
* @author liuyu
* @className SpringUtils
* @date 2019/12/16 20:55
* @description
*/
@Component("springContextUtil")
public class SpringUtils implements ApplicationContextAware {
private static ApplicationContext applicationContext = null;
public static ApplicationContext getApplicationContext() {
return applicationContext;
}
@SuppressWarnings("unchecked")
public static <T> T getBean(String beanId) {
return (T) applicationContext.getBean(beanId);
}
public static <T> T getBean(Class<T> requiredType) {
return (T) applicationContext.getBean(requiredType);
}
/**
* Spring容器啟動后,會把 applicationContext 給自動注入進來,然后我們把 applicationContext
* 賦值到靜態(tài)變量中,方便后續(xù)拿到容器對象
* @see org.springframework.context.ApplicationContextAware#setApplicationContext(org.springframework.context.ApplicationContext)
*/
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
SpringUtils.applicationContext = applicationContext;
}
}
以上就是本文的全部內(nèi)容,希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
java11新特性之集合轉(zhuǎn)換為數(shù)組的方法
Java11引入了一種將帶有泛型的集合轉(zhuǎn)換為帶有泛型的數(shù)組的簡單方法,本文通過實例代碼介紹java11新特性之集合轉(zhuǎn)換為數(shù)組的操作方法,感興趣的朋友跟隨小編一起看看吧2024-06-06
maven引入mysql-connector-java包失敗的解決方案
這篇文章主要介紹了maven引入mysql-connector-java包失敗的解決方案,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2023-02-02
springboot實現(xiàn)通過路徑從磁盤直接讀取圖片
這篇文章主要介紹了springboot實現(xiàn)通過路徑從磁盤直接讀取圖片,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2022-03-03
Java中excel表數(shù)據(jù)的批量導(dǎo)入方法
這篇文章主要為大家詳細介紹了Java中excel表數(shù)據(jù)的批量導(dǎo)入方法,文中示例代碼介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們可以參考一下2018-05-05

