作者：丁儀
來源：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 處理流程如下：
- 把 controller 返回的 DeferredResult 保存在內存隊列或集合當中；
- Spring MVC 調用 request.startAsync()，開啟異步；
- DispatcherServlet 和所有的 Filter 退出當前請求線程；
- 業務應用在異步線程中設置 DeferredResult 的返回值，Spring MVC 會再次發送請求；
- DispatcherServlet 再次被調用，並使用 DeferredResult 的返回值；
使用 Callable 進行異步處理
使用 Callable 進行異步處理與 DeferredResult 類似。不同的是，Callable 會交給系統指定的 TaskExecutor 執行。
根據官方描述，Spring MVC 處理流程如下：
- controller 返回 Callable；
- Spring MVC 調用 request.startAsync()，開啟異步，提交 Callable 到一個任務線程池；
- DispatcherServlet 和所有的 Filter 退出當前請求線程；
- 業務應用在異步線程中返回值，Spring MVC 會再次發送請求；
- 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 |
多次 |
無 |
無 |
自行處理 |
推薦閱讀