请求参数的绑定

# 40.请求参数的绑定

接下来我们讲讲如何绑定请求参数，这是非常重要的一个内容。

# 绑定机制

作为一个 web 框架，是一定能获取到前端传过来的参数，那么拿到的过程就叫参数绑定。机制如下：

表单提交的数据都是 k = v 格式的，例如： username = haha&password = 123
SpringMVC 的参数绑定过程是把表单提交的请求参数，作为控制器中方法的参数进行绑定的
要求：提交表单的 name 和参数的名称是相同的

原理：通过反射方法的属性，然后赋值给方法的参数。这比起之前我们学习 Servlet 的时候，要在 Servlet 中手动获取参数并处理，方便太多。

支持的数据类型

基本数据类型和字符串类型
实体类型（JavaBean）
集合数据类型（List、Map 集合等） ‍

# 新建控制器

我们先新建一个控制器类

package com.peterjxl.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
@RequestMapping(path = "/param")
public class ParamController {

    @RequestMapping(path = "/testParam")
    public String testParam() {
        System.out.println("testParam");
        return "success";
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14

‍ 然后新建 JSP，用来测试该控制器类能正常访问：在 webapp 目录下新建 param.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
    <head>
        <title>演示参数绑定</title>
    </head>
    <body>
        <h1>演示参数绑定</h1>
        <a href="param/testParam">请求参数绑定</a>
    </body>
</html>

1
2
3
4
5
6
7
8
9
10

‍ 重启，访问 http://localhost: 8080/param/testParam (opens new window) 并点击超链接，可以看到能正常跳转，并且控制台有输出 testParam

‍

# 绑定基本类型的参数

我们在前端页面，传递一个参数：

<a href="param/testParam?username=peterjxl">请求参数绑定</a>

并且在控制器的方法上也加上，然后输出：

@RequestMapping(path = "/testParam")
public String testParam(String username) {
    System.out.println("testParam");
    System.out.println("username: " + username);
    return "success";
}

1
2
3
4
5
6

‍ 我们重启，并点击超链接，可以看到控制台有正常输出。

也可以传递多个参数，例如：

 <a href="param/testParam?username=peterjxl&password=123">请求参数绑定</a>

‍ 控制器也加上：

@RequestMapping(path = "/testParam")
public String testParam(String username, String password) {
    System.out.println("testParam");
    System.out.println("username: " + username);
    System.out.println("password: " + password);
    return "success";
}

1
2
3
4
5
6
7

# 绑定实体类型的参数

当我们的参数很多之后，逐个传参并处理有点麻烦，我们可以将参数封装到一个 JavaBean 对象中。 ‍

# 新建 JavaBean

package com.peterjxl.domain;
import java.io.Serializable;
public class Account implements Serializable {
  
    private String username;
    private String password;
    private Double money;
}

1
2
3
4
5
6
7
8

请自行生成 setter、getter 和 toString 方法 ‍

# 新建表单

然后我们在 param.jsp 中新建一个表单：注意参数名字要和 Account 中的一样

<form action="param/saveAccount" method="post">
    姓名：<input type="text" name="username" /> <br/>
    密码：<input type="text" name="password" /> <br/>
    金额：<input type="text" name="money" /> <br/>
    <input type="submit" value="提交" />
</form>

1
2
3
4
5
6

# 新增处理器方法

在 ParamController 中新建方法：

@RequestMapping(path = "/saveAccount")
public String saveAccount(Account account) {
    System.out.println("saveAccount");
    System.out.println(account);
    return "success";
}

1
2
3
4
5
6

‍

# 测试

然后我们重启，访问 http://localhost: 8080/param.jsp，填写和提交表单：

‍

后台输出结果：

Account{username='peterjxl', password='123', money=666.0}

‍ 注意：类型不能错。例如金额是数字类型，如果前端传了个英文字母，是会报错的

# 如果 JavaBean 中有引用类型

如果一个 JavaBean 类中包含其他的引用类型，那么表单的 name 属性需要编写成 对象.属性，例如 address.name ‍ 我们新建一个实体类 User：

package com.peterjxl.domain;
import java.io.Serializable;
public class User implements Serializable {

    private String uname;
    private Integer age;
}

1
2
3
4
5
6
7

同理，生成 getter、setter 和 toString 方法。

修改 Account 类型，添加 User 类型的成员变量、setter 和 getter 方法，并在 toString 方法里也打印下 user 类型：

public class Account implements Serializable {
    private String username;
    private String password;
    private Double money;
    private User user;
}

1
2
3
4
5
6

我们新增一个表单：

<form action="param/saveAccount2" method="post">
    姓名：<input type="text" name="username" /> <br/>
    密码：<input type="text" name="password" /> <br/>
    金额：<input type="text" name="money" /> <br/>
    用户姓名：<input type="text" name="user.uname" /> <br/>
    用户年龄：<input type="text" name="user.age" /> <br/>
    <input type="submit" value="提交" />
</form>

1
2
3
4
5
6
7
8

新增控制器方法：

@RequestMapping(path = "/saveAccount2")
public String saveAccount2(Account account) {
    System.out.println("saveAccount");
    System.out.println(account);
    return "success";
}

1
2
3
4
5
6

‍ 运行结果：

‍

输出：

Account{username='peterjxl', password='123456', money=666.0, user=User{uname='ppp', age=66}}

# 绑定集合类型

我们在 Account 类型中添加如下成员变量，并生成对应的 setter、getter，在 toString 中打印这两个对象：

    private List<User> list;
    private Map<String, User> map;

1
2

我们新增一个表单：

<form action="param/saveAccount3" method="post">
    姓名：<input type="text" name="username" /> <br/>
    密码：<input type="text" name="password" /> <br/>
    金额：<input type="text" name="money" /> <br/>
    用户姓名：<input type="text" name="user.uname" /> <br/>
    用户年龄：<input type="text" name="user.age" /> <br/>

    list用户姓名：<input type="text" name="list[0].uname" /> <br/>
    list用户年龄：<input type="text" name="list[0].age" /> <br/>

    map用户姓名：<input type="text" name="map['one'].uname" /> <br/>
    map用户年龄：<input type="text" name="map['one'].age" /> <br/>
    <input type="submit" value="提交" />
</form>

1
2
3
4
5
6
7
8
9
10
11
12
13
14

‍

新增控制器方法：

@RequestMapping(path = "/saveAccount3")
public String saveAccount3(Account account) {
    System.out.println("saveAccount");
    System.out.println(account);
    return "success";
}

1
2
3
4
5
6

‍ 我们重启并测试：

‍

输出：

Account{username='ppp', password='ppp', money=111.0, user=User{uname='ppp', age=111}, list=[User{uname='listname', age=111}], map={one=User{uname='mapname', age=222}}}

# 中文问题

如果我们提交的表单内容中，有中文，那么获取到的会是乱码，这是因为编码问题。get 方式不会，post 方式会有该问题；例如我们随便填一个中文用户名：

Account{username='è??é??', password='123456', money=666.0, user=User{uname='ppp', age=66}}

我们之前学习 Servlet 的时候，都是在方法里，用 request 对象设置下编码；

但如果每个方法都这样设置，比较麻烦，SpringMVC 提供了一个过滤器，通过它来解决乱码问题。我们在 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>
</filter>

<filter-mapping>
    <filter-name>CharacterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

1
2
3
4
5
6
7
8
9
10
11
12
13
14

‍ 注意，最好将 filter 放在前端控制器之前定义，因为 XML 的约束是这样的。我们重启并测试，此时就没有中文乱码问题了

# 总结

本文我们演示了如何绑定数据，有基本类型，引用类型和集合类型。

特别注意：类型不能错。例如金额是数字类型，如果前端传了个英文字母，是会报错的 ‍ 本项目已将源码上传到 GitHub (opens new window) 和 Gitee (opens new window) 上。并且创建了分支 demo3，读者可以通过切换分支来查看本文的示例代码。

上次更新: 2025/5/17 12:26:09

← RequestMapping 注解的作用自定义类型转换器→