Spring Boot 中使用Validator进行数据校验的高效实践

前言

在现代Web开发中，数据校验是确保数据质量、提高应用健壮健性的重要环节。Spring Boot 作为Java开发的热门框架，内置了对数据校验的支持，借助JSR-303 Bean Validation规范，开发者可以轻松实现数据的自动校验。本文将深入探讨Spring Boot中Validator的基本用法，包括配置、注解使用、自定义校验规则等方面，助你打造高效的数据校验机制。

引入pom

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

开箱即用的校验注解

空值检查
@Null：验证对象是否为null
@NotNull：验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank：检查约束字符串是不是Null还有被Trim的长度是否大于0，只对字符串，且会去掉前后空格。
@NotEmpty：检查约束元素是否为NULL或者是EMPTY.
Booelan检查
@AssertTrue：验证 Boolean 对象是否为 true
@AssertFalse：验证 Boolean 对象是否为 false
长度检查
@Size(min=, max=)：验证对象（Array,Collection,Map,String）长度是否在给定的范围之内
日期检查
@Past：验证 Date 和 Calendar 对象是否在当前时间之前
@Future：验证 Date 和 Calendar 对象是否在当前时间之后
@DateTimeFormat(pattern=“yyyy-MM-dd”)：验证日期格式
正则
@Pattern：验证 String 对象是否符合正则表达式的规则
数值检查 建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为“”时无法转换为int，但可以转换为String为"",Integer为null
@Min：验证 Number 和 String 对象是否大等于指定的值
@Max：验证 Number 和 String 对象是否小等于指定的值
@DecimalMax：被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
@DecimalMin：被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
@Digits：验证 Number 和 String 的构成是否合法
@Digits(integer=,fraction=)：验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。
其它注解
@Valid：递归的对关联对象进行校验, 如果关联对象是个集合或者数组，那么对其中的元素进行递归校验，如果是一个map，则对其中的值部分进行校验。(是否进行递归验证)，该注解使用在Action的参数上。
@Email：验证是否是邮件地址，如果为null,不进行验证，算通过验证。

注解截图

使用代码示例

public class User {
    @NotNull(message = "用户名不能为空")
    private String username;
    
    @Size(min = 6, max = 16, message = "密码长度必须在6到16位之间")
    private String password;
    
    // 省略...
}

绑合Controller使用校验

@PostMapping("/register")
public ResponseEntity<?> register(@Valid @RequestBody User user, BindingResult result) {
    if (result.hasErrors()) {
        // 处理错误逻辑，如返回错误信息
        return ResponseEntity.badRequest().body(result.getFieldErrors());
    }
    userService.register(user);
    return ResponseEntity.ok("注册成功");
}

自定义校验注解

1.创建注解

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = EmailValidator.class))
public @interface ValidEmail {
    String message() default "邮箱格式不正确";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

2.创建验证器

public class EmailValidator implements ConstraintValidator<ValidEmail, String> {
    @Override
    public boolean isValid(String email, ConstraintValidatorContext context) {
        return Pattern.matches("^[\\w+([-+.']?\\w+)*@\\w+([-.]?\\w+)*\\.\\w+([-.]? Ace]*\\w+)?$", email);
    }}

3.使用自定义注解

public class User {
    @ValidEmail
    private String email;
    // ...
}

分组校验

Java Bean Validation 支持分组校验，允许在不同场景下应用不同的校验规则。通过在注解中指定组别名，然后在验证时指定验证组别，实现灵活校验逻辑。

1. 定义 Order

Order是一个实体，且在内部定义了分组接口 Add 和 Update。

public class Order {
    // 定义分组标识接口 add 操作
    public interface Add{}
    // 定义分组标识接口 update 操作
    public interface Update{}

    // add 分组
    @Null(groups = Add.class) 
    // update 分组
    @NotNull(message="订单号不能为空", groups = Update.class) 
    private Long id;
	
	@NotNull(message = "用户不能未空")
	private String userName;
	...
 }

2.分组校验工具类

public static void validWithGroup(Object obj, Class... groups) {
    Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
    Set<ConstraintViolation<Object>> validates = validator.validate(obj, groups);
    Iterator<ConstraintViolation<Object>> iterator = validates.iterator();
    while (iterator.hasNext()) {
        String message = iterator.next().getMessage();
        // 输出校验信息
        System.out.println(message);
    }
}

3.使用示例

public static void valid() {
    Order order = new Order();
    order.setUserName("李四")
    // 新增时
    validWithGroup(order, Order.Add.class, Default.class);
    
    // 更新时
    Order order2 = new Order();
    order2.setId(1);
    order2.setUserName("李四5555");
    validWithGroup(order2, Order.Update.class);
}

结尾

Spring Boot 中集成的Validator功能强大且灵活，能够满足大部分数据校验需求。掌握其基本用法，合理利用标准注解和自定义校验逻辑，可以大幅提升应用的数据处理质量与用户体验。实践过程中，注意结合实际业务需求，不断优化校验策略，以达到最佳校验效果。