SpringMVC实现获取请求参数方法详解-Java开发

SpringMVC是Spring提供的一个基于MVC设计模式的轻量级Web开发框架，本质上相当于Servlet，SpringMVC角色划分清晰，分工明细，这篇文章主要介绍了SpringMVC实现获取请求参数方法

1、通过ServletAPI获取

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

<a th:href="@{/testServletAPI(username='admin',password=123456)}" rel="external nofollow" >测试使用testServletAPI获取请求参数</a>

    @RequestMapping("/testServletAPI")
    //形参位置的request就表示当前请求
    public String testServletAPI(HttpServletRequest request){
        String username = request.getParameter("username");
        String password = request.getParameter("password");
        System.out.println("username:"+username+",password:"+password);
        return "success";
    }

输出：username:admin,password:123456

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

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

常见：

<a th:href="@{/testParam(username='admin',password=123456)}" rel="external nofollow" >测试通过控制器方法的形参获取请求参数</a><br>

    @RequestMapping("/testParam")
    //必须保证形参名和请求传递的参数名一致
    public String testParam(String username, String password){
        System.out.println("username:"+username+",password:"+password);
        return "success";
    }

有多个同名参数（例如复选框）:

<form th:action="@{/testParam}" method="get">
    用户名：<input type="text" name="username"><br>
    密码：<input type="password" name="password"><br>
    爱好：<input type="checkbox" name="hobby" value="a">a
        <input type="checkbox" name="hobby" value="b">b
        <input type="checkbox" name="hobby" value="c">c<br>
    <input type="submit" value="测试通过控制器方法的形参获取多个同名请求参数">
</form>

    @RequestMapping("/testParam")
    //必须保证形参名和请求传递的参数名一致
    public String testParam(String username, String password,String hobby){
        System.out.println("username:"+username+",password:"+password+",hobby:"+hobby);
        return "success";
    }

    @RequestMapping("/testParam")
    //必须保证形参名和请求传递的参数名一致
    public String testParam(String username, String password,String[] hobby){
        System.out.println("username:"+username+",password:"+password+",hobby:"+ Arrays.toString(hobby));
        return "success";
    }

注：

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

若使用字符串数组类型的形参，此参数的数组中包含了每一个数据：hobby:[a, b]

若使用字符串类型的形参，此参数的值为每个数据中间使用逗号拼接的结果：hobby:a,b

3、@RequestParam

@RequestParam是将请求参数和控制器方法的形参创建映射关系

    @RequestMapping("/testParam")
    //当形参名和请求参数名不一致时，通过注解@RequestParam绑定形参和请求参数
    public String testParam(
            @RequestParam("username") String user_name,
            String password,
            String[] hobby){
        System.out.println("user_name:"+user_name+",password:"+password+",hobby:"+ Arrays.toString(hobby));
        return "success";
    }

输出：user_name:admin,password:123456,hobby:[a, b, c]

@RequestParam注解一共有三个属性：

value：指定为形参赋值的请求参数的参数名

required：设置是否必须传输此请求参数，默认值为true

若设置为true时，则当前请求必须传输value所指定的请求参数，若没有传输该请求参数，且没有设置defaultValue属性，则页面报错400：Required String parameter 'xxx' is not present；

若设置为false，则当前请求不是必须传输value所指定的请求参数，若没有传输，则注解所标识的形参的值为null

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

4、@RequestHeader

@RequestHeader是将请求头信息和控制器方法的形参创建映射关系

    @RequestMapping("/testParam")
    //当形参名和请求参数名不一致时，通过注解@RequestParam绑定形参和请求参数
    public String testParam(
            @RequestParam("username") String user_name,
            String password,
            String[] hobby,
            //通过注解@RequestHeader将请求头信息和控制器方法的形参创建映射关系
            @RequestHeader("Host") String host){
        System.out.println("user_name:"+user_name+",password:"+password+",hobby:"+ Arrays.toString(hobby));
        System.out.println("host:"+host);
        return "success";
    }

输出：

user_name:admin,password:123456,hobby:[a, b, c]

host:localhost:8080

@RequestHeader注解一共有三个属性：value、required、defaultValue，用法同@RequestParam

5、@CookieValue

@CookieValue是将cookie数据和控制器方法的形参创建映射关系

    @RequestMapping("/testParam")
    //当形参名和请求参数名不一致时，通过注解@RequestParam绑定形参和请求参数
    public String testParam(
            @RequestParam("username") String user_name,
            String password,
            String[] hobby,
            //通过注解@RequestHeader将请求头信息和控制器方法的形参创建映射关系
            @RequestHeader("Host") String host,
            //通过注解@CookieValue将cookie数据和控制器方法的形参创建映射关系
            @CookieValue("JSESSIONID") String JSESSIONID){
        System.out.println("user_name:"+user_name+",password:"+password+",hobby:"+ Arrays.toString(hobby));
        System.out.println("host:"+host);
        System.out.println("JSESSIONID:"+JSESSIONID);
        return "success";
    }

输出：

user_name:admin,password:123456,hobby:[a, b, c]

host:localhost:8080 JSESSIONID:005A829F9D7222CEA96E9EF6F86B8F58

@CookieValue注解一共有三个属性：value、required、defaultValue，用法同@RequestParam

6、通过POJO获取请求参数

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

public class User {
    private Integer id;
    private String username;
    private String password;
    private Integer age;
    private String sex;
    private String email;
    public User() {
    }
    public User(Integer id, String username, String password, Integer age, String sex, String email) {
        this.id = id;
        this.username = username;
        this.password = password;
        this.age = age;
        this.sex = sex;
        this.email = email;
    }
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }
    public String getSex() {
        return sex;
    }
    public void setSex(String sex) {
        this.sex = sex;
    }
    public String getEmail() {
        return email;
    }
    public void setEmail(String email) {
        this.email = email;
    }
    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", username='" + username + '\'' +
                ", password='" + password + '\'' +
                ", age=" + age +
                ", sex='" + sex + '\'' +
                ", email='" + email + '\'' +
                '}';
    }
}

<form th:action="@{/testPojo}" method="get">
    用户名：<input type="text" name="username"><br>
    密码：<input type="password" name="password"><br>
    性别：<input type="radio" name="sex" value="男">男<input type="radio" name="sex" value="女">女<br>
    年龄：<input type="text" name="age"><br>
    邮箱：<input type="text" name="email"><br>
    <input type="submit" value="测试通过POJO获取请求参数">
</form>

    @RequestMapping("/testPojo")
    public String testPOJO(User user){
        System.out.println(user);
        return "success";
    }

输出：User{id=null, username='admin', password='123', age=22, sex='男', email='125jugyg@163.com'}

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

上述通过POJO获取请求参数时，如果使用get方式不会乱码（Tomcat8以上已经解决了get乱码问题），但是使用post方式获取时还是会乱码

<form th:action="@{/testPojo}" method="post">
    用户名：<input type="text" name="username"><br>
    密码：<input type="password" name="password"><br>
    性别：<input type="radio" name="sex" value="男">男<input type="radio" name="sex" value="女">女<br>
    年龄：<input type="text" name="age"><br>
    邮箱：<input type="text" name="email"><br>
    <input type="submit" value="测试通过POJO获取请求参数">
</form>

输出：

User{id=null, username='admin', password='123', age=22, sex='ç·', email='125jugyg@163.com'}

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

    <!--配置springMVC的编码过滤器-->
    <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>