乒乓狂魔
- 浏览: 232913 次
- 性别:
- 来自: 上海
-
文章分类
最新评论
-
shuhucy：
必须赞啊，源码理解的很深，解决一个困扰两天的问题
Spring AOP源码分析（八）SpringAOP要注意的地方 -
sealinesu：
精彩
Spring事务源码分析（一）Spring事务入门 -
whlt20090509：
"WEB-INF/view目录下有一个简单的hell ...
SpringMVC源码总结（一）HandlerMapping和HandlerAdapter入门 -
hai0378：
兄台 算我一个，最近在研究dubbo motan 及 zk ...
ZooKeeper源码研究寻求小伙伴 -
zpkbtzmbw：
看懂了，原理
SpringMVC源码总结（五）Tomcat的URIEncoding、useBodyEncodingForURI和CharacterEncodingFilter
SpringMVC源码总结（六）mvc:annotation-driven中的HandlerMethodReturnValueHandler
- 博客分类：
- SpringMVC源码分析
经过了两篇的乱码说明，要重新回到mvc:annotation-driven标签中，继续说说HandlerMethodReturnValueHandler的使用，下一篇文章主要说说HttpMessageConverter。
HandlerMethodReturnValueHandler是RequestMappingHandlerAdapter用来处理当含有@RequestMapping的方法调度完成后，后面要进行的事情。
首先是HandlerMethodReturnValueHandler的自定义注册：
mvc:annotation-driven配置如下：
在启动AnnotationDrivenBeanDefinitionParser来解析mvc:annotation-driven标签的过程中(见本系列第三篇博客)，会注册我们所配置的HandlerMethodReturnValueHandler，如下：
然后将会这些自定义的HandlerMethodReturnValueHandler设置到RequestMappingHandlerAdapter的customReturnValueHandlers属性中，
RequestMappingHandlerAdapter的两个重要属性：
customReturnValueHandlers：存放我们自定义的HandlerMethodReturnValueHandler；
returnValueHandlers：存放最终所有的HandlerMethodReturnValueHandler；
如下所示：
returnValueHandlers的属性类型为HandlerMethodReturnValueHandlerComposite，里面也有一个list集合，来存放所有的HandlerMethodReturnValueHandler。
HandlerMethodReturnValueHandlerComposite结构如下：
在RequestMappingHandlerAdapter创建出来后，会执行afterPropertiesSet()方法，在该方法中会设置所有的HandlerMethodReturnValueHandler到RequestMappingHandlerAdapter的returnValueHandlers属性中如下：
getDefaultReturnValueHandlers()方法会获取默认要注册的和我们自定义的HandlerMethodReturnValueHandler，如下：
至此，所有的HandlerMethodReturnValueHandler的注册已经完成。我们可以再回顾下，在该系列的第三篇博客中介绍HandlerMethodReturnValueHandler的使用。
第一步：获取合适的HandlerAdapter，当方法含有@RequestMaiing注释的时候，便选择RequestMappingHandlerAdapter来进行方法的调度处理
第二步：方法的调度处理过程为：首先执行方法体，然后根据返回值来选择一个合适的HandlerMethodReturnValueHandler，如下代码：
this.returnValueHandlers.handleReturnValue(returnValue, getReturnValueType(returnValue), mavContainer, webRequest)会遍历所有的已注册的HandlerMethodReturnValueHandler判断他们支不支持returnValue的返回类型。如下：
找到支持的HandlerMethodReturnValueHandler后，就要执行它的handleReturnValue方法。
下面就具体介绍下下常用的这几个HandlerMethodReturnValueHandler；
HttpEntityMethodProcessor：用来处理返回值类型是HttpEntity的方法，简单用法如下
就是在构建http协议的返回体和返回头。
使用案例如，文件下载。
经常有人直接用HttpServletRequest和HttpServletResponse来做文件下载，这种方式便与web容器产生的对象耦合在一起，不推荐使用，而是直接使用spring为我们提供的HttpEntityMethodProcessor这一返回值处理器，虽然springmvc最终还是用HttpServletResponse来实现，但是这种方式便断开我们直接与web容器之间的耦合。
这一过程分析：
当这个方法执行完成之后，会调用HttpEntityMethodProcessor的handleReturnValue方法，
该方法内容就是为response设置响应头，然后将响应体的内容写入response的body中，此时又会涉及到HttpMessageConverter，当HttpEntity中的body类型为String,又会让StringHttpMessageConverter来进行转换。这和@ResponseBody的处理过程是一样的。
ViewNameMethodReturnValueHandler：主要用来处理返回值是String类型（前提不含@ResponseBody标签），它会将返回的字符串作为view视图的名字，如下所示。
另一种用法，当返回的字符串以redirect:开始，不再作为view视图名而是作为重定向的地址，如下：
有了重定向，也有转发。以forward：开头便是转发。
如下：
ModelMethodProcessor:用来处理返回类型为Model的，它默认采用请求路径作为视图名称，如下：
ModelAndViewMethodReturnValueHandler：用来处理返回值类型为ModelAndView，如下：
RequestResponseBodyMethodProcessor:则是用于处理方法中含有@ResponseBody注解，或类上含有@ResponseBody注解。这一处理过程在本系列的第三篇博客中有介绍，这里不再叙述。
还有其他的HandlerMethodReturnValueHandler，这里仅仅是作为引路，对HandlerMethodReturnValueHandler有个整体的认识，具体的内容，需要读者去具体研究。
HandlerMethodReturnValueHandler是RequestMappingHandlerAdapter用来处理当含有@RequestMapping的方法调度完成后，后面要进行的事情。
首先是HandlerMethodReturnValueHandler的自定义注册：
mvc:annotation-driven配置如下：
<mvc:annotation-driven> <mvc:return-value-handlers> <bean class="org.springframework.web.servlet.mvc.method.annotation.ModelAndViewMethodReturnValueHandler"></bean> </mvc:return-value-handlers> </mvc:annotation-driven>
在启动AnnotationDrivenBeanDefinitionParser来解析mvc:annotation-driven标签的过程中(见本系列第三篇博客)，会注册我们所配置的HandlerMethodReturnValueHandler，如下：
ManagedList<?> returnValueHandlers = getReturnValueHandlers(element, parserContext);
private ManagedList<?> getReturnValueHandlers(Element element, ParserContext parserContext) {
Element handlersElement = DomUtils.getChildElementByTagName(element, "return-value-handlers");
if (handlersElement != null) {
return extractBeanSubElements(handlersElement, parserContext);
}
return null;
}
然后将会这些自定义的HandlerMethodReturnValueHandler设置到RequestMappingHandlerAdapter的customReturnValueHandlers属性中，
RequestMappingHandlerAdapter的两个重要属性：
customReturnValueHandlers：存放我们自定义的HandlerMethodReturnValueHandler；
returnValueHandlers：存放最终所有的HandlerMethodReturnValueHandler；
如下所示：
public class RequestMappingHandlerAdapter extends AbstractHandlerMethodAdapter
implements BeanFactoryAware, InitializingBean {
private List<HandlerMethodArgumentResolver> customArgumentResolvers;
private HandlerMethodArgumentResolverComposite argumentResolvers;
private HandlerMethodArgumentResolverComposite initBinderArgumentResolvers;
//这里这里这里这里这里这里这里这里
private List<HandlerMethodReturnValueHandler> customReturnValueHandlers;
//这里这里这里这里这里这里这里这里
private HandlerMethodReturnValueHandlerComposite returnValueHandlers;
returnValueHandlers的属性类型为HandlerMethodReturnValueHandlerComposite，里面也有一个list集合，来存放所有的HandlerMethodReturnValueHandler。
HandlerMethodReturnValueHandlerComposite结构如下：
public class HandlerMethodReturnValueHandlerComposite implements HandlerMethodReturnValueHandler {
protected final Log logger = LogFactory.getLog(getClass());
private final List<HandlerMethodReturnValueHandler> returnValueHandlers =
new ArrayList<HandlerMethodReturnValueHandler>();
/**
在RequestMappingHandlerAdapter创建出来后，会执行afterPropertiesSet()方法，在该方法中会设置所有的HandlerMethodReturnValueHandler到RequestMappingHandlerAdapter的returnValueHandlers属性中如下：
@Override
public void afterPropertiesSet() {
if (this.argumentResolvers == null) {
List<HandlerMethodArgumentResolver> resolvers = getDefaultArgumentResolvers();
this.argumentResolvers = new HandlerMethodArgumentResolverComposite().addResolvers(resolvers);
}
if (this.initBinderArgumentResolvers == null) {
List<HandlerMethodArgumentResolver> resolvers = getDefaultInitBinderArgumentResolvers();
this.initBinderArgumentResolvers = new HandlerMethodArgumentResolverComposite().addResolvers(resolvers);
}
if (this.returnValueHandlers == null) {
//获取所有的HandlerMethodReturnValueHandler
List<HandlerMethodReturnValueHandler> handlers = getDefaultReturnValueHandlers();
this.returnValueHandlers = new HandlerMethodReturnValueHandlerComposite().addHandlers(handlers);
}
initControllerAdviceCache();
}
getDefaultReturnValueHandlers()方法会获取默认要注册的和我们自定义的HandlerMethodReturnValueHandler，如下：
private List<HandlerMethodReturnValueHandler> getDefaultReturnValueHandlers() {
List<HandlerMethodReturnValueHandler> handlers = new ArrayList<HandlerMethodReturnValueHandler>();
// Single-purpose return value types
handlers.add(new ModelAndViewMethodReturnValueHandler());
handlers.add(new ModelMethodProcessor());
handlers.add(new ViewMethodReturnValueHandler());
handlers.add(new HttpEntityMethodProcessor(getMessageConverters(), this.contentNegotiationManager));
handlers.add(new HttpHeadersReturnValueHandler());
handlers.add(new CallableMethodReturnValueHandler());
handlers.add(new DeferredResultMethodReturnValueHandler());
handlers.add(new AsyncTaskMethodReturnValueHandler(this.beanFactory));
// Annotation-based return value types
handlers.add(new ModelAttributeMethodProcessor(false));
handlers.add(new RequestResponseBodyMethodProcessor(getMessageConverters(), this.contentNegotiationManager));
// Multi-purpose return value types
handlers.add(new ViewNameMethodReturnValueHandler());
handlers.add(new MapMethodProcessor());
// Custom return value types
//这里这里会从customReturnValueHandlers属性中获取我们自定的HandlerMethodReturnValueHandler
if (getCustomReturnValueHandlers() != null) {
handlers.addAll(getCustomReturnValueHandlers());
}
// Catch-all
if (!CollectionUtils.isEmpty(getModelAndViewResolvers())) {
handlers.add(new ModelAndViewResolverMethodReturnValueHandler(getModelAndViewResolvers()));
}
else {
handlers.add(new ModelAttributeMethodProcessor(true));
}
return handlers;
}
至此，所有的HandlerMethodReturnValueHandler的注册已经完成。我们可以再回顾下，在该系列的第三篇博客中介绍HandlerMethodReturnValueHandler的使用。
第一步：获取合适的HandlerAdapter，当方法含有@RequestMaiing注释的时候，便选择RequestMappingHandlerAdapter来进行方法的调度处理
第二步：方法的调度处理过程为：首先执行方法体，然后根据返回值来选择一个合适的HandlerMethodReturnValueHandler，如下代码：
public final void invokeAndHandle(ServletWebRequest webRequest,
ModelAndViewContainer mavContainer, Object... providedArgs) throws Exception {
Object returnValue = invokeForRequest(webRequest, mavContainer, providedArgs);
setResponseStatus(webRequest);
if (returnValue == null) {
if (isRequestNotModified(webRequest) || hasResponseStatus() || mavContainer.isRequestHandled()) {
mavContainer.setRequestHandled(true);
return;
}
}
else if (StringUtils.hasText(this.responseReason)) {
mavContainer.setRequestHandled(true);
return;
}
mavContainer.setRequestHandled(false);
//重点重点重点重点重点重点重点重点重点重点
try {
this.returnValueHandlers.handleReturnValue(returnValue, getReturnValueType(returnValue), mavContainer, webRequest);
}
catch (Exception ex) {
if (logger.isTraceEnabled()) {
logger.trace(getReturnValueHandlingErrorMessage("Error handling return value", returnValue), ex);
}
throw ex;
}
}
this.returnValueHandlers.handleReturnValue(returnValue, getReturnValueType(returnValue), mavContainer, webRequest)会遍历所有的已注册的HandlerMethodReturnValueHandler判断他们支不支持returnValue的返回类型。如下：
public void handleReturnValue(
Object returnValue, MethodParameter returnType,
ModelAndViewContainer mavContainer, NativeWebRequest webRequest)
throws Exception {
HandlerMethodReturnValueHandler handler = getReturnValueHandler(returnType);
Assert.notNull(handler, "Unknown return value type [" + returnType.getParameterType().getName() + "]");
handler.handleReturnValue(returnValue, returnType, mavContainer, webRequest);
}
/**
* Find a registered {@link HandlerMethodReturnValueHandler} that supports the given return type.
*/
private HandlerMethodReturnValueHandler getReturnValueHandler(MethodParameter returnType) {
for (HandlerMethodReturnValueHandler returnValueHandler : returnValueHandlers) {
if (logger.isTraceEnabled()) {
logger.trace("Testing if return value handler [" + returnValueHandler + "] supports [" +
returnType.getGenericParameterType() + "]");
}
if (returnValueHandler.supportsReturnType(returnType)) {
return returnValueHandler;
}
}
return null;
}
找到支持的HandlerMethodReturnValueHandler后，就要执行它的handleReturnValue方法。
下面就具体介绍下下常用的这几个HandlerMethodReturnValueHandler；
HttpEntityMethodProcessor：用来处理返回值类型是HttpEntity的方法，简单用法如下
@RequestMapping(value="/test/httpEntity",method=RequestMethod.GET)
public HttpEntity<String> testHttpEntity() throws UnsupportedEncodingException{
String body="中国";
HttpHeaders headers=new HttpHeaders();
headers.add("Content-type","text/html;charset=GBK");
HttpEntity<String> ret=new HttpEntity<String>(body,headers);
return ret;
}
就是在构建http协议的返回体和返回头。
使用案例如，文件下载。
经常有人直接用HttpServletRequest和HttpServletResponse来做文件下载，这种方式便与web容器产生的对象耦合在一起，不推荐使用，而是直接使用spring为我们提供的HttpEntityMethodProcessor这一返回值处理器，虽然springmvc最终还是用HttpServletResponse来实现，但是这种方式便断开我们直接与web容器之间的耦合。
这一过程分析：
当这个方法执行完成之后，会调用HttpEntityMethodProcessor的handleReturnValue方法，
该方法内容就是为response设置响应头，然后将响应体的内容写入response的body中，此时又会涉及到HttpMessageConverter，当HttpEntity中的body类型为String,又会让StringHttpMessageConverter来进行转换。这和@ResponseBody的处理过程是一样的。
ViewNameMethodReturnValueHandler：主要用来处理返回值是String类型（前提不含@ResponseBody标签），它会将返回的字符串作为view视图的名字，如下所示。
另一种用法，当返回的字符串以redirect:开始，不再作为view视图名而是作为重定向的地址，如下：
@RequestMapping(value="/test/string",method=RequestMethod.GET)
public String testString(){
return "redirect:/string";
}
有了重定向，也有转发。以forward：开头便是转发。
如下：
@RequestMapping(value="/test/string",method=RequestMethod.GET)
public String testString(){
return "forward:/string";
}
ModelMethodProcessor:用来处理返回类型为Model的，它默认采用请求路径作为视图名称，如下：
@RequestMapping(value="/test/model",method=RequestMethod.GET)
public Model handleModel(String name) throws Exception {
Model model=new ExtendedModelMap();
model.addAttribute("name",name);
return model;
}
ModelAndViewMethodReturnValueHandler：用来处理返回值类型为ModelAndView，如下：
@RequestMapping(value="/test/modelandview",method=RequestMethod.GET)
public ModelAndView testModelAndView() throws Exception {
return new ModelAndView("hello");
}
RequestResponseBodyMethodProcessor:则是用于处理方法中含有@ResponseBody注解，或类上含有@ResponseBody注解。这一处理过程在本系列的第三篇博客中有介绍，这里不再叙述。
还有其他的HandlerMethodReturnValueHandler，这里仅仅是作为引路，对HandlerMethodReturnValueHandler有个整体的认识，具体的内容，需要读者去具体研究。
分享到：
发表评论
-
SpringMVC源码总结（十二）ViewResolver介绍
2014-09-10 06:43 2180首先我们先看看ModelAndView中重要的View接口。 ... -
SpringMVC源码总结（十一）mvc:interceptors拦截器介绍
2014-09-08 20:21 5678本文章针对mvc:interceptors标签进行介绍，它的注 ... -
SpringMVC源码总结（十）自定义HandlerMethodArgumentResolver
2014-09-04 07:45 7275上一篇文章介绍了HandlerMethodArgumentRe ... -
SpringMVC源码总结（九）HandlerMethodArgumentResolver介绍
2014-09-02 06:24 12303本文章主要介绍HandlerMethodArgumentRes ... -
SpringMVC源码总结（八）类型转换PropertyEditor的背后
2014-08-30 17:13 4768PropertyEditor是Spring最初 ... -
SpringMVC源码总结（七）mvc:annotation-driven中的HttpMessageConverter
2014-08-27 22:32 6504这一篇文章主要介绍下HttpMessageConverter整 ... -
SpringMVC源码总结（五）Tomcat的URIEncoding、useBodyEncodingForURI和CharacterEncodingFilter
2014-08-22 06:32 7174继续上一章节的乱码问题。上一篇文章仅仅说了设置Tomcat的U ... -
SpringMVC源码总结（四）由StringHttpMessageConverter引出的客户端服务器端之间的乱码过程分析
2014-08-20 22:49 3558继续上一篇文章遗留的乱码问题，引出从客户端数据到服务器端的乱码 ... -
SpringMVC源码总结（三）mvc:annotation-driven和mvc:message-converters简单介绍
2014-08-19 06:58 10058上一篇文章讲述了最简单的mvc:annotation-driv ... -
SpringMVC源码总结（二）mvc:annotation-driven以及@Controller和@RequestMapping的那些事
2014-08-16 22:47 8531上一篇文章让我们了解HandlerMapping和Handle ... -
SpringMVC源码总结（一）HandlerMapping和HandlerAdapter入门
2014-08-16 22:42 14588刚接触SpringMVC,对它的xml文件配置一直比较模模糊糊 ...
相关推荐
NULL 博文链接：https://lgbolgger.iteye.com/blog/2105151
NULL 博文链接：https://yihuawuye1.iteye.com/blog/2105063
SpringMVC第12讲：<mvc:annotation-driven/>
<mvc:annotation-driven> </mvc:annotation-driven> 中配置Json格式乱码。代码如下: <!--json格式乱码处理--> <mvc:message-converters register-defaults="true"> <constructor-arg value="UTF-8"/>
赠送jar包：spring-webmvc-5.3.10.jar； 赠送原API文档：spring-webmvc-5.3.10-javadoc.jar； 赠送源代码：spring-webmvc-5.3.10-sources.jar； 赠送Maven依赖信息文件：spring-webmvc-5.3.10.pom； 包含翻译后的API...
SpringMVC ---- HelloWorld ---- 代码 SpringMVC ---- HelloWorld ---- 代码 SpringMVC ---- HelloWorld ---- 代码 SpringMVC ---- HelloWorld ---- 代码 SpringMVC ---- HelloWorld ---- 代码 SpringMVC ---- Hello...
<mvc:annotation-driven/> <!--视图解析--> <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver"> ...
六、springMVC-mvc.xml 配置文件片段讲解 七、spring mvc 如何访问到静态的文件，如jpg,js,css？ 八、spring mvc 请求如何映射到具体的Action中的方法？ 九、spring mvc 中的拦截器： 十、spring mvc 如何使用拦截...
SpringMVC-Mybatis-Shiro-redis-master..............
六、springMVC-mvc.xml 配置文件片段讲解 七、spring mvc 如何访问到静态的文件，如jpg,js,css 八、spring mvc 请求如何映射到具体的Action中的方法 九、 spring mvc 中的拦截器： 十、 spring mvc 如何使用拦截器 ...
六、springMVC-mvc.xml 配置文件片段讲解 七、spring mvc 如何访问到静态的文件，如jpg,js,css？ 八、spring mvc 请求如何映射到具体的Action中的方法？ 九、spring mvc 中的拦截器： 十、spring mvc 如何使用拦截器...
springMVC相关技术配置使用注解的HandlerMapping和HandlerAdapter使用<mvc:annotation-driver> 不过springBoot已经省略了这些配置 配置使用注解的Handler和Service等等使用<context:component-scan> 不过springBoot...
springMVC3学习(六)--SimpleFormController(源码) 文章地址：http://blog.csdn.net/itmyhome1990/article/details/25988733
六、springMVC-mvc.xml 配置文件片段讲解 七、spring mvc 如何访问到静态的文件，如jpg,js,css？ 八、spring mvc 请求如何映射到具体的Action中的方法？ 九、spring mvc 中的拦截器： 十、spring mvc 如何使用拦截器...
springMVC3学习(七)--Interceptor拦截器(源码) 文章地址：http://blog.csdn.net/itmyhome1990/article/details/26286107
Java项目源码互助 Spring MVC-RAML 插件 Spring MVC-RAML 项目旨在为使用 Spring MVC 框架的项目强制执行契约优先方法。...这个想法是手动维护 ...SpringMVC-RAML 插件使用基于构建系统。 先决条件 和 确保您的JAVA_HOM
spring-mvc.xml 配置自动扫描的包、配置视图解析器 如何把 handler方法返回值解析为实际的物理视图、配置静态资源映射静态资源交给默认的Servlet、配置 mvc:annotation-driven标签开启注解(4)@RestController =@...
springMVC3学习(八)--全局的异常处理(源码) 文章地址：http://blog.csdn.net/itmyhome1990/article/details/26286435
springMVC3学习(五)--MultiActionController(源码) 文章地址：http://blog.csdn.net/itmyhome1990/article/details/25988091
springMVC3学习(十一)--文件上传CommonsMultipartFile(源码) 文章地址：http://blog.csdn.net/itmyhome1990/article/details/27976873