Spring Validation：如何控制验证链的执行顺序和提前退出

本文介绍了在Spring Validation中控制验证器执行顺序和实现提前退出的方法。通过使用`@GroupSequence`注解，可以定义验证组的执行顺序，从而控制验证链的流程，并在某个验证器返回false时，阻止后续验证器的执行，提高验证效率。

在Spring Validation中，默认情况下，所有应用于字段的验证器都会被执行，即使前面的验证器已经返回了错误。这在某些情况下可能不是我们期望的行为。例如，我们希望先验证日期格式是否正确，如果格式错误，则无需再进行年龄范围的验证。本文将介绍如何利用Spring Validation的组序列特性来实现这种需求，控制验证链的执行顺序，并在某个验证器返回false时提前退出。

验证组（Validation Groups）

Spring Validation 允许我们将验证约束分组。通过定义不同的组，我们可以选择性地应用特定的验证约束。这在处理复杂的业务逻辑时非常有用。

@GroupSequence 注解

@GroupSequence 注解允许我们定义验证组的执行顺序。通过指定组的顺序，我们可以确保验证器按照预期的顺序执行。如果序列中的任何组验证失败，则后续组将不会被验证。

示例：日期格式和年龄范围验证

假设我们有一个 Person 类，其中包含 dateOfBirth 字段，我们需要先验证日期格式是否正确，然后再验证年龄是否在指定范围内。

首先，定义两个验证组：DateFormatCheck 和 AgeRangeCheck。

public interface DateFormatCheck {}
public interface AgeRangeCheck {}

然后，修改自定义验证器和注解，将它们与相应的验证组关联起来。

微信 WeLM

WeLM不是一个直接的对话机器人，而是一个补全用户输入信息的生成模型。

下载

@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 {DateFormatCheck.class}; // 添加验证组
    Class[] payload() default {};
}

public class ISODateValidator implements ConstraintValidator {

    @Override
    public void initialize(ISODateConstraint constraintAnnotation) {
        ConstraintValidator.super.initialize(constraintAnnotation);
    }

    @Override
    public boolean isValid(String s, ConstraintValidatorContext constraintValidatorContext) {
        try {
            LocalDate.parse(s);
        } catch (DateTimeParseException e) {
            return false;
        }
        return true;
    }
}

@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 {AgeRangeCheck.class}; // 添加验证组
    Class[] payload() default {};
    int min();
    int max();
}

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) {
        LocalDate date;
        try {
             date = LocalDate.parse(s);
        } catch (DateTimeParseException e) {
            return false;
        }
        return ( LocalDate.now().minusYears(min).isAfter(date) || LocalDate.now().minusYears(min).isEqual(date))
               && ( LocalDate.now().minusYears(max).isBefore(date) || LocalDate.now().minusYears(max).isEqual(date));
    }
}

接下来，使用 @GroupSequence 注解定义验证组的执行顺序。

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

@GroupSequence({Default.class, DateFormatCheck.class, AgeRangeCheck.class})
public interface OrderedChecks {}

最后，在 Person 类中使用定义的组序列。

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;

public class Person {

    @NotBlank(message = "Name cannot be blank")
    private String name;

    @NotNull(message = "Date of birth cannot be null")
    @AgeConstraint(min = 13, max = 100, groups = AgeRangeCheck.class)
    @ISODateConstraint(groups = DateFormatCheck.class)
    private String dateOfBirth;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getDateOfBirth() {
        return dateOfBirth;
    }

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

要触发特定的组序列，需要在验证时指定相应的组。例如，在使用 Validator 进行验证时：

import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
import javax.validation.ConstraintViolation;

import java.util.Set;

public class ValidationExample {

    public static void main(String[] args) {
        ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
        Validator validator = factory.getValidator();

        Person person = new Person();
        person.setName("John Doe");
        person.setDateOfBirth("2022-13-12"); // Invalid date

        Set> violations = validator.validate(person, OrderedChecks.class);

        for (ConstraintViolation violation : violations) {
            System.out.println(violation.getMessage());
        }
    }
}

在这个例子中，如果 dateOfBirth 字段的格式无效（ISODateValidator 返回 false），那么 AgeValidator 将不会被执行，只会返回日期格式错误的验证消息。

注意事项

• @GroupSequence 定义的顺序必须包含 Default.class，否则默认的验证约束将不会被执行。
• 验证组的顺序很重要，它决定了验证器执行的顺序。
• 可以使用多个验证组，并且可以在不同的场景下选择性地应用它们。

总结

通过使用 @GroupSequence 注解，我们可以有效地控制Spring Validation中验证器的执行顺序，并实现提前退出。这可以提高验证效率，并确保验证逻辑按照预期的顺序执行。在处理复杂的验证需求时，组序列是一个非常有用的工具。