जेएसआर 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();मुझे परेशानी दे रहा है .. यकीन नहीं है कि यह कैसे पूरा करें।

जवाबों:


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;
        }
    
    }
    
  • वैध उपयोग उदाहरण (हाइबरनेट-सत्यापनकर्ता> = 6 जावा 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
    }
    
  • वैध उपयोग उदाहरण (हाइबरनेट-सत्यापनकर्ता <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स्प्रिंग फ्रेमवर्क से भी उपयोग कर सकते हैं ।

इस शानदार उत्तर को भी देखें: हाइबरनेट वैलिडेटर (JSR 303) के साथ क्रॉस फील्ड सत्यापन


1
@ बेनेडिक्टस यह उदाहरण केवल स्ट्रिंग्स के साथ काम करेगा लेकिन आप इसे किसी भी ऑब्जेक्ट के साथ काम करने के लिए संशोधित कर सकते हैं। 2 तरीके हैं: 1) कक्षा के साथ पैरामीरीज़ सत्यापनकर्ता जिसे आप सत्यापित करना चाहते हैं (इसके बजाय Object)। इस मामले में, आपको मूल्यों को प्राप्त करने के लिए प्रतिबिंब का उपयोग करने की आवश्यकता नहीं है, लेकिन इस मामले में सत्यापनकर्ता कम सामान्य बन जाते हैं 2) BeanWrapperImpस्प्रिंग फ्रेमवर्क (या अन्य पुस्तकालयों) और इसकी getPropertyValue()विधि से उपयोग करें। इस मामले में आप Objectकिसी भी प्रकार का मूल्य प्राप्त कर सकते हैं और आपको किसी भी प्रकार की आवश्यकता होगी।
स्लाव सेमुशिन

हाँ, लेकिन आपके पास एनोटेशन पैरामीटर के रूप में ऑब्जेक्ट नहीं हो सकता है, इसलिए आपको प्रत्येक प्रकार के सत्यापन के लिए अलग-अलग एनोटेशन की आवश्यकता होगी।
बेन

1
हां, इसका क्या मतलब है जब मैंने कहा था "इस मामले में सत्यापनकर्ता कम सामान्य हो जाता है"।
स्लावा सेमुशिन

मैं इस ट्रिक को प्रोटॉफ़र कक्षाओं के लिए उपयोग करना चाहता हूँ। यह बहुत मददगार है: (
सईद

अच्छा समाधान है। कस्टम एनोटेशन बनाने में बहुत मददगार!
विश्व

126

उस विधि को परिभाषित करें जिसे सत्य के लिए मान्य होना चाहिए और @AssertTrueउसके शीर्ष पर एनोटेशन को रखना चाहिए :

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

विधि 'है ’से शुरू होनी चाहिए।


मैंने आपकी विधि का उपयोग किया है और यह काम करता है, लेकिन मैं यह पता नहीं लगा सकता कि संदेश कैसे प्राप्त किया जाए। क्या आपको पता होगा?
अनाबद

12
यह अब तक विकल्पों में से सबसे कुशल था। धन्यवाद! @anaBad: AssertTrue एनोटेशन एक कस्टम संदेश ले सकता है, जैसे अन्य बाधा एनोटेशन।
ernest_k

@EnnestKiwele उत्तर देने के लिए धन्यवाद, लेकिन मेरी समस्या संदेश सेट करने के साथ नहीं है बल्कि मेरे जेएसपी में है। मेरे पास निम्न फ़ंक्शन मॉडल है: @AssertTrue(message="La reference doit etre un URL") public boolean isReferenceOk() { return origine!=Origine.Evolution||reference.contains("http://jira.bcaexpertise.org"); } और यह मेरे जेएसपी में है: <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> लेकिन यह एक त्रुटि फेंकता है।
अनाबद

@ErnestKiwele मुझे कोई फर्क नहीं पड़ता कि मैंने इसे समझ लिया है, मैंने एक बूलियन विशेषता बनाई है जिसे सेटरेंस () कहा जाता है।
अनाबद

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
}

इस विषय पर संबंधित प्रश्न भी देखें ।


इसे करने का दिलचस्प तरीका। हालांकि, यह कैसे काम करता है, इसका अधिक विवरण के साथ कर सकते हैं, क्योंकि मुझे दो बार पढ़ना था इससे पहले कि मैंने देखा कि क्या चल रहा था ...
जूल्स

नमस्ते, मैंने आपके समाधान को लागू किया लेकिन एक समस्या का सामना कर रहा हूं। किसी भी वस्तु को getValidationGroups(MyCustomForm myCustomForm)विधि से पारित नहीं किया जा रहा है । क्या आप संभवतः यहाँ मदद कर सकते हैं? : stackoverflow.com/questions/44520306/…
user238607

2
@ user238607 getValidationGroups (MyCustomForm myCustomForm) प्रति सेम उदाहरण के लिए कई बार कॉल करेगा और यह कुछ समय पास होगा। आप इसे अनदेखा करते हैं अगर यह अशक्त हो जाता है।
प्रमथ

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}

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 Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.