Spring boot註解@Async執行緒池例項詳解
這篇文章主要介紹了Spring boot註解@Async執行緒池例項詳解,文中通過示例程式碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下
從Spring3開始提供了@Async註解,該註解可以被標註在方法上,以便非同步地呼叫該方法。呼叫者將在呼叫時立即返回,方法的實際執行將提交給Spring TaskExecutor的任務中,由指定的執行緒池中的執行緒執行。
1. TaskExecutor
Spring非同步執行緒池的介面類,其實質是java.util.concurrent.Executor
Spring 已經實現的異常執行緒池:
1. SimpleAsyncTaskExecutor:不是真的執行緒池,這個類不重用執行緒,每次呼叫都會建立一個新的執行緒。
2. SyncTaskExecutor:這個類沒有實現非同步呼叫,只是一個同步操作。只適用於不需要多執行緒的地方
3. ConcurrentTaskExecutor:Executor的適配類,不推薦使用。如果ThreadPoolTaskExecutor不滿足要求時,才用考慮使用這
個類
4. SimpleThreadPoolTaskExecutor:是Quartz的SimpleThreadPool的類。執行緒池同時被quartz和非quartz使用,才需要使用此類
5. ThreadPoolTaskExecutor :最常使用,推薦。 其實質是對java.util.concurrent.ThreadPoolExecutor的包裝
2. @EnableAsync @Async
(1) springboot的啟動類,@EnableAsync註解開啟非同步呼叫
(2) spring對@Async定義非同步任務
非同步的方法有3種
1. 最簡單的非同步呼叫,返回值為void, 基於@Async無返回值呼叫,直接在使用類,使用方法(建議在使用方法)上,加上註解。若需要丟擲異常,需手動new一個異常丟擲。
2. 帶引數的非同步呼叫 非同步方法可以傳入引數
3. 異常呼叫返回Future,不會被AsyncUncaughtExceptionHandler處理,需要我們在方法中捕獲異常並處理或者在呼叫方在呼叫Futrue.get時捕獲異常進行處理
3. @Async應用預設執行緒池
spring應用預設的執行緒池,指在@Async註解在使用時,不指定執行緒池的名稱。檢視原始碼,@Async的預設執行緒池為SimpleAsyncTaskExecutor。
預設執行緒池的弊端
線上程池應用中,參考阿里巴巴java開發規範:執行緒池不允許使用Executors去建立,不允許使用系統預設的執行緒池,推薦通過ThreadPoolExecutor的方式,這樣的處理方式讓開發的工程師更加明確執行緒池的執行規則,規避資源耗盡的風險。Executors各個方法的弊端:
newFixedThreadPool和newSingleThreadExecutor:主要問題是堆積的請求處理佇列可能會耗費非常大的記憶體,甚至OOM。
newCachedThreadPool和newScheduledThreadPool:要問題是執行緒數最大數是Integer.MAX_VALUE,可能會建立數量非常多的執行緒,甚至OOM。
@Async預設非同步配置使用的是SimpleAsyncTaskExecutor,該執行緒池預設來一個任務建立一個執行緒,若系統中不斷的建立執行緒,最終會導致系統佔用記憶體過高,引發OutOfMemoryError錯誤。針對執行緒建立問題,SimpleAsyncTaskExecutor提供了限流機制,通過concurrencyLimit屬性來控制開關,當concurrencyLimit>=0時開啟限流機制,預設關閉限流機制即concurrencyLimit=-1,當關閉情況下,會不斷建立新的執行緒來處理任務。基於預設配置,SimpleAsyncTaskExecutor並不是嚴格意義的執行緒池,達不到執行緒複用的功能。
4. @Async應用自定義執行緒池
自定義執行緒池,可對系統中執行緒池更加細粒度的控制,方便調整執行緒池大小配置,執行緒執行異常控制和處理。在設定系統自定義執行緒池代替預設執行緒池時,雖可通過多種模式設定,但替換預設執行緒池最終產生的執行緒池有且只能設定一個(不能設定多個類繼承AsyncConfigurer)。自定義執行緒池有如下模式:
- 重新實現介面AsyncConfigurer
- 繼承AsyncConfigurerSupport
- 配置由自定義的TaskExecutor替代內建的任務執行器
通過檢視Spring原始碼關於@Async的預設呼叫規則,會優先查詢原始碼中實現AsyncConfigurer這個介面的類,實現這個介面的類為AsyncConfigurerSupport。但預設配置的執行緒池和非同步處理方法均為空,所以,無論是繼承或者重新實現介面,都需指定一個執行緒池。且重新實現 public Executor getAsyncExecutor()方法。
(1)實現介面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("執行非同步任務'%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,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,在替換預設的執行緒池時,需設定預設的執行緒池名稱為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(); //核心執行緒數 executor.setCorePoolSize(corePoolSize); //執行緒池最大的執行緒數,只有在緩衝佇列滿了之後,才會申請超過核心執行緒數的執行緒 executor.setMaxPoolSize(maxPoolSize); //允許執行緒的空閒時間,當超過了核心執行緒之外的執行緒,在空閒時間到達之後會被銷燬 executor.setKeepAliveSeconds(keepAliveSeconds); ////用來緩衝執行任務的佇列 executor.setQueueCapacity(queueCapacity); //執行緒池名的字首,可以用於定位處理任務所在的執行緒池 executor.setThreadNamePrefix("taskExecutor-"); //執行緒池對拒絕任務的處理策略 executor.setRejectedExecutionHandler((Runnable r,ThreadPoolExecutor exe) -> { logger.warn("當前任務執行緒池佇列已滿."); }); //該方法用來設定執行緒池關閉的時候等待所有任務都完成後,再繼續銷燬其他的Bean,這樣這些非同步任務的銷燬就會先於資料庫連線池物件的銷燬。 executor.setWaitForTasksToCompleteOnShutdown(waitForTasksToCompleteOnShutdown); //該方法用來設定執行緒池中,任務的等待時間,如果超過這個時間還沒有銷燬就強制銷燬,以確保應用最後能夠被關閉,而不是阻塞住。 executor.setAwaitTerminationSeconds(awaitTerminationSeconds); executor.initialize(); return executor; } @Override public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() { return (ex,params) -> logger.error("執行緒池執行任務發生未知異常.",ex); } }
多個執行緒池
@Async註解,使用系統預設或者自定義的執行緒池(代替預設執行緒池)。可在專案中設定多個執行緒池,在非同步呼叫時,指明需要呼叫的執行緒池名稱,如@Async("new_task")。
5. @Async註解失效原因
沒有過去到代理類,本類呼叫時,直接自己內部呼叫,沒有走代理類
1.沒有在@SpringBootApplication啟動類當中添加註解@EnableAsync註解。
2.非同步方法使用註解@Async的返回值只能為void或者Future。
3.沒有走Spring的代理類。因為@Transactional和@Async註解的實現都是基於Spring的AOP,而AOP的實現是基於動態代理模式實現的。那麼註解失效的原因就很明顯了,有可能因為呼叫方法的是物件本身而不是代理物件,因為沒有經過Spring容器。
解決方法:
這裡具體說一下第三種情況的解決方法。
1.註解的方法必須是public方法。
2.方法一定要從另一個類中呼叫,也就是從類的外部呼叫,類的內部呼叫是無效的。
3.如果需要從類的內部呼叫,需要先獲取其代理類,下面上程式碼
@Service public class AsyncService{ public void methodA(){ ... AsyncService asyncServiceProxy = SpringUtil.getBean(AsyncService.class); asyncServiceProxy .methodB(); ... } @Async public void methodB() { ... } }
本類中可以定義實現本類中呼叫的本類的非同步多執行緒方法;
必須實現的兩種:
- 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 * 賦值到靜態變數中,方便後續拿到容器物件 * @see org.springframework.context.ApplicationContextAware#setApplicationContext(org.springframework.context.ApplicationContext) */ @Override public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { SpringUtils.applicationContext = applicationContext; } }
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支援我們。