1. 程式人生 > >Spring Boot使用@Async實現非同步呼叫返回結果:使用Future以及定義超時

Spring Boot使用@Async實現非同步呼叫返回結果:使用Future以及定義超時

關於使用 @Async實現非同步呼叫的內容,也得到不少童鞋的反饋,其中問題比較多的就是關於返回 Future的使用方法以及對非同步執行的超時控制,所以這篇就來一起講講這兩個問題的處理。

如果您對於 @Async註解的使用還不瞭解的話,可以看看之前的文章,具體如下:

定義非同步任務

首先,我們先使用 @Async註解來定義一個非同步任務,這個方法返回 Future型別,具體如下:

  1. @Slf4j

  2. @Component

  3. public class Task {

  4.    public static Random random = new Random();

  5.    @Async("taskExecutor")

  6.    public Future<String> run() throws Exception {

  7.        long sleep = random.nextInt(10000);

  8.        log.info("開始任務,需耗時:" + sleep + "毫秒");

  9.        Thread.sleep(sleep);

  10.        log.info("完成任務");

  11.        return new AsyncResult<>("test");

  12.    }

  13. }

Tips:什麼是 Future型別?

Future是對於具體的 Runnable或者 Callable任務的執行結果進行取消、查詢是否完成、獲取結果的介面。必要時可以通過get方法獲取執行結果,該方法會阻塞直到任務返回結果。

它的介面定義如下:

  1. public interface Future<V> {

  2.    boolean cancel(boolean mayInterruptIfRunning);

  3.    boolean isCancelled();

  4.    boolean isDone();

  5.    V get() throws InterruptedException, ExecutionException;

  6.    V get(long timeout, TimeUnit unit)

  7.        throws InterruptedException, ExecutionException, TimeoutException;

  8. }

它宣告這樣的五個方法:

  • cancel方法用來取消任務,如果取消任務成功則返回true,如果取消任務失敗則返回false。引數mayInterruptIfRunning表示是否允許取消正在執行卻沒有執行完畢的任務,如果設定true,則表示可以取消正在執行過程中的任務。如果任務已經完成,則無論mayInterruptIfRunning為true還是false,此方法肯定返回false,即如果取消已經完成的任務會返回false;如果任務正在執行,若mayInterruptIfRunning設定為true,則返回true,若mayInterruptIfRunning設定為false,則返回false;如果任務還沒有執行,則無論mayInterruptIfRunning為true還是false,肯定返回true。

  • isCancelled方法表示任務是否被取消成功,如果在任務正常完成前被取消成功,則返回 true。

  • isDone方法表示任務是否已經完成,若任務完成,則返回true;

  • get()方法用來獲取執行結果,這個方法會產生阻塞,會一直等到任務執行完畢才返回;

  • get(long timeout, TimeUnit unit)用來獲取執行結果,如果在指定時間內,還沒獲取到結果,就直接返回null。

也就是說Future提供了三種功能:

  1. 判斷任務是否完成;

  2. 能夠中斷任務;

  3. 能夠獲取任務執行結果。

測試執行與定義超時

在完成了返回 Future的非同步任務定義之後,我們來嘗試實現一個單元測試來使用這個Future完成任務的執行,比如:

  1. @Slf4j

  2. @RunWith(SpringJUnit4ClassRunner.class)

  3. @SpringBootTest

  4. public class ApplicationTests {

  5.    @Autowired

  6.    private Task task;

  7.    @Test

  8.    public void test() throws Exception {

  9.        Future<String> futureResult = task.run();

  10.        String result = futureResult.get(5, TimeUnit.SECONDS);

  11.        log.info(result);

  12.    }

  13. }

上面的程式碼中,我們在get方法中還定義了該執行緒執行的超時時間,通過執行這個測試我們可以觀察到執行時間超過5秒的時候,這裡會丟擲超時異常,該執行執行緒就能夠因執行超時而釋放回執行緒池,不至於一直阻塞而佔用資源。

完整示例:

讀者可以根據喜好選擇下面的兩個倉庫中檢視 Chapter4-1-5專案:

  • Github:https://github.com/dyc87112/SpringBoot-Learning/

  • Gitee:https://gitee.com/didispace/SpringBoot-Learning/

如果您對這些感興趣,歡迎star、follow、收藏、轉發給予支援!

熱文推薦

其他推薦