【Spring MVC 数据绑定与验证】优雅处理请求数据

在 Web 开发中，从接收用户请求到处理数据，再到确保数据的安全和准确性，数据绑定和验证是两大核心步骤。Spring MVC 提供了强大的 数据绑定 和 验证机制，帮助开发者高效、安全地管理请求参数。

1. 数据绑定：自动映射请求参数到 Java 对象

Spring MVC 的数据绑定机制能够自动将请求中的参数映射到方法参数或 Java 对象的字段中，极大地减少了手动解析参数的工作量。

1.1 自动数据绑定

Spring MVC 会根据请求参数的名称，将数据绑定到 Java 对象的对应字段。例如：

请求参数：

<form action="/register" method="post">
    <input name="name" value="Alice"/>
    <input name="age" value="25"/>
    <button type="submit">Register</button>
</form>

实体类：

public class User {
    private String name;
    private int age;
    // Getters and Setters
}

控制器方法：

@PostMapping("/register")
public String registerUser(@ModelAttribute User user) {
    System.out.println("Name: " + user.getName());
    System.out.println("Age: " + user.getAge());
    return "success";
}

当用户提交表单时，name 和 age 会自动映射到 User 对象中。

1.2 使用 @ModelAttribute

@ModelAttribute 是 Spring MVC 的核心注解，用于将请求参数绑定到对象，并可用于向模型中添加默认数据。

示例：

@PostMapping("/register")
public String registerUser(@ModelAttribute User user) {
    return "success";
}

@ModelAttribute 的特点：

• 适用于表单提交或 URL 查询参数。
• 能够将请求参数直接绑定到对象。
• 结合实体类的字段名自动映射。

1.3 使用 @RequestBody

@RequestBody 是 Spring MVC 中另一个常用注解，它专注于将请求体中的数据（通常是 JSON 或 XML 格式）直接绑定到 Java 对象上，非常适合用于 RESTful API 的开发。

示例：

假设前端通过 JSON 数据发送用户注册信息：

请求体：

{
  "name": "Alice",
  "age": 25
}

控制器代码：

@PostMapping("/register")
public String registerUser(@RequestBody User user) {
    System.out.println("Name: " + user.getName());
    System.out.println("Age: " + user.getAge());
    return "success";
}

特点：

• 专注于请求体数据的绑定，适用于 JSON、XML 等格式。
• 自动反序列化数据为 Java 对象，通常需要前端设置 Content-Type: application/json。
• 结合 @Valid 注解，可以直接对请求体数据进行校验。

适用场景：

• 前后端分离开发时，接收前端发送的 JSON 格式数据。
• RESTful API 的开发场景。

与 @ModelAttribute 相比，@RequestBody 更适用于接收复杂的请求体数据，而不是表单或 URL 查询参数。

2. 数据验证：确保数据的安全性和正确性

有了数据绑定，我们还需要验证数据是否符合业务需求，例如：

• 必填字段是否为空？
• 数值是否在合法范围内？
• 格式是否符合要求？

Spring MVC 提供了一整套数据验证机制，基于注解的校验方式是最常用的。

2.1 基础校验注解

Spring MVC 的校验注解依赖 Bean Validation（如 Hibernate Validator），以下是常用的校验注解：

2.2 使用 @Valid 和 BindingResult

Spring MVC 提供了 @Valid 注解，用于触发实体类中的校验规则，并通过 BindingResult 捕获校验结果。

示例代码：

import jakarta.validation.constraints.*;

public class User {
    @NotBlank(message = "Name cannot be blank")
    private String name;

    @Email(message = "Invalid email address")
    private String email;

    @Min(value = 18, message = "Age must be at least 18")
    private int age;

    // Getters and Setters
}

控制器方法：

@PostMapping("/register")
public String registerUser(@Valid @ModelAttribute User user, BindingResult result) {
    if (result.hasErrors()) {
        result.getAllErrors().forEach(error -> {
            System.out.println(error.getDefaultMessage());
        });
        return "error"; // 返回错误视图
    }
    return "success"; // 返回成功视图
}

请求数据：

name=
email=invalid-email
age=17

校验结果：

Name cannot be blank
Invalid email address
Age must be at least 18

2.3 自定义校验规则

如果内置的注解无法满足需求，可以通过自定义注解实现特殊校验逻辑。

示例：用户名不能包含特殊字符

1、定义注解：

@Target({FIELD})
@Retention(RUNTIME)
@Constraint(validatedBy = UsernameValidator.class)
public @interface ValidUsername {
    String message() default "Invalid username";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

2、实现校验逻辑：

public class UsernameValidator implements ConstraintValidator<ValidUsername, String> {

    private static final String USERNAME_PATTERN = "^[a-zA-Z0-9]+$";

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        return value != null && value.matches(USERNAME_PATTERN);
    }
}

3、使用注解：

public class User {
    @ValidUsername
    private String username;

    @Min(18)
    private int age;

    // Getters and Setters
}

如果提交 username=Alice!，校验会失败，返回错误信息 Invalid username。

3. 综合示例：数据绑定与验证结合

完整示例展示如何结合数据绑定和验证机制处理用户提交数据：

@Controller
@RequestMapping("/user")
public class UserController {

    @PostMapping("/register")
    public String registerUser(@Valid @ModelAttribute User user, BindingResult result, Model model) {
        if (result.hasErrors()) {
            model.addAttribute("errors", result.getAllErrors());
            return "error";
        }
        model.addAttribute("user", user);
        return "success";
    }
}

4. 总结：轻松优雅的请求数据处理

1. 数据绑定：通过 @ModelAttribute、@RequestBody自动将请求参数映射到对象中，减少了繁琐的解析代码。
2. 数据验证：结合 @Valid 和内置校验注解（如 @NotBlank、@Email），轻松实现数据校验逻辑。
3. 扩展能力：支持自定义校验规则，满足复杂的业务需求。