Spring中DeferredResult異步處理

更新時間：2023年12月06日 09:29:53 作者：檀越劍指大廠

DeferredResult是Spring中處理異步請求的強大工具,可以幫助改善應用程序的性能和用戶體驗,本文就來介紹一下Spring中DeferredResult異步處理,感興趣的可以了解一下

一.簡單介紹

1.DeferredResult 簡介

DeferredResult 是 Spring Framework 中用于異步處理請求的一種機制。它允許將處理結果推遲到稍后的時間點，通常用于處理需要較長時間完成的操作，例如異步任務、長時間計算或外部服務調用。

2.功能和特性

異步處理： DeferredResult 允許將請求的處理推遲到稍后的時間，允許應用程序異步地處理請求。
非阻塞： 使用 DeferredResult 不會阻塞容器線程，這有助于提高應用程序的吞吐量。
長輪詢： 可以使用 DeferredResult 實現(xiàn)長輪詢（long polling）模式，其中客戶端發(fā)送請求并在服務器端保持掛起狀態(tài)，直到有數據可用。

二.使用方式

1.Controller 中的方法

Controller 中的方法： 在控制器方法中，返回類型可以是 DeferredResult<T>，其中 T 是要返回的數據類型。

@GetMapping("/async-operation")
public DeferredResult<String> asyncOperation() {
    DeferredResult<String> deferredResult = new DeferredResult<>();

    // 在某個異步任務完成后，將結果設置到 DeferredResult 中
    asyncService.performAsyncOperation()
                .whenComplete((result, throwable) -> deferredResult.setResult(result));

    return deferredResult;
}

2.異步任務完成后設置結果

異步任務完成后設置結果： 在異步任務完成后，通過 DeferredResult.setResult(result) 將結果設置到 DeferredResult 對象中。

public CompletableFuture<String> performAsyncOperation() {
    // 異步任務邏輯
    return CompletableFuture.supplyAsync(() -> "Async operation result");
}

3.自定義線程池

線程池:

public class ThreadPoolUntil {
    private static final int THREAD_POOL_SIZE = 10;
    private static ExecutorService executorService = Executors.newFixedThreadPool(THREAD_POOL_SIZE);

    public static void executeTask(Runnable task) {
        executorService.submit(task);
    }

    public static void shutdown() {
        executorService.shutdown();
    }
}

controller:

@ApiOperation(value = "首頁-合計列表", nickname = "首頁-合計列表")
@PostMapping("/totalList")
public DeferredResult<Payload<List<TotalListDayDTO>>> totalList(@RequestBody TotalListQuery totalListQuery
        , @RequestHeader(value = "brandDetailNo") String brandDetailNo) {
      totalListQuery.setBrandDetailNo(brandDetailNo);
      DeferredResult<Payload<List<TotalListDayDTO>>> deferredResult = new DeferredResult<>(10000L);
      // 設置超時處理
      deferredResult.onTimeout(() -> deferredResult.setErrorResult(new Payload("504", "請求超時")));
      // 設置錯誤處理
      deferredResult.onError((Throwable t) -> deferredResult.setErrorResult(new Payload("500", "系統(tǒng)錯誤")));
      // 創(chuàng)建任務
      Runnable task = () -> deferredResult.setResult(new Payload(skuDataBusinessService.totalList(totalListQuery)));
      ThreadPoolUntil.executeTask(task);
      return deferredResult;
}

三.原理分析

1.Servlet 異步支持

Servlet 3.0+ 異步支持： DeferredResult 的實現(xiàn)依賴于 Servlet 3.0+ 的異步支持。在處理請求時，容器會將請求轉交給異步處理，允許處理線程在異步操作完成前釋放。

2.DeferredResult 中介

DeferredResult 作為中介： DeferredResult 充當控制器方法和異步任務之間的中介，使得控制器方法可以在異步任務完成后設置結果。

四.注意事項

1.超時處理

超時處理： 可以設置 DeferredResult 的超時時間，如果異步操作在超時時間內未完成，可以通過設置超時處理邏輯來處理。

deferredResult.setTimeout(5000); // 設置超時時間為5秒
deferredResult.onTimeout(() -> {
    // 處理超時邏輯
    deferredResult.setErrorResult("Operation timed out");
});

2.異常處理

異常處理： 需要在異步任務中捕獲可能的異常，并在 DeferredResult 中設置錯誤結果。

asyncService.performAsyncOperation()
            .whenComplete((result, throwable) -> {
                if (throwable != null) {
                    deferredResult.setErrorResult("An error occurred: " + throwable.getMessage());
                } else {
                    deferredResult.setResult(result);
                }
            });