你想过Controller这些方法里的参数是如何工作的吗？

点击上方“方志朋”&＃xff0c;选择“设为星标”

回复”666“获取新整理的面试文章

前言

SpringMVC是目前主流的Web MVC框架之一。SpringMVC中Controller的方法参数可以是Integer&＃xff0c;Double&＃xff0c;自定义对象&＃xff0c;ServletRequest&＃xff0c;ServletResponse&＃xff0c;ModelAndView等等&＃xff0c;非常灵活。本文将分析SpringMVC是如何对这些参数进行处理的&＃xff0c;使读者能够处理自定义的一些参数。

现象

本文使用的demo基于maven。我们先来看一看对应的现象。 

&＃64;Controller
&＃64;RequestMapping(value &＃61; "/test")
public class TestController {&＃64;RequestMapping("/testRb")&＃64;ResponseBodypublic Employee testRb(&＃64;RequestBody Employee e) {return e;}&＃64;RequestMapping("/testCustomObj")&＃64;ResponseBodypublic Employee testCustomObj(Employee e) {return e;}&＃64;RequestMapping("/testCustomObjWithRp")&＃64;ResponseBodypublic Employee testCustomObjWithRp(&＃64;RequestParam Employee e) {return e;}&＃64;RequestMapping("/testDate")&＃64;ResponseBodypublic Date testDate(Date date) {return date;}
}

首先这是一个Controller&＃xff0c;有4个方法。他们对应的参数分别是带有&＃64;RequestBody的自定义对象、自定义对象、带有&＃64;RequestParam的自定义对象、日期对象。接下来我们一个一个方法进行访问看对应的现象是如何的。

首先第一个testRb&＃xff1a;

第二个testCustomObj&＃xff1a;

第三个testCustomObjWithRp&＃xff1a;

第四个testDate&＃xff1a;

为何返回的Employee对象会被自动解析为xml&＃xff0c;为何Employee参数会被解析&＃xff0c;带有&＃64;RequestParam的Employee参数不会被解析&＃xff0c;甚至报错&＃xff1f;

为何日期类型不能被解析&＃xff1f;

SpringMVC到底是如何处理这些方法的参数的&＃xff1f;

&＃64;RequestBody、&＃64;RequestParam这两个注解有什么区别&＃xff1f;

带着这几个问题。我们开始进行分析。

源码分析

本文所分析的源码是Spring版本4.0.2

在分析源码之前&＃xff0c;首先让我们来看下SpringMVC中两个重要的接口。

两个接口分别对应请求方法参数的处理、响应返回值的处理&＃xff0c;分别是HandlerMethodArgumentResolver和HandlerMethodReturnValueHandler&＃xff0c;这两个接口都是Spring3.1版本之后加入的。

SpringMVC处理请求大致是这样的&＃xff1a;

首先被DispatcherServlet截获&＃xff0c;DispatcherServlet通过handlerMapping获得HandlerExecutionChain&＃xff0c;然后获得HandlerAdapter。

HandlerAdapter在内部对于每个请求&＃xff0c;都会实例化一个ServletInvocableHandlerMethod进行处理&＃xff0c;ServletInvocableHandlerMethod在进行处理的时候&＃xff0c;会分两部分别对请求跟响应进行处理。

之后HandlerAdapter得到ModelAndView&＃xff0c;然后做相应的处理。

本文将重点介绍ServletInvocableHandlerMethod对请求以及响应的处理。

1. 处理请求的时候&＃xff0c;会根据ServletInvocableHandlerMethod的属性argumentResolvers&＃xff08;这个属性是它的父类InvocableHandlerMethod中定义的&＃xff09;进行处理&＃xff0c;其中argumentResolvers属性是一个HandlerMethodArgumentResolverComposite类(这里使用了组合模式的一种变形)&＃xff0c;这个类是实现了HandlerMethodArgumentResolver接口的类&＃xff0c;里面有各种实现了HandlerMethodArgumentResolver的List集合。

2. 处理响应的时候&＃xff0c;会根据ServletInvocableHandlerMethod的属性returnValueHandlers(自身属性)进行处理&＃xff0c;returnValueHandlers属性是一个HandlerMethodReturnValueHandlerComposite类(这里使用了组合模式的一种变形)&＃xff0c;这个类是实现了HandlerMethodReturnValueHandler接口的类&＃xff0c;里面有各种实现了HandlerMethodReturnValueHandler的List集合。

ServletInvocableHandlerMethod的returnValueHandlers和argumentResolvers这两个属性都是在ServletInvocableHandlerMethod进行实例化的时候被赋值的(使用RequestMappingHandlerAdapter的属性进行赋值)。

RequestMappingHandlerAdapter的argumentResolvers和returnValueHandlers这两个属性是在RequestMappingHandlerAdapter进行实例化的时候被Spring容器注入的。

其中默认的ArgumentResolvers:

默认的returnValueHandlers&＃xff1a;

 使用&＃64;ResponseBody注解的话最终返回值会被RequestResponseBodyMethodProcessor这个HandlerMethodReturnValueHandler实现类处理。

我们通过源码发现&＃xff0c;RequestResponseBodyMethodProcessor这个类其实同时实现了HandlerMethodReturnValueHandler和HandlerMethodArgumentResolver这两个接口。

RequestResponseBodyMethodProcessor支持的请求类型是Controller方法参数中带有&＃64;RequestBody注解&＃xff0c;支持的响应类型是Controller方法带有&＃64;ResponseBody注解。 

RequestResponseBodyMethodProcessor响应的具体处理是使用消息转换器。

处理请求的时候使用内部的readWithMessageConverters方法。

然后会执行父类(AbstractMessageConverterMethodArgumentResolver)的readWithMessageConverters方法。

 下面来我们来看看常用的HandlerMethodArgumentResolver实现类(本文粗略讲下&＃xff0c;有兴趣的读者可自行研究)。

1. RequestParamMethodArgumentResolver

 支持带有&＃64;RequestParam注解的参数或带有MultipartFile类型的参数

2. RequestParamMapMethodArgumentResolver

支持带有&＃64;RequestParam注解的参数 && &＃64;RequestParam注解的属性value存在 && 参数类型是实现Map接口的属性

3. PathVariableMethodArgumentResolver

支持带有&＃64;PathVariable注解的参数 且如果参数实现了Map接口&＃xff0c;&＃64;PathVariable注解需带有value属性

4. MatrixVariableMethodArgumentResolver

支持带有&＃64;MatrixVariable注解的参数 且如果参数实现了Map接口&＃xff0c;&＃64;MatrixVariable注解需带有value属性 

5. RequestResponseBodyMethodProcessor

 本文已分析过

6. ServletRequestMethodArgumentResolver

 参数类型是实现或继承或是WebRequest、ServletRequest、MultipartRequest、HttpSession、Principal、Locale、TimeZone、InputStream、Reader、HttpMethod这些类。

&＃xff08;这就是为何我们在Controller中的方法里添加一个HttpServletRequest参数&＃xff0c;Spring会为我们自动获得HttpServletRequest对象的原因&＃xff09;

7. ServletResponseMethodArgumentResolver

 参数类型是实现或继承或是ServletResponse、OutputStream、Writer这些类

8. RedirectAttributesMethodArgumentResolver

 参数是实现了RedirectAttributes接口的类

9. HttpEntityMethodProcessor

 参数类型是HttpEntity

从名字我们也看的出来&＃xff0c; 以Resolver结尾的是实现了HandlerMethodArgumentResolver接口的类&＃xff0c;以Processor结尾的是实现了HandlerMethodArgumentResolver和HandlerMethodReturnValueHandler的类。

下面来我们来看看常用的HandlerMethodReturnValueHandler实现类。

1. ModelAndViewMethodReturnValueHandler

返回值类型是ModelAndView或其子类

2. ModelMethodProcessor

返回值类型是Model或其子类

3. ViewMethodReturnValueHandler

返回值类型是View或其子类 

4. HttpHeadersReturnValueHandler

返回值类型是HttpHeaders或其子类  

5. ModelAttributeMethodProcessor

返回值有&＃64;ModelAttribute注解

6. ViewNameMethodReturnValueHandler

返回值是void或String

其余没讲过的读者可自行查看源码。

下面开始解释为何本文开头出现那些现象的原因&＃xff1a;

1. 第一个方法testRb以及地址 http://localhost:8888/SpringMVCDemo/test/testRb?name&＃61;1&age&＃61;3

这个方法的参数使用了&＃64;RequestBody&＃xff0c;之前已经分析过&＃xff0c;被RequestResponseBodyMethodProcessor进行处理。之后根据http请求头部的contentType然后选择合适的消息转换器进行读取。

很明显&＃xff0c;我们的消息转换器只有默认的那些跟部分json以及xml转换器&＃xff0c;且传递的参数name&＃61;1&age&＃61;3&＃xff0c;传递的头部中没有content-type&＃xff0c;默认使用了application/octet-stream&＃xff0c;因此触发了HttpMediaTypeNotSupportedException异常

解放方案&＃xff1a;我们将传递数据改成json&＃xff0c;同时http请求的Content-Type改成application/json即可。

完美解决。

2. testCustomObj方法以及地址 

http://localhost:8888/SpringMVCDemo/test/testCustomObj?name&＃61;1&age&＃61;3

这个请求会找到ServletModelAttributeMethodProcessor这个resolver。默认的resolver中有两个ServletModelAttributeMethodProcessor&＃xff0c;只不过实例化的时候属性annotationNotRequired一个为true&＃xff0c;1个为false。这个ServletModelAttributeMethodProcessor处理参数支持&＃64;ModelAttribute注解&＃xff0c;annotationNotRequired属性为true的话&＃xff0c;参数不是简单类型就通过&＃xff0c;因此选择了ServletModelAttributeMethodProcessor&＃xff0c;最终通过DataBinder实例化Employee对象&＃xff0c;并写入对应的属性。

3. testCustomObjWithRp方法以及地址

 http://localhost:8888/SpringMVCDemo/test/testCustomObjWithRp?name&＃61;1&age&＃61;3

这个请求会找到RequestParamMethodArgumentResolver(使用了&＃64;RequestParam注解)。RequestParamMethodArgumentResolver在处理参数的时候使用request.getParameter(参数名)即request.getParameter("e")得到&＃xff0c;很明显我们的参数传的是name&＃61;1&age&＃61;3。因此得到null&＃xff0c;RequestParamMethodArgumentResolver处理missing value会触发MissingServletRequestParameterException异常。&＃xff3b;粗略讲下&＃xff0c;有兴趣的读者请自行查看源码&＃xff3d;

解决方案&＃xff1a;去掉&＃64;RequestParam注解&＃xff0c;让ServletModelAttributeMethodProcessor来处理。

4. testDate方法以及地址 http://localhost:8888/SpringMVCDemo/test/testDate?date&＃61;2014-05-15

这个请求会找到RequestParamMethodArgumentResolver。因为这个方法与第二个方法一样&＃xff0c;有两个RequestParamMethodArgumentResolver&＃xff0c;属性useDefaultResolution不同。RequestParamMethodArgumentResolver支持简单类型&＃xff0c;ServletModelAttributeMethodProcessor是支持非简单类型。最终步骤跟第三个方法一样&＃xff0c;我们的参数名是date&＃xff0c;于是通过request.getParameter("date")找到date字符串(这里参数名如果不是date&＃xff0c;那么最终页面是空白的&＃xff0c;因为没有&＃64;RequestParam注解&＃xff0c;参数不是必须的&＃xff0c;RequestParamMethodArgumentResolver处理null值返回null)。最后通过DataBinder找到合适的属性编辑器进行类型转换。最终找到java.util.Date对象的构造函数 public Date(String s)&＃xff0c;由于我们传递的格式不是标准的UTC时间格式&＃xff0c;因此最终触发了IllegalArgumentException异常。

解决方案&＃xff1a;

1. 传递参数的格式修改成标准的UTC时间格式&＃xff1a;http://localhost:8888/SpringMVCDemo/test/testDate?date&＃61;Sat, 17 May 2014 16:30:00 GMT

2.在Controller中加入自定义属性编辑器。

&＃64;InitBinder
public void initBinder(WebDataBinder binder) {SimpleDateFormat dateFormat &＃61; new SimpleDateFormat("yyyy-MM-dd");binder.registerCustomEditor(Date.class, new CustomDateEditor(dateFormat, false));
}

 这个&＃64;InitBinder注解在实例化ServletInvocableHandlerMethod的时候被注入到WebDataBinderFactory中的&＃xff0c;而WebDataBinderFactory是ServletInvocableHandlerMethod的一个属性。在RequestMappingHandlerAdapter源码的803行getDataBinderFactory就是得到的WebDataBinderFactory

之后RequestParamMethodArgumentResolver通过WebDataBinderFactory创建的WebDataBinder里的自定义属性编辑器找到合适的属性编辑器(我们自定义的属性编辑器是用CustomDateEditor处理Date对象&＃xff0c;而testDate的参数刚好是Date)&＃xff0c;最终CustomDateEditor把这个String对象转换成Date对象。

# 编写自定义的HandlerMethodArgumentResolver

通过前面的分析&＃xff0c;我们明白了SpringMVC处理Controller中的方法的参数流程。现在&＃xff0c;如果方法中有两个参数&＃xff0c;且都是自定义类参数&＃xff0c;那该如何处理呢&＃xff1f;很明显&＃xff0c;要处理这个只能自己实现一个实现HandlerMethodArgumentResolver的类。

先定义1个注解FormObj&＃xff1a;

&＃64;Target({ElementType.PARAMETER})
&＃64;Retention(RetentionPolicy.RUNTIME)
public &＃64;interface FormObj {
//参数别名
String value() default "";
//是否展示, 默认展示
boolean show() default true;
}

然后是HandlerMethodArgumentResolver&＃xff1a;

public class FormObjArgumentResolver implements HandlerMethodArgumentResolver {&＃64;Override
public boolean supportsParameter(MethodParameter parameter) {
return parameter.hasParameterAnnotation(FormObj.class);}&＃64;Override
public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {FormObj formObj &＃61; parameter.getParameterAnnotation(FormObj.class);String alias &＃61; getAlias(formObj, parameter);//拿到obj, 先从ModelAndViewContainer中拿&＃xff0c;若没有则new1个参数类型的实例Object obj &＃61; (mavContainer.containsAttribute(alias)) ?mavContainer.getModel().get(alias) : createAttribute(alias, parameter, binderFactory, webRequest);//获得WebDataBinder&＃xff0c;这里的具体WebDataBinder是ExtendedServletRequestDataBinderWebDataBinder binder &＃61; binderFactory.createBinder(webRequest, obj, alias);Object target &＃61; binder.getTarget();if(target !&＃61; null) {
//绑定参数bindParameters(webRequest, binder, alias);
//JSR303 验证validateIfApplicable(binder, parameter);
if (binder.getBindingResult().hasErrors()) {
if (isBindExceptionRequired(binder, parameter)) {
throw new BindException(binder.getBindingResult());}}}if(formObj.show()) {mavContainer.addAttribute(alias, target);}return target;}private Object createAttribute(String alias, MethodParameter parameter, WebDataBinderFactory binderFactory, NativeWebRequest webRequest) {
return BeanUtils.instantiateClass(parameter.getParameterType());}private void bindParameters(NativeWebRequest request, WebDataBinder binder, String alias) {ServletRequest servletRequest &＃61; request.getNativeRequest(ServletRequest.class);MockHttpServletRequest newRequest &＃61; new MockHttpServletRequest();Enumeration enu &＃61; servletRequest.getParameterNames();
while(enu.hasMoreElements()) {String paramName &＃61; enu.nextElement();
if(paramName.startsWith(alias)) {newRequest.setParameter(paramName.substring(alias.length()&＃43;1), request.getParameter(paramName));}}((ExtendedServletRequestDataBinder)binder).bind(newRequest);}protected void validateIfApplicable(WebDataBinder binder, MethodParameter parameter) {Annotation[] annotations &＃61; parameter.getParameterAnnotations();
for (Annotation annot : annotations) {
if (annot.annotationType().getSimpleName().startsWith("Valid")) {Object hints &＃61; AnnotationUtils.getValue(annot);binder.validate(hints instanceof Object[] ? (Object[]) hints : new Object[] {hints});
break;}}}protected boolean isBindExceptionRequired(WebDataBinder binder, MethodParameter parameter) {
int i &＃61; parameter.getParameterIndex();Class[] paramTypes &＃61; parameter.getMethod().getParameterTypes();boolean hasBindingResult &＃61; (paramTypes.length > (i &＃43; 1) && Errors.class.isAssignableFrom(paramTypes[i &＃43; 1]));return !hasBindingResult;}private String getAlias(FormObj formObj, MethodParameter parameter) {
//得到FormObj的属性value&＃xff0c;也就是对象参数的简称String alias &＃61; formObj.value();
if(alias &＃61;&＃61; null || StringUtils.isBlank(alias)) {
//如果简称为空&＃xff0c;取对象简称的首字母小写开头String simpleName &＃61; parameter.getParameterType().getSimpleName();
alias &＃61; simpleName.substring(0, 1).toLowerCase() &＃43; simpleName.substring(1);}
return alias;}}

对应Controller&＃xff1a;

&＃64;Controller
&＃64;RequestMapping(value &＃61; "/foc")
public class FormObjController {&＃64;RequestMapping("/test1")
public String test1(&＃64;FormObj Dept dept, &＃64;FormObj Employee emp) {
return "index";}&＃64;RequestMapping("/test2")
public String test2(&＃64;FormObj("d") Dept dept, &＃64;FormObj("e") Employee emp) {
return "index";}&＃64;RequestMapping("/test3")
public String test3(&＃64;FormObj(value &＃61; "d", show &＃61; false) Dept dept, &＃64;FormObj("e") Employee emp) {
return "index";}}

 结果如下&＃xff1a;

# 总结

写了这么多&＃xff0c;主要还是巩固一下自己对SpringMVC对请求及响应的处理做一个细节的总结吧&＃xff0c;不知道大家有没有清楚这个过程。

想熟悉这部分内容最主要的还是要熟悉HandlerMethodArgumentResolver和HandlerMethodReturnValueHandler这两个接口以及属性编辑器、数据绑定机制。

本文难免有错误&＃xff0c;希望读者能指出来。

参考资料

• http://www.iteye.com/topic/1127676

• http://jinnianshilongnian.iteye.com/blog/1717180

作者&＃xff1a;format

https://www.cnblogs.com/fangjian0423/p/springMVC-request-param-analysis.html

热门内容&＃xff1a;项目实践&＃xff1a;SpringBoot三招组合拳&＃xff0c;手把手教你打出优雅的后端接口
一次SQL查询优化原理分析
start.aliyun.com正式上线
惊呆了&＃xff0c;Spring Boot居然这么耗内存&＃xff01;
两小时入门Docker最近面试BAT&＃xff0c;整理一份面试资料《Java面试BAT通关手册》&＃xff0c;覆盖了Java核心技术、JVM、Java并发、SSM、微服务、数据库、数据结构等等。
获取方式&＃xff1a;点“在看”&＃xff0c;关注公众号并回复 666 领取&＃xff0c;更多内容陆续奉上。
明天见(&＃xff61;&＃xff65;ω&＃xff65;