SpringBoot注解对实体类中的属性进行校验

2024-01-13 09:19:45

1. Spring Boot中常用的校验注解

SpringBoot中提供了多种常用的校验注解，可以对实体类中的属性进行不同的校验，这些注解主要包括：

@NotNull：检查属性是否不为null。
@NotBlank：检查属性是否不为null且不为空字符串。
@NotEmpty：检查属性是否不为null且不为空集合。
@Size：检查属性的长度或大小是否在指定的范围内。
@Email：检查属性是否符合电子邮件地址的格式。
@Pattern：检查属性是否符合指定的正则表达式。
@DecimalMin：检查属性是否大于或等于指定的最小值。
@DecimalMax：检查属性是否小于或等于指定的最大值。
@Min：检查属性是否大于或等于指定的最小值。
@Max：检查属性是否小于或等于指定的最大值。
@AssertTrue：检查属性是否为true。
@AssertFalse：检查属性是否为false。

2. 自定义校验注解

除了使用SpringBoot提供的常用校验注解之外，我们还可以自定义校验注解，以满足更复杂的校验需求。自定义校验注解需要继承自javax.validation.ConstraintValidator接口，并实现isValid()方法。isValid()方法中可以编写自定义的校验逻辑，并返回校验结果。

3. 处理校验结果和异常信息

在使用注解对实体类中的属性进行校验后，我们需要处理校验结果和异常信息。我们可以使用Spring Boot提供的@Validated注解来处理校验结果，@Validated注解可以应用于方法或类上，当使用@Validated注解时，Spring Boot会自动对方法或类中的参数或属性进行校验，并抛出异常。

4. Spring Boot中注解对实体类中的属性进行校验的示例

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

public class User {

    @NotNull
    private String username;

    @Size(min = 6, max = 16)
    private String password;

    // 省略其他属性和方法
}

在上面的示例中，我们使用@NotNull注解来校验username属性是否不为null，使用@Size注解来校验password属性的长度是否在6到16之间。当我们使用@Validated注解对User类进行校验时，Spring Boot会自动对username和password属性进行校验，如果校验失败，Spring Boot会抛出异常。