Spring Bean Validation中实现验证链的顺序执行与短路

本文探讨了在Spring Bean Validation中，当一个字段应用了多个自定义校验器时，如何控制它们的执行顺序并在任意校验器失败时提前终止整个验证链。通过引入javax.validation.GroupSequence注解，开发者可以定义校验组的执行顺序，从而确保验证逻辑按预期执行，并返回最先失败的校验信息，避免不必要的后续校验。

理解Spring Bean Validation的默认行为

在Spring应用程序中，当一个字段被多个Bean Validation注解修饰时，默认情况下，所有属于Default验证组的约束都会被评估。这意味着即使某个前置的校验器已经判断数据无效并返回false，后续的校验器仍然会继续执行。这种行为可能导致以下问题：

1. 错误的错误消息： 如果多个校验器都失败了，最终返回的错误消息可能不是最先发现问题的校验器提供的，而是某个后续校验器提供的。这会使用户难以理解真正的错误原因。
2. 不必要的计算： 即使数据明显不符合某个基本约束，后续复杂的校验逻辑仍然会被执行，造成资源浪费。

考虑一个场景，一个dateOfBirth字段同时被@ISODateConstraint（检查日期格式）和@AgeConstraint（检查年龄范围）修饰。如果输入了一个格式错误的日期（如"2022-13-12"），我们期望首先捕获到日期格式错误。然而，在默认行为下，即使ISODateConstraint校验失败，AgeConstraint可能仍然会尝试解析这个无效日期，甚至返回与年龄相关的错误消息，而非日期格式错误。

引入javax.validation.GroupSequence实现验证链控制

javax.validation.GroupSequence注解是解决上述问题的关键。它允许我们定义一个有序的验证组序列。当应用了GroupSequence时，Bean Validation会按照序列中定义的顺序逐个验证组。如果某个组中的任何一个约束失败，则序列中后续的组将不再被评估，从而实现了验证链的“短路”或“提前退出”机制。

要实现这一机制，我们需要遵循以下步骤：

1. 定义自定义验证组接口

首先，为每个逻辑校验阶段或校验器定义一个空的标记接口，作为其所属的验证组。

// 用于ISO日期格式校验的组
public interface IsoDateValidationGroup {}

// 用于年龄范围校验的组
public interface AgeValidationGroup {}

2. 将自定义约束关联到验证组

修改现有的自定义约束注解，通过groups属性将它们与相应的验证组关联起来。

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

// ISODateConstraint注解
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = ISODateValidator.class)
public @interface ISODateConstraint {
    String message() default "Field is not a valid iso date";
    Class[] groups() default {}; // 允许指定验证组
    Class[] payload() default {};
}

// AgeConstraint注解
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = AgeValidator.class)
public @interface AgeConstraint {
    String message() default "Age is not in required range";
    Class[] groups() default {}; // 允许指定验证组
    Class[] payload() default {};
    int min();
    int max();
}

3. 实现自定义校验器

自定义校验器的实现保持不变，它们负责具体的校验逻辑。这里仅展示其结构，具体实现与问题描述一致。

LAIKA

LAIKA 是一个创意伙伴，您可以训练它像您（或您想要的任何人）一样写作。

下载

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.time.LocalDate;
import java.time.format.DateTimeParseException;

// ISODateValidator实现
public class ISODateValidator implements ConstraintValidator {
    @Override
    public boolean isValid(String s, ConstraintValidatorContext constraintValidatorContext) {
        if (s == null || s.trim().isEmpty()) {
            return true; // 或者根据业务需求返回false
        }
        try {
            LocalDate.parse(s);
        } catch (DateTimeParseException e) {
            return false;
        }
        return true;
    }
}

// AgeValidator实现
public class AgeValidator implements ConstraintValidator {
    private int min;
    private int max;

    @Override
    public void initialize(AgeConstraint constraintAnnotation) {
        this.min = constraintAnnotation.min();
        this.max = constraintAnnotation.max();
    }

    @Override
    public boolean isValid(String s, ConstraintValidatorContext constraintValidatorContext) {
        if (s == null || s.trim().isEmpty()) {
            return true; // 或者根据业务需求返回false
        }
        LocalDate date;
        try {
            date = LocalDate.parse(s);
        } catch (DateTimeParseException e) {
            // 如果日期格式已经无效，这里应该被前面的校验组拦截，
            // 但为健壮性考虑，此处仍需处理，通常在短路机制下不会执行到这里
            return false;
        }
        LocalDate now = LocalDate.now();
        boolean isAfterMin = now.minusYears(min).isAfter(date) || now.minusYears(min).isEqual(date);
        boolean isBeforeMax = now.minusYears(max).isBefore(date) || now.minusYears(max).isEqual(date);
        return isAfterMin && isBeforeMax;
    }
}

4. 定义验证组序列

创建一个新的接口，并使用@GroupSequence注解来指定验证组的执行顺序。将需要按顺序执行的验证组接口放入value数组中。

import javax.validation.GroupSequence;
import javax.validation.groups.Default;

// 定义日期和年龄校验的执行顺序
@GroupSequence({IsoDateValidationGroup.class, AgeValidationGroup.class, Default.class})
public interface OrderedDateValidationSequence {}

注意事项：

• Default.class：如果你的模型中存在没有明确指定groups属性的约束，它们将默认属于Default组。将Default.class包含在GroupSequence中可以确保这些默认约束在指定组之后被评估。如果所有约束都已明确分配到自定义组，则可以省略Default.class。
• 序列中的顺序至关重要，它决定了校验的优先级。

5. 在模型或DTO中应用约束和组

在需要验证的DTO或模型类中，将自定义约束应用于字段，并通过groups属性指定它们所属的验证组。

public class UserDto {

    @ISODateConstraint(groups = IsoDateValidationGroup.class)
    @AgeConstraint(min = 13, max = 100, groups = AgeValidationGroup.class)
    private String dateOfBirth;

    // 其他字段、构造器、Getter和Setter方法
    public String getDateOfBirth() {
        return dateOfBirth;
    }

    public void setDateOfBirth(String dateOfBirth) {
        this.dateOfBirth = dateOfBirth;
    }
}

6. 触发验证并指定组序列

在Spring MVC/WebFlux控制器中，当接收到需要验证的对象时，使用@Validated注解并传入之前定义的GroupSequence接口来触发验证。

import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import javax.validation.Valid;

@RestController
@RequestMapping("/users")
public class UserController {

    @PostMapping("/create")
    public String createUser(@Validated(OrderedDateValidationSequence.class) @RequestBody UserDto userDto) {
        // 如果验证通过，则处理userDto
        return "User created successfully with dateOfBirth: " + userDto.getDateOfBirth();
    }

    // 示例：不使用组序列的普通验证
    @PostMapping("/simple-create")
    public String createSimpleUser(@Valid @RequestBody UserDto userDto) {
        // 这里的验证会按照默认行为执行，不会短路
        return "User created simply with dateOfBirth: " + userDto.getDateOfBirth();
    }
}

在上述createUser方法中，当UserDto被验证时，Bean Validation会首先检查IsoDateValidationGroup中的所有约束（即@ISODateConstraint）。如果dateOfBirth的ISO日期格式无效，验证将立即停止，并返回与ISODateConstraint相关的错误消息，AgeValidationGroup中的约束将不会被评估。这完美解决了最初的问题。

总结

通过javax.validation.GroupSequence注解，开发者可以精确控制Spring Bean Validation中多个约束的执行顺序，并实现短路机制。这不仅能确保返回最准确的错误消息，提高用户体验，还能避免不必要的计算，优化资源使用。在设计复杂的验证逻辑时，合理地使用验证组和组序列是构建健壮、高效应用程序的关键实践。