SpringMVC非同步處理的 5 種方式

程式之心發表於2021-03-02
SpringMVC非同步

作者：丁儀

來源：https://chengxuzhixin.com/blog/post/SpringMVC-yi-bu-chu-li-de-5-zhong-fang-shi.html

 

前段時間研究了下 diamond 的原理，其中有個重要的知識點是長連線的實現，用到了 servlet 的非同步處理。非同步處理最大的好處是可以提高併發量，不阻塞當前執行緒。其實 Spring MVC 也支援了非同步處理，本文記錄下相關的技術點。

 

非同步處理 demo

如果要啟用非同步返回，需要開啟 @EnableAsync。如下的程式碼中，使用 DeferredResult 進行非同步處理。

請求進來後，首先建立 DeferredResult 物件，設定超時時間為 60 秒。然後指定 DeferredResult 在非同步完成和等待超時時的回撥。同步的處理只需要建立非同步任何，然後返回 DeferredResult 即可。這樣 Spring MVC 處理完此次請求後，不會立即返回 response 給客戶端，會一直等待 DeferredResult 處理完成。如果 DeferredResult 沒有在 60 秒內處理完成，就會觸發超時，然後返回 response 給客戶端。

@RequestMapping(value = "/async/demo")
public DeferredResult<String> async(){
    // 建立 DeferredResult，設定超時時間 60s
    DeferredResult<String> deferredResult = new DeferredResult<>((long)60 * 1000);

    String uuid = UUID.randomUUID().toString();
    Runnable callback = () -> manager.remove(deferredResult, uuid);
    // 設定完成和超時的回撥
    deferredResult.onCompletion(callback);
    deferredResult.onTimeout(callback);

    // 建立非同步任務
    manager.addAsyncTask(deferredResult, uuid);

    // 同步返回 DeferredResult
    return deferredResult;
}

 

對於非同步任務來說，需要持有 DeferredResult 物件。在非同步處理結束時，需要手動呼叫 DeferredResult.setResult 完成輸出。呼叫 setResult 時，資料輸出寫到客戶端，然後觸發非同步完成事件執行回撥。

task.getDeferredResult().setResult(ConfigJsonUtils.toJsonString(map));

 

使用 DeferredResult 進行非同步處理

DeferredResult 這個類代表延遲結果。DeferredResult 可以用在非同步任務中，其他執行緒能夠獲取 DeferredResult 並設定 DeferredResult 的返回資料。通常可以使用執行緒池、佇列等配合 DeferredResult 實現非同步處理。

根據官方描述，Spring MVC 處理流程如下：

  1. 把 controller 返回的 DeferredResult 儲存在記憶體佇列或集合當中；
  2. Spring MVC 呼叫 request.startAsync()，開啟非同步；
  3. DispatcherServlet 和所有的 Filter 退出當前請求執行緒；
  4. 業務應用在非同步執行緒中設定 DeferredResult 的返回值，Spring MVC 會再次傳送請求；
  5. DispatcherServlet 再次被呼叫，並使用 DeferredResult 的返回值；

 

使用 Callable 進行非同步處理

使用 Callable 進行非同步處理與 DeferredResult 類似。不同的是，Callable 會交給系統指定的 TaskExecutor 執行。

根據官方描述，Spring MVC 處理流程如下：

  1. controller 返回 Callable；
  2. Spring MVC 呼叫 request.startAsync()，開啟非同步，提交 Callable 到一個任務執行緒池；
  3. DispatcherServlet 和所有的 Filter 退出當前請求執行緒；
  4. 業務應用在非同步執行緒中返回值，Spring MVC 會再次傳送請求；
  5. DispatcherServlet 再次被呼叫，並使用 Callable 的返回值；
@RequestMapping(value = "/async/demo")
public Callable<String> async(){
    Callable<String> callable = () -> String.valueOf(System.currentTimeMillis());
    // 同步返回
    return callable;
}

 

使用 ListenableFuture 進行非同步處理

ListenableFuture 作為返回值，與 DeferredResult 類似。也需要使用者自行處理非同步執行緒，但不支援超時、完成回撥，需要自行處理。

@RequestMapping(value = "/async/demo")
public ListenableFuture<String> async(){
    ListenableFutureTask<String> ListenableFuture= new ListenableFutureTask<>(() -> {
        return String.valueOf(System.currentTimeMillis());
    });
    Executors.newSingleThreadExecutor().submit(ListenableFuture);
    return ListenableFuture;
}

　　

使用 ResponseBodyEmitter 進行非同步處理

DeferredResult 和 Callable 都只能返回一個非同步值。如果需要返回多個物件，就要使用 ResponseBodyEmitter。返回的每個物件都會被 HttpMessageConverter 處理並寫回輸出流。如果希望設定更多返回資料，如 header、status 等，可以把 ResponseBodyEmitter 作為 ResponseEntity 的實體資料返回。

@RequestMapping("/async/responseBodyEmitter")
public ResponseBodyEmitter responseBodyEmitter(){
    ResponseBodyEmitter responseBodyEmitter=new ResponseBodyEmitter();

    Executors.newSingleThreadExecutor().submit(() -> {
        try {
            responseBodyEmitter.send("demo");
            responseBodyEmitter.send("test");
            responseBodyEmitter.complete();
        } catch (Exception ignore) {}
    });

    return responseBodyEmitter;
}

　　 

使用 StreamingResponseBody 進行非同步處理

如果希望跳過返回值的自動轉換，直接把輸出流寫入 OutputStream，可以使用 StreamingResponseBody。也可以作為 ResponseEntity 的實體資料返回。

@RequestMapping("/async/streamingResponseBody")
public StreamingResponseBody streamingResponseBody(){
    StreamingResponseBody streamingResponseBody = outputStream -> {
        Executors.newSingleThreadExecutor().submit(() -> {
            try {
                outputStream.write("<html>streamingResponseBody</html>".getBytes());
            } catch (IOException ignore) {}
        });
    };
    return streamingResponseBody;
}

　　 

各種處理方式的對比

以上幾種非同步處理方式各有差異，需要按需取捨。對比如下。

 

可返回次數

資料轉換

回撥

執行緒池

DeferredResult

1 次

有

完成、超時

自行處理

Callable

1 次

有

無

系統處理

ListenableFuture

1 次

有

無

自行處理

ResponseBodyEmitter

多次

有

無

自行處理

StreamingResponseBody

多次

無

無

自行處理

 

推薦閱讀

Linux Cron 定時任務

人類簡史、軟體架構和中臺

限流演算法探祕

Git 工作原理

MyBatis 一級二級和自定義快取

相關文章