使用 @Validated 注解优雅完成 Java 分组校验

2023-12-18 16:12:25

引言

在软件开发过程中，我们经常会遇到这样的场景：一个接口需要处理多种不同的请求，而这些请求可能具有不同的参数校验规则。如果我们对每个请求单独进行校验，代码就会变得冗长且难以维护。为了解决这个问题，Java 中引入了分组校验的概念。

分组校验允许我们根据不同的场景或用途，将参数校验规则划分为不同的组。在处理请求时，我们可以根据需要选择相应的校验组，从而只对需要校验的参数进行校验。这不仅可以提高代码的可读性和可维护性，还可以确保请求参数的准确性和一致性。

@Validated 注解的用法

在 Java 中，可以使用 @Validated 注解来实现分组校验。该注解可以应用于方法或类上，以指示需要对该方法或类的参数进行校验。在使用 @Validated 注解时，我们需要指定要使用的校验组。

以下是一个使用 @Validated 注解的示例：

import javax.validation.Valid;
import javax.validation.groups.Default;

public class UserController {

    @PostMapping("/user")
    public User createUser(@Valid @RequestBody User user, BindingResult bindingResult) {
        if (bindingResult.hasErrors()) {
            throw new ValidationException(bindingResult.getAllErrors());
        }

        return userService.createUser(user);
    }

}

在这个示例中，我们使用 @Validated 注解来对 createUser 方法的参数 user 进行校验。在 @Validated 注解中，我们指定了要使用的校验组为 Default.class。这意味着，在对 user 参数进行校验时，将使用默认的校验规则。

自定义校验组

除了使用默认的校验组之外，我们还可以自定义校验组。自定义校验组允许我们根据自己的需求定义不同的校验规则。

以下是一个自定义校验组的示例：

public interface CreateUser {
}

public interface UpdateUser {
}

在这个示例中，我们定义了两个自定义校验组：CreateUser 和 UpdateUser。CreateUser 组用于对创建用户请求的参数进行校验，而 UpdateUser 组用于对更新用户请求的参数进行校验。

在使用自定义校验组时，我们需要在 @Validated 注解中指定要使用的校验组。以下是一个使用自定义校验组的示例：

@PostMapping("/user")
public User createUser(@Valid @RequestBody User user, BindingResult bindingResult, @Validated(CreateUser.class) User userDetail) {
    if (bindingResult.hasErrors()) {
        throw new ValidationException(bindingResult.getAllErrors());
    }

    return userService.createUser(user);
}