本文講述@Async注解,在Spring體系中的應用。本文僅說明@Async注解的應用規則,對于原理,調用邏輯,源碼分析,暫不介紹。對于異步方法調用,從Spring3開始提供了@Async注解,該注解可以被標注在方法上,以便異步地調用該方法。調用者將在調用時立即返回,方法的實際執行將提交給Spring TaskExecutor的任務中,由指定的線程池中的線程執行。
在項目應用中,@Async調用線程池,推薦使用自定義線程池的模式。自定義線程池常用方案:重新實現接口AsyncConfigurer。
| 簡介
應用場景
同步: 同步就是整個處理過程順序執行,當各個過程都執行完畢,并返回結果。
異步: 異步調用則是只是發送了調用的指令,調用者無需等待被調用的方法完全執行完畢;而是繼續執行下面的流程。
例如, 在某個調用中,需要順序調用 A, B, C三個過程方法;如他們都是同步調用,則需要將他們都順序執行完畢之后,方算作過程執行完畢;如B為一個異步的調用方法,則在執行完A之后,調用B,并不等待B完成,而是執行開始調用C,待C執行完畢之后,就意味著這個過程執行完畢了。在Java中,一般在處理類似的場景之時,都是基于創建獨立的線程去完成相應的異步調用邏輯,通過主線程和不同的業務子線程之間的執行流程,從而在啟動獨立的線程之后,主線程繼續執行而不會產生停滯等待的情況。
Spring 已經實現的線程池
- SimpleAsyncTaskExecutor:不是真的線程池,這個類不重用線程,默認每次調用都會創建一個新的線程。
- SyncTaskExecutor:這個類沒有實現異步調用,只是一個同步操作。只適用于不需要多線程的地方。
- ConcurrentTaskExecutor:Executor的適配類,不推薦使用。如果ThreadPoolTaskExecutor不滿足要求時,才用考慮使用這個類。
- SimpleThreadPoolTaskExecutor:是Quartz的SimpleThreadPool的類。線程池同時被quartz和非quartz使用,才需要使用此類。
- ThreadPoolTaskExecutor :最常使用,推薦。其實質是對java.util.concurrent.ThreadPoolExecutor的包裝。
異步的方法有:
- 最簡單的異步調用,返回值為void。
- 帶參數的異步調用,異步方法可以傳入參數。
- 存在返回值,常調用返回Future。
| Spring中啟用@Async
// 基于Java配置的啟用方式:
@Configuration
@EnableAsync
public class SpringAsyncConfig { ... }
// Spring boot啟用:
@EnableAsync
@EnableTransactionManagement
public class SettlementApplication {
public static void main(String[] args) {
SpringApplication.run(SettlementApplication.class, args);
}
}
| @Async應用默認線程池
Spring應用默認的線程池,指在@Async注解在使用時,不指定線程池的名稱。查看源碼,@Async的默認線程池為SimpleAsyncTaskExecutor。
無返回值調用
基于@Async無返回值調用,直接在使用類,使用方法(建議在使用方法)上,加上注解。若需要拋出異常,需手動new一個異常拋出。
/**
* 帶參數的異步調用 異步方法可以傳入參數
* 對于返回值是void,異常會被AsyncUncaughtExceptionHandler處理掉
* @param s
*/
@Async
public void asyncInvokeWithException(String s) {
log.info("asyncInvokeWithParameter, parementer={}", s);
throw new IllegalArgumentException(s);
}
有返回值Future調用
/**
* 異常調用返回Future
* 對于返回值是Future,不會被AsyncUncaughtExceptionHandler處理,需要我們在方法中捕獲異常并處理
* 或者在調用方在調用Futrue.get時捕獲異常進行處理
*
* @param i
* @return
*/
@Async
public Future<String> asyncInvokeReturnFuture(int i) {
log.info("asyncInvokeReturnFuture, parementer={}", i);
Future<String> future;
try {
Thread.sleep(1000 * 1);
future = new AsyncResult<String>("success:" + i);
throw new IllegalArgumentException("a");
} catch (InterruptedException e) {
future = new AsyncResult<String>("error");
} catch(IllegalArgumentException e){
future = new AsyncResult<String>("error-IllegalArgumentException");
}
return future;
}
有返回值CompletableFuture調用
CompletableFuture 并不使用@Async注解,可達到調用系統線程池處理業務的功能。
JDK5新增了Future接口,用于描述一個異步計算的結果。雖然 Future 以及相關使用方法提供了異步執行任務的能力,但是對于結果的獲取卻是很不方便,只能通過阻塞或者輪詢的方式得到任務的結果。阻塞的方式顯然和我們的異步編程的初衷相違背,輪詢的方式又會耗費無謂的 CPU 資源,而且也不能及時地得到計算結果。
- CompletionStage代表異步計算過程中的某一個階段,一個階段完成以后可能會觸發另外一個階段
- 一個階段的計算執行可以是一個Function,Consumer或者Runnable。比如:stage.thenApply(x -> square(x)).thenAccept(x -> System.out.print(x)).thenRun(() -> System.out.println())。
- 一個階段的執行可能是被單個階段的完成觸發,也可能是由多個階段一起觸發。
在Java8中,CompletableFuture提供了非常強大的Future的擴展功能,可以幫助我們簡化異步編程的復雜性,并且提供了函數式編程的能力,可以通過回調的方式處理計算結果,也提供了轉換和組合 CompletableFuture 的方法。
- 它可能代表一個明確完成的Future,也有可能代表一個完成階段( CompletionStage ),它支持在計算完成以后觸發一些函數或執行某些動作。
- 它實現了Future和CompletionStage接口。
/**
* 數據查詢線程池
*/
private static final ThreadPoolExecutor SELECT_POOL_EXECUTOR = new ThreadPoolExecutor(10, 20, 5000,
TimeUnit.MILLISECONDS, new LinkedBlockingQueue<>(1024), new ThreadFactoryBuilder().setNameFormat("selectThreadPoolExecutor-%d").build());
// tradeMapper.countTradeLog(tradeSearchBean)方法表示,獲取數量,返回值為int
// 獲取總條數
CompletableFuture<Integer> countFuture = CompletableFuture
.supplyAsync(() -> tradeMapper.countTradeLog(tradeSearchBean), SELECT_POOL_EXECUTOR);
// 同步阻塞
CompletableFuture.allOf(countFuture).join();
// 獲取結果
int count = countFuture.get();
默認線程池的弊端
在線程池應用中,參考阿里巴巴java開發規范:線程池不允許使用Executors去創建,不允許使用系統默認的線程池,推薦通過ThreadPoolExecutor的方式,這樣的處理方式讓開發的工程師更加明確線程池的運行規則,規避資源耗盡的風險。Executors各個方法的弊端:
- newFixedThreadPool和newSingleThreadExecutor:主要問題是堆積的請求處理隊列可能會耗費非常大的內存,甚至OOM。
- newCachedThreadPool和newScheduledThreadPool:要問題是線程數最大數是Integer.MAX_VALUE,可能會創建數量非常多的線程,甚至OOM。
@Async默認異步配置使用的是SimpleAsyncTaskExecutor,該線程池默認來一個任務創建一個線程,若系統中不斷的創建線程,最終會導致系統占用內存過高,引發OutOfMemoryError錯誤。針對線程創建問題,SimpleAsyncTaskExecutor提供了限流機制,通過concurrencyLimit屬性來控制開關,當concurrencyLimit>=0時開啟限流機制,默認關閉限流機制即concurrencyLimit=-1,當關閉情況下,會不斷創建新的線程來處理任務。基于默認配置,SimpleAsyncTaskExecutor并不是嚴格意義的線程池,達不到線程復用的功能。
| @Async應用自定義線程池
自定義線程池,可對系統中線程池更加細粒度的控制,方便調整線程池大小配置,線程執行異常控制和處理。在設置系統自定義線程池代替默認線程池時,雖可通過多種模式設置,但替換默認線程池最終產生的線程池有且只能設置一個(不能設置多個類繼承AsyncConfigurer)。自定義線程池有如下模式:
- 重新實現接口AsyncConfigurer;
- 繼承AsyncConfigurerSupport;
- 配置由自定義的TaskExecutor替代內置的任務執行器。
通過查看Spring源碼關于@Async的默認調用規則,會優先查詢源碼中實現AsyncConfigurer這個接口的類,實現這個接口的類為AsyncConfigurerSupport。但默認配置的線程池和異步處理方法均為空,所以,無論是繼承或者重新實現接口,都需指定一個線程池。且重新實現 public Executor getAsyncExecutor()方法。
實現接口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);
// 使用自定義的跨線程的請求級別線程工廠類19 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);
}
}
繼承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("執行異步任務'%s'", method), ex);
}
}
配置自定義的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。
TaskExecutor.class:ThreadPoolTaskExecutor->SchedulingTaskExecutor->AsyncTaskExecutor->TaskExecutor
這樣的模式,最終底層為TaskExecutor.class,在替換默認的線程池時,可不指定線程池名稱。
@EnableAsync
@Configuration
public class TaskPoolConfig {
@Bean(name = AsyncExecutionAspectSupport.DEFAULT_TASK_EXECUTOR_BEAN_NAME)
public Executor taskExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
//核心線程池大小
executor.setCorePoolSize(10);
//最大線程數
executor.setMaxPoolSize(20);
//隊列容量
executor.setQueueCapacity(200);
//活躍時間
executor.setKeepAliveSeconds(60);
//線程名字前綴
executor.setThreadNamePrefix("taskExecutor-");
executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
return executor;
}
@Bean(name = "new_task")
public Executor taskExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
//核心線程池大小
executor.setCorePoolSize(10);
//最大線程數
executor.setMaxPoolSize(20);
//隊列容量
executor.setQueueCapacity(200);
//活躍時間
executor.setKeepAliveSeconds(60);
//線程名字前綴
executor.setThreadNamePrefix("taskExecutor-");
executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
return executor;
}
}
多個線程池
@Async注解,使用系統默認或者自定義的線程池(代替默認線程池)。可在項目中設置多個線程池,在異步調用時,指明需要調用的線程池名稱,如@Async("new_task")。
| @Async部分重要源碼解析
源碼-獲取線程池方法
源碼-設置默認線程池defaultExecutor,默認是空的,當重新實現接口AsyncConfigurer的getAsyncExecutor()時,可以設置默認的線程池。
源碼-尋找系統默認線程池
源碼-都沒有找到項目中設置的默認線程池時,采用spring 默認的線程池
來源:https://www.cnblogs.com/wlandwl/p/async.html