前面介绍的处理方法都是同步的,意味着所有操作都在一个线程中完成。有时候处理流程可能很长,可能需要长时间的IO,这时候同步处理方法会白白占用处理器资源。这样就需要异步处理方法。
启用异步请求
要启用异步处理功能,我们要打开DispatcherServlet的异步支持。在web.xml中添加<async-supported>true</async-supported>
即可。web.xml
最低必须是3.0的。
<servlet>
<servlet-name>dispatcher</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<load-on-startup>1</load-on-startup>
<async-supported>true</async-supported>
</servlet>
异步方法的返回值
异步处理方法需要返回一个Callable。这种情况下最终的返回值会由一个Spring管理的线程生成。这种情况很适合IO阻塞的情况,例如读写大文件,读写数据库等等。
@PostMapping
public Callable<String> processUpload(final MultipartFile file) {
return new Callable<String>() {
public String call() throws Exception {
// ...
return "someView";
}
};
}
另外一种方式是返回一个DeferredResult,这时候返回结果的线程可以使任何线程,不一定是Spring MVC管理的线程,例如消息队列、计划任务等等。
@RequestMapping("/async")
@ResponseBody
public DeferredResult<String> async() {
DeferredResult<String> result = new DeferredResult<>();
Runnable task = () -> {
try {
Thread.sleep(5000);
result.setResult("result");
} catch (InterruptedException e) {
e.printStackTrace();
}
};
new Thread(task).start();
return result;
}
异步处理的异常
简单地说异步代码如果发生异常,情况和控制器直接抛出异常是一样的,异常同样会经过Spring的异常处理流程。对于返回DeferredResult的方法来说,其他线程可以选择返回正常结果(setValue方法)或者返回异常(setErrorResult方法)。
异步请求的拦截
HandlerInterceptor
可以同时实现AsyncHandlerInterceptor
的afterConcurrentHandlingStarted
回调,也可以注册CallableProcessingInterceptor
或DeferredResultProcessingInterceptor
来进行更详细的控制。
DeferredResult
提供了一些方法例如onTimeout(Runnable)
和onCompletion(Runnable)
。如果使用Callable
,也可以将其包装到WebAsyncTask
中,同样提供了超时和完成回调的支持。
HTTP流
使用HTTP流可以向一个响应返回多个值。这时候让方法返回ResponseBodyEmitter
。ResponseBodyEmitter
可以由任意线程发送至,然后由HttpMessageConverter
转换为合适的类型返回给响应。
@RequestMapping("/stream")
public ResponseBodyEmitter stream() {
ResponseBodyEmitter emitter = new ResponseBodyEmitter();
Runnable task = () -> {
try {
emitter.send("Hello guy");
emitter.send("Bye");
emitter.complete();
} catch (IOException e) {
e.printStackTrace();
}
};
new Thread(task).start();
return emitter;
}
有时候可能需要直接操作二进制流。这时候可以让方法返回StreamingResponseBody
,Spring会将二进制流直接返回给客户端。这种方法可以用来向客户端发送图片等数据。
@RequestMapping("/streamBody")
public StreamingResponseBody streamBody() {
return (output) -> {
output.write("123456".getBytes());
};
}
配置异步请求
配置Servlet容器
要启用异步请求,我们需要在web.xml
中设置DispatcherServlet
和所有参与异步请求的过滤器的异步支持。如果使用Java配置的话,需要在WebApplicationInitializer
设置asyncSupported
为真,或者更好的办法是继承AbstractAnnotationConfigDispatcherServletInitializer
,它已经设置了这些属性,并且让你注册过滤器更加容易。
配置Spring MVC
Spring的代码配置和XML配置提供了配置异步请求的地方,分别是WebMvcConfigurer
的configureAsyncSupport
方法和<mvc:annotation-driven>
的<async-support>
子元素。我们可以配置的属性有:异步请求的超时时间;异步请求的执行器(我们最好设置这个,因为Spring只是用了最简单的执行器,不一定满足我们的需求);以及注册CallableProcessingInterceptor
和DeferredResultProcessingInterceptor
拦截器。