如何以干净的方式在spring-boot中基于​​另一个属性验证一个属性？

Question

我正在 spring-boot 2.3.1.RELEASE Web 应用程序中验证 REST 服务请求/bean。目前，我正在使用 Hibernate Validator，尽管我愿意使用任何其他方式进行验证。

假设，我有一个模型Foo，我在Rest Controller 中收到它作为请求。我想验证completionDate 是否不是null 那么status 应该是“完成”或“关闭”。

@StatusValidate
public class Foo {
    private String status;
    private LocalDate completionDate;
    // getters and setters
}

我创建了一个自定义类级别注释@StatusValidate。

@Constraint(validatedBy = StatusValidator.class)
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface StatusValidate {

    String message() default "default status error";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

我创建了StatusValidator 类。

public class StatusValidator implements ConstraintValidator<StatusValidate, Foo> {

    @Override
    public void initialize(StatusValidateconstraintAnnotation) {
    }

    @Override
    public boolean isValid(Foovalue, ConstraintValidatorContext context) {
        if (null != value.getCompletionDate() && (!value.getStatus().equalsIgnoreCase("complete") && !value.getStatus().equalsIgnoreCase("closed"))) {
            context.disableDefaultConstraintViolation();
            context.buildConstraintViolationWithTemplate(context.getDefaultConstraintMessageTemplate()).
                    .addPropertyNode("status").addConstraintViolation();
            return false;
        }
        return true;
    }
}

当我验证Foo 对象时（通过使用@Valid 或@Validated 或手动调用validator.validate() 方法），我在ConstraintViolation 中获得以下数据。 代码：

// Update.class is a group
Set<ConstraintViolation<Foo>> constraintViolations = validator.validate(foo, Update.class);
constraintViolations.forEach(constraintViolation -> {
    ErrorMessage errorMessage = new ErrorMessage();
    errorMessage.setKey(constraintViolation.getPropertyPath().toString());
    errorMessage.setValue(constraintViolation.getInvalidValue());
    // Do something with errorMessage here
});

constraintViolation.getPropertyPath().toString() => 状态

constraintViolation.getInvalidValue() =>（Foo 对象）

如何在自定义ConstraintValidator 或其他任何地方设置无效值（status 属性的实际值），以便constraintViolation.getInvalidValue() 返回status 属性的值？ 或 在一个属性的验证取决于另一个属性的值的情况下，是否有更好的方法来验证请求负载/bean？

编辑： 我可以做类似的事情

if(constraintViolation.getPropertyPath().toString().equals("status")) {
    errorMessage.setValue(foo.getStatus());
}

但这将涉及在某处维护属性名称的字符串常量，例如。 "status"。不过，在StatusValidator 中，我也在设置属性名称.addPropertyNode("status")，这也是我想避免的。

---

总结： 我正在寻找解决方案（不一定使用自定义验证或休眠验证器），其中

1. 我可以验证 json 请求者或 bean，以验证其验证取决于其他属性值的属性。
2. 我不必在任何地方将 bean 属性名称维护为字符串常量（维护噩梦）。
3. 我能够获取无效的属性名称和值。

Answer 1

您可以使用dynamic payload 在约束违规中提供额外数据。可以使用HibernateConstraintValidatorContext进行设置：

context.unwrap(HibernateConstraintValidatorContext.class)
        .withDynamicPayload(foo.getStatus().toString());

而javax.validation.ConstraintViolation 可以依次解包到HibernateConstraintViolation 以检索动态有效负载：

constraintViolation.unwrap(HibernateConstraintViolation.class)
        .getDynamicPayload(String.class);

在上面的例子中，我们传递了一个简单的字符串，但是你可以传递一个包含你需要的所有属性的对象。

请注意，这仅适用于 Hibernate Validator，这是 Bean 验证规范 (JSR-303/JSR-349) 的最广泛使用的实现，并被 Spring 用作其默认验证供应商。

Answer 2

您可以使用表达式语言来评估属性路径。例如

Set<ConstraintViolation<Foo>> constraintViolations = validator.validate(foo);
    constraintViolations.forEach(constraintViolation -> {
        Path propertyPath = constraintViolation.getPropertyPath();
        Foo rootBean = constraintViolation.getRootBean();

        Object invalidPropertyValue = getPropertyValue(rootBean, propertyPath);
        System.out.println(MessageFormat.format("{0} = {1}", propertyPath, invalidPropertyValue));
    });

private static Object getPropertyValue(Object bean, Path propertyPath) {
    ELProcessor el = new ELProcessor();
    el.defineBean("bean", bean);
    String propertyExpression = MessageFormat.format("bean.{0}", propertyPath);
    Object propertyValue = el.eval(propertyExpression);
    return propertyValue;
}

表达式语言也适用于嵌套 bean。这是一个完整的例子

您将需要 Java >1.8 和以下依赖项：

<dependency>
    <groupId>org.glassfish</groupId>
    <artifactId>javax.el</artifactId>
    <version>3.0.0</version>
</dependency>
<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>2.0.0.Final</version>
</dependency>
<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.0.2.Final</version>
</dependency>
<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator-annotation-processor</artifactId>
    <version>6.0.2.Final</version>
</dependency>

还有我的java代码

public class Main {

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

        Validator validator = buildDefaultValidatorFactory.getValidator();

        // I added Bar to show how nested bean property validation works
        Bar bar = new Bar();

        // Must be 2 - 4 characters
        bar.setName("A");

        Foo foo = new Foo();
        foo.setBar(bar);
        foo.setCompletionDate(LocalDate.now());

        // must be complete or closed
        foo.setStatus("test");

        Set<ConstraintViolation<Foo>> constraintViolations = validator.validate(foo);

        System.out.println("Invalid Properties:");

        constraintViolations.forEach(constraintViolation -> {
            Path propertyPath = constraintViolation.getPropertyPath();
            Foo rootBean = constraintViolation.getRootBean();

            Object invalidPropertyValue = getPropertyValue(rootBean, propertyPath);
            System.out.println(MessageFormat.format("{0} = {1}", propertyPath, invalidPropertyValue));
        });
    }

    private static Object getPropertyValue(Object bean, Path propertyPath) {
        ELProcessor el = new ELProcessor();
        el.defineBean("bean", bean);
        String propertyExpression = MessageFormat.format("bean.{0}", propertyPath);
        Object propertyValue = el.eval(propertyExpression);
        return propertyValue;
    }

    @StatusValidate
    public static class Foo {
        private String status;
        private LocalDate completionDate;

        @Valid
        private Bar bar;

        public void setBar(Bar bar) {
            this.bar = bar;
        }

        public Bar getBar() {
            return bar;
        }

        public String getStatus() {
            return status;
        }

        public void setStatus(String status) {
            this.status = status;
        }

        public LocalDate getCompletionDate() {
            return completionDate;
        }

        public void setCompletionDate(LocalDate completionDate) {
            this.completionDate = completionDate;
        }

    }

    public static class Bar {

        @Size(min = 2, max = 4)
        private String status;

        public String getStatus() {
            return status;
        }

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

    @Constraint(validatedBy = StatusValidator.class)
    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    public static @interface StatusValidate {

        String message()

        default "default status error";

        Class<?>[] groups() default {};

        Class<? extends Payload>[] payload() default {};
    }

    public static class StatusValidator implements ConstraintValidator<StatusValidate, Foo> {

        @Override
        public boolean isValid(Foo value, ConstraintValidatorContext context) {
            if (null != value.getCompletionDate() && (!value.getStatus().equalsIgnoreCase("complete")
                    && !value.getStatus().equalsIgnoreCase("closed"))) {
                context.disableDefaultConstraintViolation();
                context.buildConstraintViolationWithTemplate(context.getDefaultConstraintMessageTemplate())
                        .addPropertyNode("status").addConstraintViolation();
                return false;
            }
            return true;
        }
    }
}

输出是：

Invalid Properties:
status = test
bar.status = A

Answer 3

使用@NotNull 作为完成日期并使用自定义枚举验证器作为这样的状态：

  /*enum class*/
public enum Status{
    COMPLETE,
    CLOSED
}

/*custom validator*/
@ValueValidator(EnumValidatorClass = Status.class)
@NotNull
private String status;

@NotNull
private LocalDate completionDate;

 /*anotation interface*/
@Target({ ElementType.FIELD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = EnumValueValidator.class)
@Documented
public @interface ValueValidator {
    
       public abstract String message() default "Invalid Status!";
     
        public abstract Class<?>[] groups() default {};
      
        public abstract Class<? extends Payload>[] payload() default {};
         
        public abstract Class<? extends java.lang.Enum<?>> EnumValidatorClass();
         

}

/*anotation implementation*/
public class EnumValueValidator implements ConstraintValidator<ValueValidator, String>{

 private List<String> values;
 
@Override
public void initialize(ValueValidator annotation)
{
    values = Stream.of(annotation.EnumValidatorClass().getEnumConstants()).map(Enum::name).collect(Collectors.toList());
}

@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
    if (value == null) {
        return true;
    }

    return values.contains(value);
}}