Spring MVC 3.2 技术预览(三):动手写一个异步Controller方法

转[http://blog.springsource.org/2012/05/10/spring-mvc-3-2-preview-making-a-controller-method-asynchronous/]

 

前面的文章中我介绍了Servlet 3、Spring MVC 3.2中支持异步的新特性,并介绍了一些实时更新的技术背景。在这篇文章中,我将展示一些Spring MVC 3.2新特性的技术细节,以及对Spring MVC request生命周期多方面的影响。

        如果需要将Controller层的方法转变为异步方法,只要将方法的返回值类型改为Callable就可以了。例如,返回视图名String类型的方法,可以改为返回Callable<String>类型;返回ResponseEntity类型的方法,可以改为返回Callable<ResponseEntity>类型;其他的返回值类型都可以以此类推。

        这种处理方式中,除了Controller层方法在另外一个线程中处理完成外,其他的工作方式没有发生任何变化。当方法改变成异步处理后,保持处理方式的简单非常重要。因为你会发现,今天我仅仅讲方法改为异步方式,但还是有很多相关问题需要考虑到。

 

示例代码:

        GitHub上spring-mvc-showcase项目中的spring-mvc-async分支里,有很多Controller层异步方法的示例。

        例如下面的@ResponseBody方法,其中返回了视图名String:

 

Java代码   收藏代码
  1. @RequestMapping(value="/response/annotation", method=RequestMethod.GET)  
  2.     public @ResponseBody Callable<String> responseBody() {  
  3.   
  4.         return new Callable<String>() {  
  5.             public String call() throws Exception {  
  6.   
  7.                 // Do some work..  
  8.                 Thread.sleep(3000L);  
  9.   
  10.                 return "The String ResponseBody";  
  11.             }  
  12.         };  
  13.     }  

 

        以及下面的ResponseEntity方法:

扫描二维码关注公众号,回复: 578032 查看本文章

 

Java代码   收藏代码
  1. @RequestMapping(value="/response/entity/headers", method=RequestMethod.GET)  
  2.     public Callable<ResponseEntity<String>> responseEntityCustomHeaders() {  
  3.   
  4.         return new Callable<ResponseEntity<String>>() {  
  5.             public ResponseEntity<String> call() throws Exception {  
  6.   
  7.                 // Do some work..  
  8.                 Thread.sleep(3000L);  
  9.   
  10.                 HttpHeaders headers = new HttpHeaders();  
  11.                 headers.setContentType(MediaType.TEXT_PLAIN);  
  12.                 return new ResponseEntity<String>(  
  13.                         "The String ResponseBody with custom header Content-Type=text/plain", headers, HttpStatus.OK);  
  14.             }  
  15.         };  
  16.     }  

 

        还有redirect类型的视图名方法

 

Java代码   收藏代码
  1. @RequestMapping(value="/uriTemplate", method=RequestMethod.GET)  
  2.     public Callable<String> uriTemplate(final RedirectAttributes redirectAttrs) {  
  3.   
  4.         return new Callable<String>() {  
  5.             public String call() throws Exception {  
  6.   
  7.                 // Do some work..  
  8.                 Thread.sleep(3000L);  
  9.   
  10.                 redirectAttrs.addAttribute("account""a123");  // Used as URI template variable  
  11.                 redirectAttrs.addAttribute("date"new LocalDate(20111231));  // Appended as a query parameter  
  12.                 return "redirect:/redirect/{account}";  
  13.             }  
  14.         };  
  15.     }  

        添加了@RequestMapping注解和@ResponseBody注解的方法中,这些注解同样会应用到返回值Callable中。添加了@ExceptionHandler注解的方法也一样,它调用了Controller层方法返回的Callable中抛出的异常。

 

Java代码   收藏代码
  1. package org.springframework.samples.mvc.exceptions;  
  2.   
  3. import java.util.concurrent.Callable;  
  4.   
  5. import org.springframework.stereotype.Controller;  
  6. import org.springframework.web.bind.annotation.ExceptionHandler;  
  7. import org.springframework.web.bind.annotation.RequestMapping;  
  8. import org.springframework.web.bind.annotation.ResponseBody;  
  9.   
  10. @Controller  
  11. public class ExceptionController {  
  12.   
  13.     @RequestMapping("/exception")  
  14.     public @ResponseBody Callable<String> exception() {  
  15.   
  16.         return new Callable<String>() {  
  17.             public String call() throws Exception {  
  18.   
  19.                 // Do some work..  
  20.                 Thread.sleep(2000L);  
  21.   
  22.                 throw new IllegalStateException("Sorry!");  
  23.             }  
  24.         };  
  25.     }  
  26.   
  27.     @ExceptionHandler  
  28.     public @ResponseBody String handle(IllegalStateException e) {  
  29.         return "IllegalStateException handled!";  
  30.     }  
  31.   
  32. }  

 

        在GitHub中提交的这个版本,记录了其中全部更新的情况。

        如果你运行了上面的任意一个方法,将会在控制台看到如下信息:

 

Text代码   收藏代码
  1. 16:19:23 [http-bio-8080-exec-3] DispatcherServlet - DispatcherServlet with name 'appServlet' processing ...  
  2. 16:19:23 [http-bio-8080-exec-3] RequestMappingHandlerMapping - Looking up handler method for path /views/html  
  3. 16:19:23 [http-bio-8080-exec-3] RequestMappingHandlerMapping - Returning handler method ...  
  4. 16:19:23 [http-bio-8080-exec-3] DispatcherServlet - Exiting request thread and leaving the response open  
  5. 16:19:23 [SimpleAsyncTaskExecutor-1] DispatcherServlet - Resuming asynchronous processing of ...  
  6. 16:19:26 [SimpleAsyncTaskExecutor-1] DispatcherServlet - Rendering view ...  
  7. 16:19:26 [SimpleAsyncTaskExecutor-1] JstlView - Added model object 'fruit'  
  8. 16:19:26 [SimpleAsyncTaskExecutor-1] JstlView - Added model object 'foo'  
  9. 16:19:26 [SimpleAsyncTaskExecutor-1] JstlView - Forwarding to resource [/WEB-INF/views/views/html.jsp]  
  10. 16:19:26 [SimpleAsyncTaskExecutor-1] DispatcherServlet - Successfully completed request  
  11. 16:19:26 [SimpleAsyncTaskExecutor-1] AsyncExecutionChainRunnable - Completing async request processing  

        从上面的日志信息中可以看出,Servlet容器调用的线程马上就执行完了方法,而余下的处理内容则在3秒钟后由另外一个线程完成。除了这些意外,上面的日志信息与普通的请求处理信息是一样的。

 

线程池配置:

        正如上面的日志信息所示,返回值Callable会默认调用SimpleAsyncTaskExecutor类来处理,这个类非常简单而且没有重用线程。而在实际的产品中,你将可能会需要使用AsyncTaskExecutor类来针对你所处的环境进行适当的配置,甚至有可能你已经有了一个配置好的AsyncTaskExecutor类。可以用RequestMappingHandlerAdapter类中的asyncTaskExecutor属性来引用它。

 

超时设定:

        超时设定是我们需要考虑的非常重要的一个方面。因为Servlet容器可能会强制将一个超时的未完成的异步请求关闭,你可以通过RequestMappingHandlerAdapter类中的asyncRequestTimeout属性指定超时时间。如果不指定超时时间,超时的时间将取决于Servlet容器所设定的时间。在Tomcat中,这个超时时间被默认设定为10秒钟(Servlet容器调用的线程执行时就开始计时)。

        在超时后仍然使用一个request或response的影响是不确定的。在实际使用中,Servlet容器将尝试重用request和response对象。这样一来,避免在超时后仍然使用request和response将变得非常重要。

        事实上,没有方法可以检测request是否已经超时。但是Servlet API中,当请求超时或网络出现问题时,将提供一个声明式的回调函数。Spring MVC中自动注册了这个声明,因此可以得知,一对请求响应是否不应该被使用。

        下面是执行过程中的事件序列:

 

  1. Controller层的方法返回一个Callable值
  2. Spring MVC在另外一个线程中调用这个Callable
  3. 请求处理的主线程执行完毕退出,超时计时开始
  4. Spring MVC声明一个超时设定
  5. 将response的状态设置为503(SERVICE_UNAVAILABLE)
  6. 一段时间过后,Callable执行完毕并返回值
  7. Spring MVC抛出StaleAsyncWebRequestException异常,而并不去处理它
  8. 异常被日志记录

 

        如果想要完全理解上面的过程,可以参考其中涉及到的三个线程——请求处理开始的线程(Servlet容器调用的线程)、执行Callable方法的线程(异步线程)和Servlet容器向Spring MVC声明超时的线程。

 

异常:

        异步处理中HandlerExceptionResolver类和异常处理的机制没有太多不同。当返回Callable之前发生了异常,处理方式与普通异常一样;当执行Callable方法的过程中产生异常,处理方式也与普通异常一样,只不过将在当前线程(异步线程)中处理,并将仍然返回未处理的500状态的response。

 

ThreadLocal属性:

        Spring MVC的一些部分和Spring MVC应用程序可能会以来ThreadLocal存储来获取request、locale及其他。当以异步的方式执行Callable方法时,异步线程将拥有相同的ThreadLocal属性。

        OpenSessionInViewFilter和OpenSessionInViewInterceptor也被更新为以透明的方式工作。而当Controller层的方法使用了@Transactional注解时,方法返回时就将完成事务,而不会扩展到执行Callable方法的内部。如果Callable需要处理事务,则需要委托(delegate)一个事务组件。

 

拦截器处理:

        已注册的HandlerInterceptor实例将与异步请求协作工作。主要的区别是:preHandle在Servlet容器线程开始的时候调用,而postHandle和afterCompletion方法则在异步线程中调用。在大多数情况下不会出现问题,除非HandlerInterceptor设置并清除了ThreadLocal属性。需要如此做的拦截器可能实现了AsyncHandlerInterceptor接口,这个借口为异步请求的处理添加了生命周期。

 

Servlet过滤器:

        一些过滤器将正常工作。而其他的过滤器将尝试在Servlet容器线程退出后执行后置处理(post-processing)。这样的过滤器需要进行一定的修改用来在异步线程中完成后置处理。所有的Spring过滤器都已经按照要求(按照异步请求处理的要求)进行修改,来与异步请求协同工作。但是第三方的过滤器是否能够在Spring MVC下正常处理异步请求,取决于这些过滤器的实现细节。

 

总结:

        在我的下一篇文章中,我将使用一个基于接收外部事件(AMQP消息)的示例,将其使用传统轮询的方式修改为使用长轮询的方式,用来在浏览器中显示实时信息。

猜你喜欢

转载自lvjun106.iteye.com/blog/2160446