Spring Boot：使用 @Validated 注解进行请求参数校验

2023-09-30 02:05:21

用 @Validated 在 Spring Boot 中轻松校验请求参数

简介

在 Spring Boot 中，校验请求参数至关重要，可以防止无效数据进入你的应用程序并导致问题。使用 @Validated 注解，你可以轻松对请求参数进行校验，确保它们符合预期的格式和约束条件。

使用 @Validated 注解校验请求参数

基本用法

@PostMapping("/users")
public User createUser(@Validated @RequestBody User user) {
    return userService.createUser(user);
}

在这里，@Validated 注解应用于控制器方法 createUser() 的请求参数 user 上。这表明框架会在处理请求之前校验 user 对象，以确保其符合预期的约束。

校验组

你可以使用校验组来控制要执行哪些校验规则。只需创建一个接口，定义要执行的规则，并将其作为 @Validated 注解的参数：

public interface UserCreateGroup {
}

@PostMapping("/users")
public User createUser(@Validated(UserCreateGroup.class) @RequestBody User user) {
    return userService.createUser(user);
}

这将只执行 UserCreateGroup 校验组中定义的规则。

手动校验请求参数

除了使用 @Validated 注解，你还可以手动校验请求参数：

@PostMapping("/users")
public User createUser(@RequestBody User user) {
    if (user.getName() == null || user.getName().isEmpty()) {
        throw new IllegalArgumentException("Name is required");
    }

    if (user.getEmail() == null || user.getEmail().isEmpty()) {
        throw new IllegalArgumentException("Email is required");
    }

    return userService.createUser(user);
}

自定义校验器

对于特定需求，你可以创建自己的自定义校验器：

public class CustomEmailValidator implements ConstraintValidator<Email, String> {

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        return value != null && value.matches("[^@]+@[^@]+\\..+");
    }
}