• SpringMVC原理学习（二）参数解析器

     如下是所有的参数解析器，下面会通过代码演示常见的参数解析器

    1、初步了解 RequestMappingHandlerAdapter 的调用过程 

    先了解一下 HandlerMethod，后面代码会用到。

    HandlerMethod封装了很多属性，在访问请求方法的时候可以方便的访问到方法、方法参数、方法上的注解、所属类等并且对方法参数封装处理，也可以方便的访问到方法参数的注解等信息。

    1.     public HandlerMethod(Object bean, Method method) {
    2.         this((Object)bean, (Method)method, (MessageSource)null);
    3.     }
    4.  
    5.     protected HandlerMethod(Object bean, Method method, @Nullable MessageSource messageSource) {
    6.         Assert.notNull(bean, "Bean is required");
    7.         Assert.notNull(method, "Method is required");
    8.         this.bean = bean;
    9.         this.beanFactory = null;
    10.         this.messageSource = messageSource;
    11.         this.beanType = ClassUtils.getUserClass(bean);
    12.         this.method = method;
    13.         this.bridgedMethod = BridgeMethodResolver.findBridgedMethod(method);
    14.         ReflectionUtils.makeAccessible(this.bridgedMethod);
    15.         this.parameters = this.initMethodParameters();
    16.         this.evaluateResponseStatus();
    17.         this.description = initDescription(this.beanType, this.method);
    18.     }
    19.  
    20.     public MethodParameter[] getMethodParameters() {
    21.         return this.parameters;
    22.     }

    其中的 initMethodParameters() 方法会初始化方法的参数信息：

    User类：

    1. public class User {
    2.     private String name;
    3.     private int age;
    4.     
    5.     // 省略了基本方法
    6. }

    Controller类

    1. public class Controller {
    2.     public void test(
    3.             @RequestParam("name1") String name1, // name1=张三
    4.             String name2,                        // name2=李四
    5.             @RequestParam("age") int age,        // age=18 格式转换
    6.             @RequestParam(name = "home", defaultValue = "${JAVA_HOME}") String home1, // spring 获取数据
    7.             @RequestParam("file") MultipartFile file, // 上传文件
    8.             @PathVariable("id") int id,               //  /test/124   /test/{id}
    9.             @RequestHeader("Content-Type") String header,
    10.             @CookieValue("token") String token,
    11.             @Value("${JAVA_HOME}") String home2, // spring 获取数据  ${} #{}
    12.             HttpServletRequest request,          // request, response, session ...
    13.             @ModelAttribute("abc") User user1,          // name=zhang&age=18
    14.             User user2,                          // name=zhang&age=18
    15.             @RequestBody User user3              // json
    16.     ) {
    17.     }
    18. }

    配置类

    1. @Configuration
    2. public class WebConfig {
    3. }

     主启动类

    1. public class A21 {
    2.  
    3.     public static void main(String[] args) throws Exception {
    4.         AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(WebConfig.class);
    5.         DefaultListableBeanFactory beanFactory = context.getDefaultListableBeanFactory();
    6.         // 准备测试 Request
    7.         HttpServletRequest request = mockRequest();
    8.  
    9.         // 要点1. 控制器方法被封装为 HandlerMethod
    10.         HandlerMethod handlerMethod = new HandlerMethod(new Controller(), Controller.class.getMethod("test",
    11.                 String.class, String.class, int.class, String.class, MultipartFile.class, int.class, String.class,
    12.                 String.class, String.class, HttpServletRequest.class, User.class, User.class, User.class));
    13.  
    14.         //多个解析器的组合 组合器的设计模式
    15.         HandlerMethodArgumentResolverComposite composite = new HandlerMethodArgumentResolverComposite();
    16.  
    17.         composite.addResolvers(
    18.                 //beanFactory:需要在Spring容器里获取值，如 ${JAVA_HOME}
    19.                 // false：表示必须有 @RequestParam    true:表示不带 @RequestParam 的参数都会交给该解析器解析
    20.                 new RequestParamMethodArgumentResolver(beanFactory, false)
    21.         );
    22.  
    23.         // 要点4. 解析每个参数值
    24.         for (MethodParameter parameter : handlerMethod.getMethodParameters()) {
    25.             //获取参数上的注解，并连接起来
    26.             String annotions = Arrays.stream(parameter.getParameterAnnotations()).map(a -> a.annotationType().getSimpleName()).collect(Collectors.joining());
    27.             String str = annotions.length() > 0 ? "@" + annotions : " ";
    28.  
    29.             //是否支持此参数
    30.             if (composite.supportsParameter(parameter)) {
    31.                 //解析参数，获取参数的值
    32.                 //参数一：方法参数   参数二：ModelAndViewContainer，处理保存Model和View
    33.                 //参数三：请求   参数四：数据绑定工厂
    34.                 Object v = composite.resolveArgument(parameter, null, new ServletWebRequest(request), null);
    35.                 System.out.println("[" + parameter.getParameterIndex() + "] " + str + " " + parameter.getParameterType().getSimpleName()
    36.                         + " " + parameter.getParameterName() + " -> " + v + " [" + v.getClass() + "]");
    37.  
    38.             } else {
    39.                 System.out.println("[" + parameter.getParameterIndex() + "] " + str + parameter.getParameterType().getSimpleName()
    40.                         + " " + parameter.getParameterName());
    41.             }
    42.         }
    43.     }
    44.  
    45.     // 模拟请求
    46.     private static HttpServletRequest mockRequest() {
    47.         MockHttpServletRequest request = new MockHttpServletRequest();
    48.         request.setParameter("name1", "zhangsan");
    49.         request.setParameter("name2", "lisi");
    50.         // 参数一：参数名 参数二：文件名 参数三：内容
    51.         request.addPart(new MockPart("file", "abc", "hello".getBytes(StandardCharsets.UTF_8)));
    52.         // 找出/test/{id} 与 /test/123 的映射关系
    53.         // map：id=123
    54.         Map map = new AntPathMatcher().extractUriTemplateVariables("/test/{id}", "/test/123");
    55.         //放到 request 作用域
    56.         request.setAttribute(HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE, map);
    57.         request.setContentType("application/json");
    58.         request.setCookies(new Cookie("token", "123456"));
    59.         request.setParameter("name", "张三");
    60.         request.setParameter("age", "18");
    61.         Gson gson = new Gson();
    62.         String json = gson.toJson(new User("王五", 4));
    63.         request.setContent(json.getBytes(StandardCharsets.UTF_8));
    64.  
    65.         return new StandardServletMultipartResolver().resolveMultipart(request);
    66.     }
    67.  
    68. }

    结果：所有带箭头的都是被解析的，发现有两个问题：

    • 参数类型都为 String，方法参数的类型没有被解析
    • 方法参数的名字为 null

    添加数据绑定工厂：ServletRequestDataBinderFactory

    •  方法参数的类型被成功解析

    设置参数名的解析器

    • parameter.initParameterNameDiscovery(new DefaultParameterNameDiscoverer());
    • 得到方法参数的名字
    1. public class A21 {
    2.  
    3.     public static void main(String[] args) throws Exception {
    4.         AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
    5.         DefaultListableBeanFactory beanFactory = context.getDefaultListableBeanFactory(WebConfig.class);
    6.         // 准备测试 Request
    7.         HttpServletRequest request = mockRequest();
    8.  
    9.         // 要点1. 控制器方法被封装为 HandlerMethod
    10.         HandlerMethod handlerMethod = new HandlerMethod(new Controller(), Controller.class.getMethod("test",
    11.                 String.class, String.class, int.class, String.class, MultipartFile.class, int.class, String.class,
    12.                 String.class, String.class, HttpServletRequest.class, User.class, User.class, User.class));
    13.  
    14.         // 要点2. 准备对象绑定与类型转换
    15.         ServletRequestDataBinderFactory bindFactory = new ServletRequestDataBinderFactory(null, null);
    16.  
    17.  
    18.         //多个解析器的组合 组合器的设计模式
    19.         HandlerMethodArgumentResolverComposite composite = new HandlerMethodArgumentResolverComposite();
    20.  
    21.         composite.addResolvers(
    22.                 //beanFactory:需要在Spring容器里获取值，如 ${JAVA_HOME}
    23.                 // false：表示必须有 @RequestParam    true:表示不带 @RequestParam 的参数都会交给该解析器解析
    24.                 new RequestParamMethodArgumentResolver(beanFactory, false)
    25.         );
    26.  
    27.         // 要点4. 解析每个参数值
    28.         for (MethodParameter parameter : handlerMethod.getMethodParameters()) {
    29.             //获取参数上的注解，并连接起来
    30.             String annotions = Arrays.stream(parameter.getParameterAnnotations()).map(a -> a.annotationType().getSimpleName()).collect(Collectors.joining());
    31.             String str = annotions.length() > 0 ? "@" + annotions : " ";
    32.  
    33.             // 设置参数名的解析器
    34.             parameter.initParameterNameDiscovery(new DefaultParameterNameDiscoverer());
    35.  
    36.             //是否支持此参数
    37.             if (composite.supportsParameter(parameter)) {
    38.                 //解析参数，获取参数的值
    39.                 //参数一：方法参数   参数二：ModelAndViewContainer，处理保存Model和View
    40.                 //参数三：请求   参数四：数据绑定工厂
    41.                 Object v = composite.resolveArgument(parameter, null, new ServletWebRequest(request), bindFactory);
    42.                 System.out.println("[" + parameter.getParameterIndex() + "] " + str + " " + parameter.getParameterType().getSimpleName()
    43.                         + " " + parameter.getParameterName() + " -> " + v + " [" + v.getClass() + "]");
    44.  
    45.             } else {
    46.                 System.out.println("[" + parameter.getParameterIndex() + "] " + str + parameter.getParameterType().getSimpleName()
    47.                         + " " + parameter.getParameterName());
    48.             }
    49.         }
    50.     }
    51. }

    添加 @RequestMapping 解析器时参数设置为 true，表示不带 @RequestParam 的参数都会交给该解析器解析

    1. composite.addResolvers(
    2.     //beanFactory:需要在Spring容器里获取值，如 ${JAVA_HOME}
    3.     // false：表示必须有 @RequestParam    true:表示不带 @RequestParam 的参数都会交给该解析器解析
    4.     new RequestParamMethodArgumentResolver(beanFactory, true)
    5.   );

     结果：

     

    原因：解析 @PathVariable 时报错，@PathVariable 并不属于该解析器解析，解决办法后面会说。

     2、常见参数的解析

    准备 ModelAndViewContainer 用来存储中间 Model 结果，解析 @ModelAttribute 会把结果存储在里面。

    Controller类有这样的写法，是因为存储的时候如果不指定名字，会按类型的小写存储，由于两个参数类型一样，第二个结果会覆盖掉第一个结果。

    1. @ModelAttribute("abc") User user1,          // name=zhang&age=18
    2. User user2,                          // name=zhang&age=18
    1. public class A21 {
    2.  
    3.     public static void main(String[] args) throws Exception {
    4.         AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(WebConfig.class);
    5.         DefaultListableBeanFactory beanFactory = context.getDefaultListableBeanFactory();
    6.         // 准备测试 Request
    7.         HttpServletRequest request = mockRequest();
    8.  
    9.         // 要点1. 控制器方法被封装为 HandlerMethod
    10.         HandlerMethod handlerMethod = new HandlerMethod(new Controller(), Controller.class.getMethod("test",
    11.                 String.class, String.class, int.class, String.class, MultipartFile.class, int.class, String.class,
    12.                 String.class, String.class, HttpServletRequest.class, User.class, User.class, User.class));
    13.  
    14.         // 要点2. 准备对象绑定与类型转换
    15.         ServletRequestDataBinderFactory bindFactory = new ServletRequestDataBinderFactory(null, null);
    16.  
    17.         // 要点3. 准备 ModelAndViewContainer 用来存储中间 Model 结果
    18.         ModelAndViewContainer container = new ModelAndViewContainer();
    19.  
    20.         //多个解析器的组合 组合器的设计模式
    21.         HandlerMethodArgumentResolverComposite composite = new HandlerMethodArgumentResolverComposite();
    22.  
    23.         composite.addResolvers(
    24.                 //beanFactory:需要在Spring容器里获取值，如 ${JAVA_HOME}
    25.                 // false：表示必须有 @RequestParam    true:表示不带 @RequestParam 的参数都会交给该解析器解析（报错）
    26.                 new RequestParamMethodArgumentResolver(beanFactory, false),
    27.                 new PathVariableMethodArgumentResolver(),
    28.                 new RequestHeaderMethodArgumentResolver(beanFactory),
    29.                 new ServletCookieValueMethodArgumentResolver(beanFactory),
    30.                 new ExpressionValueMethodArgumentResolver(beanFactory),
    31.                 new ServletRequestMethodArgumentResolver(),
    32.                 new ServletModelAttributeMethodProcessor(false), //必须有 @ModelAttribute
    33.                 //位置，放在下面会被 ServletModelAttributeMethodProcessor 解析
    34.                 new RequestResponseBodyMethodProcessor(Arrays.asList(new MappingJackson2HttpMessageConverter())),
    35.                 new ServletModelAttributeMethodProcessor(true), //省略了 @ModelAttribute
    36.                 new RequestParamMethodArgumentResolver(beanFactory, true)//省略了 @RequestParam
    37.  
    38.         );
    39.  
    40.         // 要点4. 解析每个参数值
    41.         for (MethodParameter parameter : handlerMethod.getMethodParameters()) {
    42.             //获取参数上的注解，并连接起来
    43.             String annotions = Arrays.stream(parameter.getParameterAnnotations()).map(a -> a.annotationType().getSimpleName()).collect(Collectors.joining());
    44.             String str = annotions.length() > 0 ? "@" + annotions : " ";
    45.  
    46.             // 设置参数名的解析器
    47.             parameter.initParameterNameDiscovery(new DefaultParameterNameDiscoverer());
    48.  
    49.             //是否支持此参数
    50.             if (composite.supportsParameter(parameter)) {
    51.                 //解析参数，获取参数的值
    52.                 //参数一：方法参数   参数二：ModelAndViewContainer，处理保存Model和View
    53.                 //参数三：请求   参数四：数据绑定工厂
    54.                 Object v = composite.resolveArgument(parameter, container, new ServletWebRequest(request), bindFactory);
    55.                 System.out.println("[" + parameter.getParameterIndex() + "] " + str + " " + parameter.getParameterType().getSimpleName()
    56.                         + " " + parameter.getParameterName() + " -> " + v + " [" + v.getClass() + "]");
    57.                 System.out.println("模型数据为：" + container.getModel());
    58.  
    59.             } else {
    60.                 System.out.println("[" + parameter.getParameterIndex() + "] " + str + parameter.getParameterType().getSimpleName()
    61.                         + " " + parameter.getParameterName());
    62.             }
    63.         }
    64.     }
    65. }

    结果：

    这样添加的原因：防止 @RequestBody 被 ServletModelAttributeMethodProcessor解析，并且保证省略 @ModelAttribute 的参数也可以被 ServletModelAttributeMethodProcessor 解析。

    1. new ServletModelAttributeMethodProcessor(false)
    2. new RequestResponseBodyMethodProcessor(Arrays.asList(new MappingJackson2HttpMessageConverter())),
    3. new ServletModelAttributeMethodProcessor(true), //省略了 @ModelAttribute

    如果我这样写 

    1. new ServletModelAttributeMethodProcessor(true)
    2. new RequestResponseBodyMethodProcessor(Arrays.asList(new MappingJackson2HttpMessageConverter())),

    可以看到解析的结果发生变化，ServletModelAttributeMethodProcessor 解析了 @RequestBody 注解，发生了错误的解析。

    3、总结

    1. 初步了解 RequestMappingHandlerAdapter 的调用过程

      1. 控制器方法被封装为 HandlerMethod

      2. 准备对象绑定与类型转换

      3. 准备 ModelAndViewContainer 用来存储中间 Model 结果

      4. 解析每个参数值

    2. 解析参数依赖的就是各种参数解析器，它们都有两个重要方法

      • supportsParameter 判断是否支持方法参数

      • resolveArgument 解析方法参数

    3. 常见参数的解析

      • @RequestParam

      • 省略 @RequestParam

      • @RequestParam(defaultValue)

      • MultipartFile

      • @PathVariable

      • @RequestHeader

      • @CookieValue

      • @Value

      • HttpServletRequest 等

      • @ModelAttribute

      • 省略 @ModelAttribute

      • @RequestBody

    4. 组合模式在 Spring 中的体现

    5. @RequestParam, @CookieValue 等注解中的参数名、默认值, 都可以写成活的, 即从 ${ } #{ }中获取

  • 相关阅读:
    【信号处理】基于优化算法的 SAR 信号处理（Matlab代码实现）
    Python Web开发记录 Day16：Django part10 文件上传（完结篇）
    JAVA刷题之字符串的一些个人思路
    使用vi、vim、sed、echo、cat操作文件
    Comparator::compare设定排序的升序 降序
    Git: tag管理
    计算机毕业设计springboot交互式大学英语学习平台g9223源码+系统+程序+lw文档+部署
    HTML模板 宽屏大气的企业官网网站模板
    哪款蓝牙耳机音质好？2022年学生党蓝牙耳机推荐
    C语言练习---【求素数】（一篇带你掌握素数求解）
  • 原文地址：https://blog.csdn.net/qq_51409098/article/details/127766052