JSR 303検証、1つのフィールドが「何か」に等しい場合、これらの他のフィールドはnullであってはなりません

92

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 
— エリック
ソース

回答:

107

この場合、クラスレベルで（オブジェクトのフィールドにアクセスできるようにするために）別のフィールドに特定の値がある場合にのみ1つのフィールドが必要であることを検証するカスタムバリデーターを作成することをお勧めします。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;
    }

}

  • バリデーターの使用例（Java8以降で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ライブラリをしかし、あなたはまた、使用することができBeanWrapperImpl春のフレームワークから。

このすばらしい回答も参照してください：Hibernate Validator（JSR 303）を使用したクロスフィールド検証

— スラバセムシン
ソース
1
@Benedictusこの例は文字列でのみ機能しますが、任意のオブジェクトで機能するように変更できます。2つの方法があります：1）検証したいクラスでバリデーターをパラメーター化します（の代わりにObject）。この場合、値を取得するためにリフレクションを使用する必要はありませんが、この場合、バリデーターは一般的ではなくなります2）BeanWrapperImpSpring Framework（または他のライブラリ）とそのgetPropertyValue()メソッドから使用します。この場合、として値を取得し、Object必要な任意のタイプにキャストできます。
— Slava Semushin 2017年
ええ、しかし、アノテーションパラメータとしてオブジェクトを持つことはできないので、検証したいタイプごとにたくさんの異なるアノテーションが必要になります。
— ベン
1
はい、「この場合、バリデーターは一般的ではなくなります」と言ったときの意味です。
— Slava Semushin 2017年
このトリックをprotoBufferクラスに使用したいと思います。これは、（非常に有用である：
— サイード
素晴らしい解決策。カスタムアノテーションを作成するのに非常に役立ちます！
— Vishwa
128

trueに検証する必要があるメソッドを定義@AssertTrueし、その上にアノテーションを配置します。

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

メソッドは「is」で始まる必要があります。

— Audrius Meskauskas
ソース
私はあなたの方法を使用しました、そしてそれは働きます、しかし私はメッセージを得る方法を理解することができません。あなたはたまたま知っていますか？
— anaBad 2016
12
これは、これまでで最も効率的なオプションでした。ありがとう！@anaBad：AssertTrueアノテーションは、他の制約アノテーションと同様に、カスタムメッセージを受け取ることができます。
— ernest_k 2016
@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 2016
@ErnestKiwele気にしないでください。私は、setReference（）が呼び出されたときに設定されるブール属性を作成しました。
— anaBad 2016
2
メソッドを公開する必要がありました
— tibi 2018年
22

カスタムを利用する必要があります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
ソース
それを行う興味深い方法。しかし、何が起こっているのかを見る前に2回読まなければならなかったので、答えはそれがどのように機能するかについてのより多くの説明で行うことができます...
— ジュール
こんにちは、私はあなたのソリューションを実装しましたが、問題に直面しています。オブジェクトはgetValidationGroups(MyCustomForm myCustomForm)メソッドに渡されていません。ここで手伝ってもらえますか？：stackoverflow.com/questions/44520306/...
— user238607
2
@ user238607 getValidationGroups（MyCustomForm myCustomForm）は、Beanインスタンスごとに何度も呼び出し、しばらくの間nullを渡します。nullを渡した場合は無視します。
— pramoth 2018年
9

これが私の見解です。できるだけシンプルにしようとしました。

インターフェース：

@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";
        }
    }
}
— イブラヒム・アルタミミ
ソース
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.