一文读懂Java参数校验之@Valid与@Validated的奥秘

后端

2023-02-05 16:16:58

参数校验：使用 @Valid 和 @Validated 注解提升 Java 代码质量

复杂数据模型带来的挑战

在开发 Java 应用程序时，处理复杂数据模型时经常遇到一个常见的痛点：参数校验。逐层校验每个参数会产生冗长的代码，难以维护，降低开发效率。

@Valid 和 @Validated 注解的登场

Java 中引入了 @Valid 和 @Validated 注解，为参数校验提供了简洁、高效的解决方案。这些注解可以自动根据参数类型执行校验，大大简化代码并提高可读性。

深入理解 @Valid 和 @Validated

1. @Valid：参数校验的得力助手

@Valid 注解是参数校验的可靠助手。只需在参数前面添加 @Valid，框架就会根据参数类型进行自动校验，如检查字符串是否为空、不超过最大长度等。

2. @Validated：分组校验，条理分明

@Validated 注解支持分组校验，可将参数划分为不同的校验组。通过指定不同的校验组，针对不同需求执行不同的校验操作，让代码组织更清晰。

3. 嵌套校验，层层递进

@Valid 和 @Validated 注解的另一个强大功能是嵌套校验。嵌套校验允许在一个参数中嵌套其他参数，并对嵌套参数进行校验。这对于处理复杂数据结构非常有用。

实战演练：代码示例

public class User {

    @Valid
    private String username;

    @Valid
    @Validated(groups = {BasicInfoGroup.class})
    private Address address;
}

public class Address {

    @NotBlank
    private String street;

    @NotBlank
    private String city;
}

public class UserController {

    @PostMapping("/user")
    public void createUser(@RequestBody @Valid User user) {
        // 参数校验通过后，即可进行业务操作
        // ...
    }
}