Spring MVC 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，默认情况下的实现及能处理的参数见下图。

回答

因此具体到 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，相关解析代码如下。

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，相关代码如下。

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，相关源码如下。

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

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

可以看到，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 作为实现，这样可以保证参数有序，兼容了程序获取指定索引位置参数的情况。