本文講述@Async註解,在Spring體系中的應用。本文僅說明@Async註解的應用規則,對於原理,調用邏輯,源碼分析,暫不介紹。對於異步方法調用,從Spring3開始提供了@Async註解,該註解能夠被標註在方法上,以便異步地調用該方法。調用者將在調用時當即返回,方法的實際執行將提交給Spring TaskExecutor的任務中,由指定的線程池中的線程執行。html
在項目應用中,@Async調用線程池,推薦使用自定義線程池的模式。自定義線程池經常使用方案:從新實現接口AsyncConfigurer。java
同步:同步就是整個處理過程順序執行,當各個過程都執行完畢,並返回結果。spring
異步: 異步調用則是隻是發送了調用的指令,調用者無需等待被調用的方法徹底執行完畢;而是繼續執行下面的流程。例如, 在某個調用中,須要順序調用 A, B, C三個過程方法;如他們都是同步調用,則須要將他們都順序執行完畢以後,方算做過程執行完畢; 如B爲一個異步的調用方法,則在執行完A以後,調用B,並不等待B完成,而是執行開始調用C,待C執行完畢以後,就意味着這個過程執行完畢了。在Java中,通常在處理相似的場景之時,都是基於建立獨立的線程去完成相應的異步調用邏輯,經過主線程和不一樣的業務子線程之間的執行流程,從而在啓動獨立的線程以後,主線程繼續執行而不會產生停滯等待的狀況。編程
1. SimpleAsyncTaskExecutor:不是真的線程池,這個類不重用線程,默認每次調用都會建立一個新的線程。
2. SyncTaskExecutor:這個類沒有實現異步調用,只是一個同步操做。只適用於不須要多線程的地方。
3. ConcurrentTaskExecutor:Executor的適配類,不推薦使用。若是ThreadPoolTaskExecutor不知足要求時,才用考慮使用這個類。
4. SimpleThreadPoolTaskExecutor:是Quartz的SimpleThreadPool的類。線程池同時被quartz和非quartz使用,才須要使用此類。
5. ThreadPoolTaskExecutor :最常使用,推薦。 其實質是對java.util.concurrent.ThreadPoolExecutor的包裝。多線程
異步的方法有:
app
1. 最簡單的異步調用,返回值爲void
2. 帶參數的異步調用,異步方法能夠傳入參數
3. 存在返回值,常調用返回Future異步
1 // 基於Java配置的啓用方式: 2 @Configuration 3 @EnableAsync 4 public class SpringAsyncConfig { ... } 5 6 // Spring boot啓用: 7 @EnableAsync 8 @EnableTransactionManagement 9 public class SettlementApplication { 10 public static void main(String[] args) { 11 SpringApplication.run(SettlementApplication.class, args); 12 } 13 }
Spring應用默認的線程池,指在@Async註解在使用時,不指定線程池的名稱。查看源碼,@Async的默認線程池爲SimpleAsyncTaskExecutor。async
基於@Async無返回值調用,直接在使用類,使用方法(建議在使用方法)上,加上註解。若須要拋出異常,需手動new一個異常拋出。ide
1 /** 2 * 帶參數的異步調用 異步方法能夠傳入參數 3 * 對於返回值是void,異常會被AsyncUncaughtExceptionHandler處理掉 4 * @param s 5 */ 6 @Async 7 public void asyncInvokeWithException(String s) { 8 log.info("asyncInvokeWithParameter, parementer={}", s); 9 throw new IllegalArgumentException(s); 10 }
1 /** 2 * 異常調用返回Future 3 * 對於返回值是Future,不會被AsyncUncaughtExceptionHandler處理,須要咱們在方法中捕獲異常並處理 4 * 或者在調用方在調用Futrue.get時捕獲異常進行處理 5 * 6 * @param i 7 * @return 8 */ 9 @Async 10 public Future<String> asyncInvokeReturnFuture(int i) { 11 log.info("asyncInvokeReturnFuture, parementer={}", i); 12 Future<String> future; 13 try { 14 Thread.sleep(1000 * 1); 15 future = new AsyncResult<String>("success:" + i); 16 throw new IllegalArgumentException("a"); 17 } catch (InterruptedException e) { 18 future = new AsyncResult<String>("error"); 19 } catch(IllegalArgumentException e){ 20 future = new AsyncResult<String>("error-IllegalArgumentException"); 21 } 22 return future; 23 }
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 的方法。
1 /** 2 * 數據查詢線程池 3 */ 4 private static final ThreadPoolExecutor SELECT_POOL_EXECUTOR = new ThreadPoolExecutor(10, 20, 5000, 5 TimeUnit.MILLISECONDS, new LinkedBlockingQueue<>(1024), new ThreadFactoryBuilder().setNameFormat("selectThreadPoolExecutor-%d").build()); 6 7 // tradeMapper.countTradeLog(tradeSearchBean)方法表示,獲取數量,返回值爲int 8 // 獲取總條數 9 CompletableFuture<Integer> countFuture = CompletableFuture 10 .supplyAsync(() -> tradeMapper.countTradeLog(tradeSearchBean), SELECT_POOL_EXECUTOR); 11 // 同步阻塞 12 CompletableFuture.allOf(countFuture).join(); 13 // 獲取結果 14 int count = countFuture.get();
在線程池應用中,參考阿里巴巴java開發規範:線程池不容許使用Executors去建立,不容許使用系統默認的線程池,推薦經過ThreadPoolExecutor的方式,這樣的處理方式讓開發的工程師更加明確線程池的運行規則,規避資源耗盡的風險。Executors各個方法的弊端:
@Async默認異步配置使用的是SimpleAsyncTaskExecutor,該線程池默認來一個任務建立一個線程,若系統中不斷的建立線程,最終會致使系統佔用內存太高,引起OutOfMemoryError錯誤。針對線程建立問題,SimpleAsyncTaskExecutor提供了限流機制,經過concurrencyLimit屬性來控制開關,當concurrencyLimit>=0時開啓限流機制,默認關閉限流機制即concurrencyLimit=-1,當關閉狀況下,會不斷建立新的線程來處理任務。基於默認配置,SimpleAsyncTaskExecutor並非嚴格意義的線程池,達不到線程複用的功能。
自定義線程池,可對系統中線程池更加細粒度的控制,方便調整線程池大小配置,線程執行異常控制和處理。在設置系統自定義線程池代替默認線程池時,雖可經過多種模式設置,但替換默認線程池最終產生的線程池有且只能設置一個(不能設置多個類繼承AsyncConfigurer)。自定義線程池有以下模式:
經過查看Spring源碼關於@Async的默認調用規則,會優先查詢源碼中實現AsyncConfigurer這個接口的類,實現這個接口的類爲AsyncConfigurerSupport。但默認配置的線程池和異步處理方法均爲空,因此,不管是繼承或者從新實現接口,都需指定一個線程池。且從新實現 public Executor getAsyncExecutor()方法。
1 @Configuration 2 public class AsyncConfiguration implements AsyncConfigurer { 3 @Bean("kingAsyncExecutor") 4 public ThreadPoolTaskExecutor executor() { 5 ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor(); 6 int corePoolSize = 10; 7 executor.setCorePoolSize(corePoolSize); 8 int maxPoolSize = 50; 9 executor.setMaxPoolSize(maxPoolSize); 10 int queueCapacity = 10; 11 executor.setQueueCapacity(queueCapacity); 12 executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy()); 13 String threadNamePrefix = "kingDeeAsyncExecutor-"; 14 executor.setThreadNamePrefix(threadNamePrefix); 15 executor.setWaitForTasksToCompleteOnShutdown(true); 16 // 使用自定義的跨線程的請求級別線程工廠類 17 RequestContextThreadFactory threadFactory = RequestContextThreadFactory.getDefault(); 18 executor.setThreadFactory(threadFactory); 19 int awaitTerminationSeconds = 5; 20 executor.setAwaitTerminationSeconds(awaitTerminationSeconds); 21 executor.initialize(); 22 return executor; 23 } 24 25 @Override 26 public Executor getAsyncExecutor() { 27 return executor(); 28 } 29 30 @Override 31 public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() { 32 return (ex, method, params) -> ErrorLogger.getInstance().log(String.format("執行異步任務'%s'", method), ex); 33 } 34 }
@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); } }
因爲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,在替換默認的線程池時,可不指定線程池名稱。)
1 @EnableAsync 2 @Configuration 3 public class TaskPoolConfig { 4 @Bean(name = AsyncExecutionAspectSupport.DEFAULT_TASK_EXECUTOR_BEAN_NAME) 5 public Executor taskExecutor() { 6 ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor(); 7 //核心線程池大小 8 executor.setCorePoolSize(10); 9 //最大線程數 10 executor.setMaxPoolSize(20); 11 //隊列容量 12 executor.setQueueCapacity(200); 13 //活躍時間 14 executor.setKeepAliveSeconds(60); 15 //線程名字前綴 16 executor.setThreadNamePrefix("taskExecutor-"); 17 executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy()); 18 return executor; 19 }
@Bean(name = "new_task") 5 public Executor taskExecutor() { 6 ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor(); 7 //核心線程池大小 8 executor.setCorePoolSize(10); 9 //最大線程數 10 executor.setMaxPoolSize(20); 11 //隊列容量 12 executor.setQueueCapacity(200); 13 //活躍時間 14 executor.setKeepAliveSeconds(60); 15 //線程名字前綴 16 executor.setThreadNamePrefix("taskExecutor-"); 17 executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy()); 18 return executor; 19 }
20 }
@Async註解,使用系統默認或者自定義的線程池(代替默認線程池)。可在項目中設置多個線程池,在異步調用時,指明須要調用的線程池名稱,如@Async("new_task")。
源碼-獲取線程池方法
源碼-設置默認線程池defaultExecutor,默認是空的,當從新實現接口AsyncConfigurer的getAsyncExecutor()時,能夠設置默認的線程池。
源碼-尋找系統默認線程池
源碼-都沒有找到項目中設置的默認線程池時,採用spring 默認的線程池
Spring Boot系列二 Spring @Async異步線程池用法總結
原文出處:https://www.cnblogs.com/wlandwl/p/async.html