Spring Web MVC框架(三) 异步处理

前面介绍的处理方法都是同步的,意味着所有操作都在一个线程中完成。有时候处理流程可能很长,可能需要长时间的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可以同时实现AsyncHandlerInterceptorafterConcurrentHandlingStarted回调,也可以注册CallableProcessingInterceptorDeferredResultProcessingInterceptor 来进行更详细的控制。

DeferredResult提供了一些方法例如onTimeout(Runnable)onCompletion(Runnable)。如果使用Callable,也可以将其包装到WebAsyncTask中,同样提供了超时和完成回调的支持。

HTTP流

使用HTTP流可以向一个响应返回多个值。这时候让方法返回ResponseBodyEmitterResponseBodyEmitter可以由任意线程发送至,然后由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配置提供了配置异步请求的地方,分别是WebMvcConfigurerconfigureAsyncSupport方法和<mvc:annotation-driven><async-support>子元素。我们可以配置的属性有:异步请求的超时时间;异步请求的执行器(我们最好设置这个,因为Spring只是用了最简单的执行器,不一定满足我们的需求);以及注册CallableProcessingInterceptorDeferredResultProcessingInterceptor拦截器。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 129,377评论 18 137
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 43,337评论 6 343
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 29,858评论 18 399
  • 离开北京,迎着回家的日子,内心还是很开心的,家里盖了新房子,虽然装修简单,甚至没有几样像样的家具,但是相比以前的,...
    面条dear阅读 140评论 2 1
  • 早上坐在门口的塑料凳子上玩手机,隔壁家的小女孩拿着一朵大黄花走到面前问,叔叔你说这朵金色的花好不好看?和你...
    通往天上地下阅读 202评论 0 0
  • 腊月二十三,北方“小年”。 腊月二十四,南方“小年”。 年味渐浓,日子红火!
    英Joy夏天阅读 226评论 1 4
  • 去KTV必点的就是老男孩儿,唱一次,看一次总会内心波涛汹涌。我们总会被某个电视,某个演讲,某个鸡汤刺激到想要立马出...
    瑶瑶帆帆阅读 161评论 0 0
  • 2017.9.26(216—20/99)《焦点分享76》 午夜的钟声早已响过,躺在床上的我却迟迟没能进入梦...
    方正省阅读 123评论 0 2