Spring MVC 教程-@RequestParam用法及原理详解

前面没有详细介绍SpringMVC中各种注解的用法，这里准备一一补上，今天来看@RequestParam注解的用法。

1、预备知识

2、@RequestParam注解的作用

标注在接口的方法参数上，被标注的参数的值来源于request.getParameter或request.getParameterValues。

推荐阅读 ：2021 最新版 Java 微服务学习线路图 + 视频

3、@RequestParam源码

    @Target(ElementType.PARAMETER)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface RequestParam {
    
    	/**
    	 * 对应request中参数名称
    	 */
    	@AliasFor("name")
    	String value() default "";
    
    	/**
    	 * 同value
    	 */
    	@AliasFor("value")
    	String name() default "";
    
    	/**
    	 * 请求中是否必须有这个参数，默认为true
    	 */
    	boolean required() default true;
    
    	/**
    	 * 默认值
    	 */
    	String defaultValue() default ValueConstants.DEFAULT_NONE;
    
    }

4、案例1：@RequestParam指定name，获取对应参数的值

4.1、案例接口代码

    /**
     * {@link RequestParam}中指定name，用来取name的值对应的请求参数中的值
     *
     * @param name：可以不传递name参数，不传递的时候默认值为ready
     * @param age
     * @param pets
     * @return
     */
    @RequestMapping("/requestparam/test1")
    public Map<String, Object> test1(@RequestParam(value = "name", required = false, defaultValue = "ready") String name, //相当于request.getParameter("name")
                                     @RequestParam("age") int age, //Integer.parseInt(request.getParameter("age"))
                                     @RequestParam("interests") String[] interests, //request.getParameterValues("pets")
                                     @RequestParam("pets") List<String> pets //Arrays.asList(request.getParameterValues("pets"))
    ) {
        Map<String, Object> result = new LinkedHashMap<>();
        result.put("name", name);
        result.put("age", age);
        result.put("interests", interests);
        result.put("pets", pets);
        return result;
    }

4.2、用例1：所有参数都传值

    POST http://localhost:8080/chat18/requestparam/test1
    Content-Type: application/x-www-form-urlencoded
    
    name=路人&age=35&interests=篮球&interests=旅游&pets=小狗&pets=小猫

运行上面用例代码输出

    {
      "name": "路人",
      "age": 35,
      "interests": [
        "篮球",
        "旅游"
      ],
      "pets": [
        "小狗",
        "小猫"
      ]
    }

4.3、用例2：name不传递，会取默认值ready

    POST http://localhost:8080/chat18/requestparam/test1
    Content-Type: application/x-www-form-urlencoded
    
    age=35&interests=篮球&interests=旅游&pets=小狗&pets=小猫

运行上面用例代码输出

    {
      "name": "ready",
      "age": 35,
      "interests": [
        "篮球",
        "旅游"
      ],
      "pets": [
        "小狗",
        "小猫"
      ]
    }

4.4、用来3：required属性为true，不传，则报错

    POST http://localhost:8080/chat18/requestparam/test1
    Content-Type: application/x-www-form-urlencoded

参数都没有传递，而接口要求除name之外的，其他几个参数都必须传递，所以这个案例结果会报400错，提示age参数不存在，这个错误比较常见，大家熟悉下，以后看到了就知道什么问题了。

5、案例2：@RequestParam不指定name，获取所有参数值

当我们想用一个Map来接收所有参数的之后，代码如下，@RequestParam不用指定name的值，参数类型为Map<String,String>，所有请求参数会以参数名称:值的方式丢在Map中。

    /**
     * {@link RequestParam}不指定name，用于接收所有参数的值，
     * 参数类型为Map<String,String>,key为请求中的参数名称，value为值
     *
     * @param paramMap
     * @return
     */
    @RequestMapping("/requestparam/test2")
    public Map<String, String> test2(@RequestParam Map<String, String> paramMap) {
        return paramMap;
    }

运行下面的用例调用上面接口

    ###
    POST http://localhost:8080/chat18/requestparam/test2
    Content-Type: application/x-www-form-urlencoded
    
    name=路人&age=35&interests=篮球&interests=旅游&pets=小狗&pets=小猫

运行输出

    {
      "name": "路人",
      "age": "35",
      "interests": "篮球",
      "pets": "小狗"
    }

interests和pet都是有多个值，上面的结果中都只获取了第一个值，如果我们想获取所有的值呢，下面看案例3。

6、案例3：@RequestParam不指定name，获取所有参数值

    /**
     * {@link RequestParam}不指定name，用于接收所有参数的值，
     * 参数类型为MultiValueMap<String, String>：key为请求中的参数名称，value为值的集合List<String>
     *
     * @param paramMap
     * @return
     */
    @RequestMapping(value = "/requestparam/test3", produces = MediaType.APPLICATION_JSON_VALUE)
    public MultiValueMap<String, String> test3(@RequestParam MultiValueMap<String, String> paramMap) {
        return paramMap;
    }

这个接口的参数是MultiValueMap类型，这玩意是干啥的？好像很陌生啊，哈哈

再模式的东西，把其源码放出来，瞬间明了了，如下，可以看出来MultiValueMap相当于Map<String,List<String>>

    public interface MultiValueMap<K, V> extends Map<K, List<V>> {
    }

运行下面的用例调用上面接口，注意下面第3行，表示我们期望服务器端返回json格式数据

    POST http://localhost:8080/chat18/requestparam/test3
    Content-Type: application/x-www-form-urlencoded
    Accept: application/json
    
    name=路人&age=35&interests=篮球&interests=旅游&pets=小狗&pets=小猫

运行输出，结果的值比较特别，是一个String类型的数组，这次获取到所有参数的值了。

    {
      "name": [
        "路人"
      ],
      "age": [
        "35"
      ],
      "interests": [
        "篮球",
        "旅游"
      ],
      "pets": [
        "小狗",
        "小猫"
      ]
    }

7、@RequestParam原理

@RequestParam标注的参数的值是有下面2个类处理的，有兴趣了解的建议先看一下上一篇中的：参数解析器HandlerMethodArgumentResolver解密，然后再来看下面2个类的源码就是小意思了。

    org.springframework.web.method.annotation.RequestParamMethodArgumentResolver
    org.springframework.web.method.annotation.RequestParamMapMethodArgumentResolver

8、总结

@RequestParam注解用来标注在控制器方法的参数上，springmvc从request中获取请求的值赋值给方法的参数
@RequestParam指定name时，可以获取request中指定参数的值，相当于request.getParameter(name)或request.getParameters(name)
@RequestParam未指定name，参数类型为：Map<String,String>时，用来接收request中所有参数的值，Map中key为参数名称，value为参数的值
@RequestParam未指定name，参数类型为MultiValueMap<String, String>时，用来接收request中所有参数的值，key为请求中的参数名称，value为值的集合List
推荐阅读 ：尚硅谷 Java 学科全套教程（总 207.77GB）

9、代码位置及说明

9.1、git地址

    https://gitee.com/javacode2018/springmvc-series

9.2、本文案例代码结构说明

阅读全文