Проверка JSR 303, если одно поле равно «что-то», то остальные поля не должны быть нулевыми.

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 
— Эрик
источник

Ответы:

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;
    }

}

  • Пример использования валидатора (hibernate-validator> = 6 с Java 8+)

    @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библиотеки, но вы также можете использовать BeanWrapperImplиз Spring Framework .

См. Также этот отличный ответ: Проверка перекрестных полей с помощью Hibernate Validator (JSR 303)

— Слава Семушин
источник
1
@Benedictus Этот пример будет работать только со строками, но вы можете изменить его для работы с любыми объектами. Есть 2 способа: 1) параметризовать валидатор с классом, который вы хотите проверить (вместо Object). В этом случае вам даже не нужно использовать отражение для получения значений, но в этом случае валидатор становится менее универсальным 2) использование BeanWrapperImpиз Spring Framework (или других библиотек) и его getPropertyValue()метода. В этом случае вы сможете получить значение как Objectи привести к любому нужному типу.
— Слава
Да, но у вас не может быть Object в качестве параметра аннотации, поэтому вам понадобится куча разных аннотаций для каждого типа, который вы хотите проверить.
— Бен
1
Да, это то, что я имел в виду, когда сказал «в этом случае валидатор станет менее универсальным».
— Слава
Я хочу использовать этот трюк для классов protoBuffer. это очень полезно (:
— Саид
Хорошее решение. Очень полезно для создания собственных аннотаций!
— Вишва,
126

Определите метод, который должен подтверждаться как истинный, и поместите @AssertTrue аннотацию поверх него:

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

Метод должен начинаться с "is".

— Аудрюс Мескаускас
источник
Я использовал ваш метод, и он работает, но я не могу понять, как получить сообщение. Вы случайно не знаете?
— anaBad
12
Это был самый эффективный из вариантов. Благодарность! @anaBad: аннотация AssertTrue может принимать настраиваемое сообщение, как и другие аннотации ограничений.
— ernest_k
@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 01
@ErnestKiwele Неважно, я понял это, я создал логический атрибут, который устанавливается при вызове setReference ().
— anaBad 01
2
я должен был сделать метод общедоступным
— tibi
20

Вы должны использовать обычай 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
}

См. Также связанный вопрос по этой теме .

— user11153
источник
Интересный способ сделать это. Однако ответ мог бы быть связан с дополнительным объяснением того, как это работает, потому что мне пришлось прочитать его дважды, прежде чем я увидел, что происходит ...
— Жюль
Привет, я реализовал ваше решение, но столкнулся с проблемой. В 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}
— Jokarl
источник
3

Другой подход - создать (защищенный) получатель, который возвращает объект, содержащий все зависимые поля. Пример:

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

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

StatusAndSomethingValidator теперь может получить доступ к StatusAndSomething.status и StatusAndSomething.something и выполнить зависимую проверку.

— Майкл Вайраз
источник
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";
        }
    }
}
— Ибрагим аль-Тамими
источник
Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.