Spring MVC Controller 方法参数 Map 的实现类是什么?

本文涉及的产品
全局流量管理 GTM,标准版 1个月
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
云解析 DNS,旗舰版 1个月
简介: 问题题主问题描述如下:在SpringBoot中,Controller的参数中有Map接口类型的,请问他的实现类是什么?突发奇想,在SpringBoot中,Controller的参数中有Map接口类型的

问题


题主问题描述如下:

在SpringBoot中,Controller的参数中有Map接口类型的,请问他的实现类是什么?

突发奇想,在SpringBoot中,Controller的参数中有Map接口类型的

    @GetMapping("/common")
    public HttpResult testCommonGet(Map<String,String> map){
        return  HttpResult.success("common测试get");
    }


像这里的map,声明是Map接口,那他的实现类是什么?

如果改为HashMap类型,有什么优缺点吗?


分析


题主提到 SpringBoot 中的 Controller 参数,可以推测题主在学习 Spring 框架时跳过了 Spring MVC 直接上手的 Spring Boot。自从 Spring Boot 框架推出之后,确实简化了 Spring 的使用,这也让很多人忽略了框架底层的实现。


Spring Boot 基于 Spring Framework,Spring MVC 正是 Spring Framework 框架中的其中一个模块。Controller 并非 Spring Boot 的专利,要回答题主的问题,还是需要回归到 Spring MVC,Spring MVC 环境已经支持了 Controller 方法使用不同的参数类型。


Spring MVC 中的 Controller 方法参数多用来接收请求有关的信息,还有一部分和 MVC 有关,能定义的请求相关参数可以参见《深入理解 Spring MVC Controller —— 请求参数获取》。


对于不同类型参数的解析,Spring MVC 使用的是 HandlerMethodArgumentResolver,默认情况下的实现及能处理的参数见下图。


36.png


回答


因此具体到 Controller 方法的 Map 类型的参数实现,要看 HandlerMethodArgumentResolver 如何解析的,默认情况下解析 Map 类型的 HandlerMethodArgumentResolver 主要分下面几种情况。


1. 携带指定了 name 的 @RequestParam 注解的 Map 类型


这种情况下的参数由 RequestParamMethodArgumentResolver 进行解析,不过由于默认情况下 Spring 无法将 String 转换为 Map,因此会报错。如果添加了支持 String 到 Map 类型转换服务,则 Map 实现由具体的类型转换服务决定。


{
    "timestamp": "2022-02-13T05:18:01.147+0000",
    "status": 500,
    "error": "Internal Server Error",
    "message": "Failed to convert value of type 'java.lang.String' to required type 'java.util.Map'; nested exception is java.lang.IllegalStateException: Cannot convert value of type 'java.lang.String' to required type 'java.util.Map': no matching editors or conversion strategy found",
    "path": "/test"
}


2. 携带未指定 name 的 @RequestParam 注解的 Map 类型参数


这种情况下的参数由 RequestParamMapMethodArgumentResolver 进行解析,支持的 Map 泛型类型包括 Map、Map、Map,不管哪种泛型类型,Map 参数的实现类型都为 LinkedHashMap,相关解析代码如下。


37.png


3. 携带指定了 name 的 @PathVariable 注解的 Map 类型参数


这种类型的 Map 参数由 PathVariableMethodArgumentResolver 进行解析,由于默认情况下 Spring 无法将路径中的字符串变量转换为 Map,因此同样会报错。如果添加了支持 String 到 Map 类型转换服务,则 Map 实现由具体的类型转换服务决定。


{
    "timestamp": "2022-02-13T05:36:31.518+0000",
    "status": 500,
    "error": "Internal Server Error",
    "message": "Failed to convert value of type 'java.lang.String' to required type 'java.util.Map'; nested exception is java.lang.IllegalStateException: Cannot convert value of type 'java.lang.String' to required type 'java.util.Map': no matching editors or conversion strategy found",
    "path": "/a=1"
}


4. 未携带 name 的 @PathVariable 注解的 Map 类型参数


这种情况下的 Map 参数由 PathVariableMapMethodArgumentResolver 进行解析,Spring 使用的实现同样为 LinkedHashMap,相关代码如下。


38.png


5. 携带指定了 name 的 @MatrixVariable 注解的 Map 类型参数


这种情况的 Map 参数由 PathVariableMapMethodArgumentResolver 进行解析,由于默认情况下 Spring 无法将路径中的字符串变量转换为 Map,因此同样会报错。如果添加了支持 String 到 Map 类型转换服务,则 Map 实现由具体的类型转换服务决定。


{
    "timestamp": "2022-02-14T02:02:53.772+0000",
    "status": 500,
    "error": "Internal Server Error",
    "message": "Failed to convert value of type 'java.lang.String' to required type 'java.util.Map'; nested exception is java.lang.IllegalStateException: Cannot convert value of type 'java.lang.String' to required type 'java.util.Map': no matching editors or conversion strategy found",
    "path": "/aaa/param=1;bbb"
}


6. 未携带 name 的 @MatrixVariable 注解的 Map 类型参数


这种情况下的 Map 参数由 MatrixVariableMapMethodArgumentResolver 解析,这种情况下的 Map 参数实现为 LinkedHashMap,相关源码如下。


39.png


7. 未携带任何注解的 Map 类型


不带注解的 Controller 方法中的 Map 参数被 Spring 认为是 MVC 中的 Model,由 MapMethodProcessor 进行解析,相关代码如下。


40.png


可以看到,Spring 使用的 Map 实现是 ModelAndViewContainer#getModel 方法的返回值,看下这个方法。


public class ModelAndViewContainer {
  private final ModelMap defaultModel = new BindingAwareModelMap();
  public ModelMap getModel() {
    if (useDefaultModel()) {
      // 没有重定向,使用默认 Model
      return this.defaultModel;
    } else {
        // 发生重定向,使用 ModelMap
      if (this.redirectModel == null) {
        this.redirectModel = new ModelMap();
      }
      return this.redirectModel;
    }
  }
  private boolean useDefaultModel() {
    return (!this.redirectModelScenario || (this.redirectModel == null && !this.ignoreDefaultModelOnRedirect));
  }
}


如果没有发生重定向,Spring 使用的 Map 实现是 ModelAndViewContainer 内部的 BindingAwareModelMap 实例;

如果发生了重定向,Spring 使用的 Map 实现是 ModelMap;

BindingAwareModelMap 和 ModelMap 都实现了 LinkedHashMap,这也意味着如果你使用 TreeMap 作为参数,由于类型不匹配将会导致程序报错。


8. 携带 @RequestBody 注解的 Map 参数


带 @RequstBody 注解的 Map 参数由 RequestResponseBodyMethodProcessor 解析,默认情况下交由 MappingJackson2HttpMessageConverter 实例化参数,实例化出来的是 HashMap 类型,这块源码内容较多,可自己尝试分析。


总结

Spring MVC 对于 Map 类型的 Controller 方法参数,多数情况下使用 LinkedHashMap 作为实现,这样可以保证参数有序,兼容了程序获取指定索引位置参数的情况。


目录
打赏
0
1
0
0
11
分享
相关文章
【Spring】方法注解@Bean,配置类扫描路径
@Bean方法注解,如何在同一个类下面定义多个Bean对象,配置扫描路径
185 73
【Spring配置相关】启动类为Current File,如何更改
问题场景:当我们切换类的界面的时候,重新启动的按钮是灰色的,不能使用,并且只有一个Current File 项目,下面介绍两种方法来解决这个问题。
spring mvc Rest风格
spring mvc Rest风格
52 0
Spring高手之路22——AOP切面类的封装与解析
本篇文章深入解析了Spring AOP的工作机制,包括Advisor和TargetSource的构建与作用。通过详尽的源码分析和实际案例,帮助开发者全面理解AOP的核心技术,提升在实际项目中的应用能力。
96 0
Spring高手之路22——AOP切面类的封装与解析
我以为我对Spring MVC很了解,直到我遇到了...
所有人都知道Spring MVC是是开发的,却鲜有人知道Spring MVC的理论基础来自于1978 年提出MVC模式的一个老头子,他就是Trygve Mikkjel Heyerdahl Reenskaug,挪威计算机科学家,名誉教授。Trygve Reenskaug的MVC架构思想早期用于图形用户界面(GUI) 的软件设计,他对MVC是这样解释的。MVC 被认为是解决用户控制大型复杂数据集问题的通用解决方案。最困难的部分是为不同的架构组件想出好的名字。模型-视图-编辑器是第一个。
147 1
我以为我对Spring MVC很了解,直到我遇到了...
|
8月前
|
idea新建spring boot 项目右键无package及java类的选项
idea新建spring boot 项目右键无package及java类的选项
300 5
Spring事务管理嵌套事务详解 : 同一个类中,一个方法调用另外一个有事务的方法
Spring事务管理嵌套事务详解 : 同一个类中,一个方法调用另外一个有事务的方法
566 1
【JavaEE进阶】 关于Spring MVC 响应
【JavaEE进阶】 关于Spring MVC 响应
81 3
【Spring MVC】快速学习使用Spring MVC的注解及三层架构
【Spring MVC】快速学习使用Spring MVC的注解及三层架构
163 1
AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等