📖Mosquito's Note📖

SpringMVC 获取请求参数

通过 servletAPI 获取

将 HttpServletRequest 作为控制器方法的形参，此时 HttpServletRequest 类型的参数表示封装了当前请求的请求报文的对象

@Controller
public class HelloController {
    @RequestMapping("/testParams")
    public String test(HttpServletRequest request){
        String user = request.getParameter("user");
        String passwd = request.getParameter("passwd");
        System.out.println("user:"+user+", passwd:"+passwd);
        return "success";
    }
}

通过控制器方法的形参获取请求参数

在控制器方法的形参位置，设置和请求参数同名的形参，当浏览器发送请求，匹配到请求映射时，在 DispatcherServlet 中就会将请求参数赋值给相应的形参

@Controller
public class HelloController {
    @RequestMapping("/testParams")
    public String test(String user, String passwd){
        System.out.println("user:"+user+", passwd:"+passwd);
        return "success";
    }
}

TIP

若请求所传输的请求参数中有多个同名的请求参数，此时可以在控制器方法的形参中设置字符串数组或者字符串类型的形参接收此请求参数

  • 若使用字符串数组类型的形参，此参数的数组中包含了每一个数据
  • 若使用字符串类型的形参，此参数的值为每个数据中间使用逗号拼接的结果

@RequestParam

  • @RequestParam是将请求参数和控制器方法的形参创建映射关系
  • @RequestParam注解一共有三个属性：
    • value: 指定为形参赋值的请求参数的参数名
    • required: 设置是否必须此请求参数，默认值为true

若required设置为 true 时，则当前请求必须传输 value 所指定的请求参数，若没有传输该请求参数，且没有设置defaultValue属性，则页面报错400: Required String parameter 'xxx' is not present;若设置为 false，则当前请求不是必须传输 value 所指定的请求参数，若没有传输，则注解所标识的形参的值为 null

defaultValue: 不管 required 属性值为 true 或 false，当 value 所指定的请求参数没有传输或传输的值为空时，则使用默认值为形参赋值

@RequestHeader

  • @RequestHeader是将请求头信息和控制器方法的形参创建映射关系
  • @RequestHeader注解一共有三个属性：
    • value
    • required
    • defaultValue

用法同@RequestParam

CookieValue

  • @CookieValue是将 cookie 数据和控制器方法的形参创建映射关系
  • @CookieValue注解一共有三个属性：
    • value
    • required
    • defaultValue

用法同@RequestParam

通过 POJO 获取请求参数

可以在控制器方法的形参位置设置一个实体类类型的形参，此时若浏览器传输的请求参数的参数名和实体类中的属性名一致，那么请求参数就会为此属性赋值

<!-- index.html -->
<form th:action="@{/testPojo}" method="post">
    name:<input type="text" name="user"><br>
    passwd:<input type="text" name="passwd">
    <input type="submit" value="submit!">
</form>

//controller.java
@Controller
public class HelloController {
    @RequestMapping("/testPojo")
    public String test(User user){
        System.out.println(user.toString());
        return "success";
    }
}

DANGER

在 SpringBoot 中，若不是表单提交的参数，不在 pojo 类前标@RequestBody无法获取参数（也不知道是哪一版更新，或者原来就是这样）

即：String test(@RequestBody User user) 参考 Restful 中的 @RequestBody

解决获取请求参数的乱码问题

解决获取请求参数的乱码问题，可以使用 SpringMVC 提供的编码过滤器CharacterEncodingFilter，但是必须在 web.xml 中进行注册

<filter>
    <filter-name>CharacterEncodingFilter</filter-name>
    <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
    <init-param>
        <param-name>encoding</param-name>
        <param-value>UTF-8</param-value>
    </init-param>
    <init-param>
        <param-name>forceResponseEncoding</param-name>
        <param-value>true</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>CharacterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>