JSR 303验证，如果一个字段等于“ something”，则这些其他字段不应为null

89

我正在使用JSR-303做一些自定义验证javax.validation。

我有一个领域。而且，如果在此字段中输入了某个值，则我希望不包含其他一些字段null。

我正在尝试解决这个问题。不确定我该如何称呼以帮助找到解释。

任何帮助，将不胜感激。我对此很陌生。

目前，我正在考虑自定义约束。但是我不确定如何从批注中测试相关字段的值。基本上我不确定如何从注释访问面板对象。

public class StatusValidator implements ConstraintValidator<NotNull, String> {

    @Override
    public void initialize(NotNull constraintAnnotation) {}

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if ("Canceled".equals(panel.status.getValue())) {
            if (value != null) {
                return true;
            }
        } else {
            return false;
        }
    }
}

这panel.status.getValue();给我带来麻烦..不确定如何完成此任务。

java  validation  bean-validation 
— 埃里克
source

Answers:

106

在这种情况下，我建议编写一个自定义验证器，该验证器将在类级别进行验证（以允许我们访问对象的字段），仅当另一个字段具有特定值时才需要一个字段。请注意，您应该编写通用验证器，该验证器将获得2个字段名称，并且仅使用这2个字段。要要求多个字段，您应该为每个字段添加此验证器。

使用以下代码作为想法（我尚未对其进行测试）。

  • 验证器界面

    /**
 * Validates that field {@code dependFieldName} is not null if
 * field {@code fieldName} has value {@code fieldValue}.
 **/
@Target({TYPE, ANNOTATION_TYPE})
@Retention(RUNTIME)
@Repeatable(NotNullIfAnotherFieldHasValue.List.class) // only with hibernate-validator >= 6.x
@Constraint(validatedBy = NotNullIfAnotherFieldHasValueValidator.class)
@Documented
public @interface NotNullIfAnotherFieldHasValue {

    String fieldName();
    String fieldValue();
    String dependFieldName();

    String message() default "{NotNullIfAnotherFieldHasValue.message}";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};

    @Target({TYPE, ANNOTATION_TYPE})
    @Retention(RUNTIME)
    @Documented
    @interface List {
        NotNullIfAnotherFieldHasValue[] value();
    }

}

  • 验证器实施

    /**
 * Implementation of {@link NotNullIfAnotherFieldHasValue} validator.
 **/
public class NotNullIfAnotherFieldHasValueValidator
    implements ConstraintValidator<NotNullIfAnotherFieldHasValue, Object> {

    private String fieldName;
    private String expectedFieldValue;
    private String dependFieldName;

    @Override
    public void initialize(NotNullIfAnotherFieldHasValue annotation) {
        fieldName          = annotation.fieldName();
        expectedFieldValue = annotation.fieldValue();
        dependFieldName    = annotation.dependFieldName();
    }

    @Override
    public boolean isValid(Object value, ConstraintValidatorContext ctx) {

        if (value == null) {
            return true;
        }

        try {
            String fieldValue       = BeanUtils.getProperty(value, fieldName);
            String dependFieldValue = BeanUtils.getProperty(value, dependFieldName);

            if (expectedFieldValue.equals(fieldValue) && dependFieldValue == null) {
                ctx.disableDefaultConstraintViolation();
                ctx.buildConstraintViolationWithTemplate(ctx.getDefaultConstraintMessageTemplate())
                    .addNode(dependFieldName)
                    .addConstraintViolation();
                    return false;
            }

        } catch (NoSuchMethodException | InvocationTargetException | IllegalAccessException ex) {
            throw new RuntimeException(ex);
        }

        return true;
    }

}

  • 验证程序用法示例（对于Java 8 +，hibernate-validator> = 6）

    @NotNullIfAnotherFieldHasValue(
    fieldName = "status",
    fieldValue = "Canceled",
    dependFieldName = "fieldOne")
@NotNullIfAnotherFieldHasValue(
    fieldName = "status",
    fieldValue = "Canceled",
    dependFieldName = "fieldTwo")
public class SampleBean {
    private String status;
    private String fieldOne;
    private String fieldTwo;

    // getters and setters omitted
}

  • 验证器用法示例（hibernate-validator <6；旧示例）

    @NotNullIfAnotherFieldHasValue.List({
    @NotNullIfAnotherFieldHasValue(
        fieldName = "status",
        fieldValue = "Canceled",
        dependFieldName = "fieldOne"),
    @NotNullIfAnotherFieldHasValue(
        fieldName = "status",
        fieldValue = "Canceled",
        dependFieldName = "fieldTwo")
})
public class SampleBean {
    private String status;
    private String fieldOne;
    private String fieldTwo;

    // getters and setters omitted
}

请注意，验证器实现使用库中的BeanUtils类，commons-beanutils但您也可以使用BeanWrapperImplSpring Framework中的类。

另请参见以下出色答案：使用Hibernate Validator（JSR 303）进行跨字段验证

— Slava Semushin
source
1
@Benedictus此示例仅适用于字符串，但是您可以对其进行修改以适用于任何对象。有2种方法：1）使用要验证的类（而不是）对参数进行验证Object。在这种情况下，您甚至不需要使用反射来获取值，但是在这种情况下，验证器的通用性就会降低2）BeanWrapperImp从Spring Framework（或其他库）及其getPropertyValue()方法中使用。在这种情况下，您将可以获取as值Object并将其强制转换为所需的任何类型。
— Slava Semushin
是的，但是您不能将Object作为注释参数，因此，对于要验证的每种类型，您都需要一堆不同的注释。
— 奔
1
是的，当我说“在这种情况下，验证器变得不太通用”时，我的意思是。
— Slava Semushin
我想对protoBuffer类使用此技巧。这非常有帮助（：
— Saeed
不错的解决方案。建立自订注解非常有帮助！
— Vishwa
126

定义必须验证为true的方法，并将@AssertTrue注释放在其顶部：

  @AssertTrue
  private boolean isOk() {
    return someField != something || otherField != null;
  }

该方法必须以“ is”开头。

— 奥德里斯·梅斯卡斯卡斯（Audrius Meskauskas）
source
我使用了您的方法，并且有效，但是我不知道如何获取消息。你碰巧知道吗？
— anaBad
12
到目前为止，这是最有效的选择。谢谢！@anaBad：AssertTrue批注可以接受自定义消息，就像其他约束批注一样。
— ernest_k '16
@ErnestKiwele感谢您的回答，但是我的问题不是设置消息，而是将消息放入我的jsp中。我的模型具有以下功能： @AssertTrue(message="La reference doit etre un URL") public boolean isReferenceOk() { return origine!=Origine.Evolution||reference.contains("http://jira.bcaexpertise.org"); } 在我的jsp中：<th><form:label path="reference"><s:message code="reference"/></form:label></th><td><form:input path="reference" cssErrorClass="errorField"/><br/><form:errors path="isReferenceOk" cssClass="error"/></td> 但是它引发了错误。
— anaBad '16
@ErnestKiwele没关系，我想通了，我创建了一个布尔属性，该属性在调用setReference（）时设置。
— anaBad '16
2
我不得不公开此方法
— -tibi，
20

您应该使用custom DefaultGroupSequenceProvider<T>：

ConditionalValidation.java

// Marker interface
public interface ConditionalValidation {}

MyCustomFormSequenceProvider.java

public class MyCustomFormSequenceProvider
    implements DefaultGroupSequenceProvider<MyCustomForm> {

    @Override
    public List<Class<?>> getValidationGroups(MyCustomForm myCustomForm) {

        List<Class<?>> sequence = new ArrayList<>();

        // Apply all validation rules from ConditionalValidation group
        // only if someField has given value
        if ("some value".equals(myCustomForm.getSomeField())) {
            sequence.add(ConditionalValidation.class);
        }

        // Apply all validation rules from default group
        sequence.add(MyCustomForm.class);

        return sequence;
    }
}

MyCustomForm.java

@GroupSequenceProvider(MyCustomFormSequenceProvider.class)
public class MyCustomForm {

    private String someField;

    @NotEmpty(groups = ConditionalValidation.class)
    private String fieldTwo;

    @NotEmpty(groups = ConditionalValidation.class)
    private String fieldThree;

    @NotEmpty
    private String fieldAlwaysValidated;


    // getters, setters omitted
}

另请参阅与此主题相关的问题。

— 用户名
source
有趣的方式。答案可能与它的工作原理有关，但因为我不得不看两次才知道发生了什么……
— Jules
嗨，我实现了您的解决方案，但遇到了问题。没有对象被传递给该getValidationGroups(MyCustomForm myCustomForm)方法。您可以在这里帮忙吗？：stackoverflow.com/questions/44520306/...
— user238607
2
@ user238607 getValidationGroups（MyCustomForm myCustomForm）将为每个bean实例调用很多次，并且有一段时间传递null。您可以忽略是否传递null。
— pramoth
7

这是我的看法，试图使其尽可能简单。

界面：

@Target({TYPE, ANNOTATION_TYPE})
@Retention(RUNTIME)
@Constraint(validatedBy = OneOfValidator.class)
@Documented
public @interface OneOf {

    String message() default "{one.of.message}";

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

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

    String[] value();
}

验证实施：

public class OneOfValidator implements ConstraintValidator<OneOf, Object> {

    private String[] fields;

    @Override
    public void initialize(OneOf annotation) {
        this.fields = annotation.value();
    }

    @Override
    public boolean isValid(Object value, ConstraintValidatorContext context) {

        BeanWrapper wrapper = PropertyAccessorFactory.forBeanPropertyAccess(value);

        int matches = countNumberOfMatches(wrapper);

        if (matches > 1) {
            setValidationErrorMessage(context, "one.of.too.many.matches.message");
            return false;
        } else if (matches == 0) {
            setValidationErrorMessage(context, "one.of.no.matches.message");
            return false;
        }

        return true;
    }

    private int countNumberOfMatches(BeanWrapper wrapper) {
        int matches = 0;
        for (String field : fields) {
            Object value = wrapper.getPropertyValue(field);
            boolean isPresent = detectOptionalValue(value);

            if (value != null && isPresent) {
                matches++;
            }
        }
        return matches;
    }

    private boolean detectOptionalValue(Object value) {
        if (value instanceof Optional) {
            return ((Optional) value).isPresent();
        }
        return true;
    }

    private void setValidationErrorMessage(ConstraintValidatorContext context, String template) {
        context.disableDefaultConstraintViolation();
        context
            .buildConstraintViolationWithTemplate("{" + template + "}")
            .addConstraintViolation();
    }

}

用法：

@OneOf({"stateType", "modeType"})
public class OneOfValidatorTestClass {

    private StateType stateType;

    private ModeType modeType;

}

讯息：

one.of.too.many.matches.message=Only one of the following fields can be specified: {value}
one.of.no.matches.message=Exactly one of the following fields must be specified: {value}
— 乔卡尔
source
3

另一种方法是创建一个（受保护的）getter，它返回包含所有相关字段的对象。例：

public class MyBean {
  protected String status;
  protected String name;

  @StatusAndSomethingValidator
  protected StatusAndSomething getStatusAndName() {
    return new StatusAndSomething(status,name);
  }
}

StatusAndSomethingValidator现在可以访问StatusAndSomething.status和StatusAndSomething.something并进行相关检查。

— 迈克尔·维拉兹（Michael Wyraz）
source
0

示例如下：

package io.quee.sample.javax;

import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

import javax.validation.ConstraintViolation;
import javax.validation.Valid;
import javax.validation.Validator;
import javax.validation.constraints.Pattern;
import java.util.Set;

/**
 * Created By [**Ibrahim Al-Tamimi **](https://www.linkedin.com/in/iloom/)
 * Created At **Wednesday **23**, September 2020**
 */
@SpringBootApplication
public class SampleJavaXValidation implements CommandLineRunner {
    private final Validator validator;

    public SampleJavaXValidation(Validator validator) {
        this.validator = validator;
    }

    public static void main(String[] args) {
        SpringApplication.run(SampleJavaXValidation.class, args);
    }

    @Override
    public void run(String... args) throws Exception {
        Set<ConstraintViolation<SampleDataCls>> validate = validator.validate(new SampleDataCls(SampleTypes.TYPE_A, null, null));
        System.out.println(validate);
    }

    public enum SampleTypes {
        TYPE_A,
        TYPE_B;
    }

    @Valid
    public static class SampleDataCls {
        private final SampleTypes type;
        private final String valueA;
        private final String valueB;

        public SampleDataCls(SampleTypes type, String valueA, String valueB) {
            this.type = type;
            this.valueA = valueA;
            this.valueB = valueB;
        }

        public SampleTypes getType() {
            return type;
        }

        public String getValueA() {
            return valueA;
        }

        public String getValueB() {
            return valueB;
        }

        @Pattern(regexp = "TRUE")
        public String getConditionalValueA() {
            if (type.equals(SampleTypes.TYPE_A)) {
                return valueA != null ? "TRUE" : "";
            }
            return "TRUE";
        }

        @Pattern(regexp = "TRUE")
        public String getConditionalValueB() {
            if (type.equals(SampleTypes.TYPE_B)) {
                return valueB != null ? "TRUE" : "";
            }
            return "TRUE";
        }
    }
}
— 易卜拉欣·塔米米
source
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.