SpringBoot用@Async注解實現異步任務
異步調用是相對于同步調用而言的,同步調用是指程序按預定順序一步步執行,每一步必須等到上一步執行完后才能執行,異步調用則無需等待上一步程序執行完即可執行。
如何實現異步調用?多線程,這是很多人第一眼想到的關鍵詞,沒錯,多線程就是一種實現異步調用的方式。
在非spring目項目中我們要實現異步調用的就是使用多線程方式,可以自己實現Runable接口或者集成Thread類,或者使用jdk1.5以上提供了的Executors線程池。
StrngBoot中則提供了很方便的方式執行異步調用。
異步接口的使用場景耗時比較長,任務比較多的接口。比方說,文件下載,大文件下載比較耗時,這個時候就可以使用異步接口。
項目示例已上傳至GitHub,可見github項目地址。
在解釋異步調用之前,我們先來看同步調用的定義;同步就是整個處理過程順序執行,當各個過程都執行完畢,并返回結果。 異步調用則是只是發送了調用的指令,調用者無需等待被調用的方法完全執行完畢;而是繼續執行下面的流程。
例如, 在某個調用中,需要順序調用 A, B, C三個過程方法;如他們都是同步調用,則需要將他們都順序執行完畢之后,方算作過程執行完畢; 如B為一個異步的調用方法,則在執行完A之后,調用B,并不等待B完成,而是執行開始調用C,待C執行完畢之后,就意味著這個過程執行完畢了。
@Async介紹基于@Async標注的方法稱為異步方法,方法在執行的時候,將會在獨立的線程中被執行,調用者無需等待它的完成,即可繼續其他的操作。使用時在SpringBoot主配置類中開啟異步即可。
@EnableAsync@SpringBootApplicationpublic class SpringBootAsyncTestApplication {無返回值異步方法
@Asyncpublic void asyncMethodWithNoReturnType() { try { Thread.sleep(3000); } catch (InterruptedException e) { e.printStackTrace(); } System.out.println('asyncMethodWithNoReturnType...');}
使用方法比較簡單,編寫一個測試方法并加上@Async注解即可。
含返回值異步方法@Asyncpublic Future<String> asyncMethodWithReturnType() { try { Thread.sleep(3000); return new AsyncResult<String>('success'); } catch (InterruptedException e) { e.printStackTrace(); } System.out.println('asyncMethodWithReturnType...'); return null;}
返回值利用Future泛型接口實現。
Future是對于具體的 Runnable 或者 Callable 任務的執行結果進行取消、查詢是否完成、獲取結果的接口,必要時可以通過get方法獲取執行結果,該方法會阻塞直到任務返回結果,包含了以下幾個方法。
public interface Future<V> { boolean cancel(boolean mayInterruptIfRunning); boolean isCancelled(); boolean isDone(); V get() throws InterruptedException, ExecutionException; V get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException;}
1.cancel方法的作用是取消任務,取消任務成功則返回true,反之返回false。參數 mayInterruptIfRunning 表示是否允許取消正在執行卻沒有執行完畢的任務。
運行cancel方法取消任務時:
i.若任務已完成:則無論 mayInterruptIfRunning 為 true 或 false,此方法都返回 false,即取消已經完成的任務都會返回false。
i.若任務正在執行:
mayInterruptIfRunning 設置為 true,則返回true。 mayInterruptIfRunning 設置為false,則返回false。iii.如果任務未執行,則無論mayInterruptIfRunning為true還是false,都返回true。
2.isCancelled方法的作用是判斷任務是否被取消成功,若在任務正常完成前被取消,則返回 true。
3.isDone方法的作用是判斷任務是否已經完成,若任務已完成,則返回true。
4.get()方法的作用是獲取執行結果,注意此方法會產生阻塞,等到任務執行完畢后才能獲得執行結果。
5.get(long timeout, TimeUnit unit)方法的作用同樣是獲取執行結果,若在指定時間內還未獲取到執行結果,則返回null。
編寫測試接口編寫/callWithNoReturnType和/callWithReturnType接口用于查看異步任務的執行過程。
@RestControllerpublic class AsyncController { @Autowired AsyncService asynSerivce; @GetMapping('/callWithNoReturnType') public String callWithNoReturnType() { asynSerivce.asyncMethodWithNoReturnType(); return 'success'; } @GetMapping('/callWithReturnType') public String callWithReturnType() { Future<String> future=asynSerivce.asyncMethodWithReturnType(); try { return future.get(); } catch (InterruptedException e) { e.printStackTrace(); } catch (ExecutionException e) { e.printStackTrace(); } return 'fail'; }
運行項目后使用Postman進行接口測試,分別給/callWithNoReturnType和/callWithReturnType接口發送Get請求,調用無返回值的異步方法asyncWithNoReturnType時,會立即返回返回值。但調用含返回值異步方法asyncWithReturnType時,由于我們調用了get()方法,會在等待3000毫秒后,才返回返回值。
到此這篇關于SpringBoot用@Async注解實現異步任務的文章就介紹到這了,更多相關SpringBoot @Async異步內容請搜索好吧啦網以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持好吧啦網!
相關文章:
