السبات التحقق من صحة مجموعات من البدائية

Question

أريد أن أكون قادرًا على فعل شيء مثل:

@Email
public List<String> getEmailAddresses()
{
   return this.emailAddresses;
}

بمعنى آخر ، أريد التحقق من صحة كل عنصر في القائمة كعنوان بريد إلكتروني. بالطبع ، ليس من المقبول التعليق على مجموعة كهذه.

هل هناك طريقة للقيام بذلك؟

Answer 1

لا يوجد لدى JSR-303 ولا مدقق السبات أي قيود جاهزة يمكنها التحقق من صحة كل عناصر التجميع.

أحد الحلول الممكنة لمعالجة هذه المشكلة هو إنشاء مخصص @ValidCollection القيد وتطبيق المدقق المقابل ValidCollectionValidator.

للتحقق من صحة كل عنصر من عناصر التجميع ، نحتاج إلى مثيل Validator داخل ValidCollectionValidator; ؛ وللحصول على مثل هذه الحالة ، نحتاج إلى تنفيذ مخصص لـ ConstraintValidatorFactory.

تعرف على ما إذا كنت تحب الحل المتابع ...

ببساطة،

• نسخ ملصق جميع فئات Java هذه (واستيراد فصول Relavent) ؛
• أضف التحقق من الصحة-api ، Hibenate-validator ، SLF4J-Log4J12 ، و Testng Jars على classpath ؛
• تشغيل حالة الاختبار.

ValidCollection

    public @interface ValidCollection {

    Class<?> elementType();

    /* Specify constraints when collection element type is NOT constrained 
     * validator.getConstraintsForClass(elementType).isBeanConstrained(); */
    Class<?>[] constraints() default {};

    boolean allViolationMessages() default true;

    String message() default "{ValidCollection.message}";

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

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

}

ValidCollectionValidator

    public class ValidCollectionValidator implements ConstraintValidator<ValidCollection, Collection>, ValidatorContextAwareConstraintValidator {

    private static final Logger logger = LoggerFactory.getLogger(ValidCollectionValidator.class);

    private ValidatorContext validatorContext;

    private Class<?> elementType;
    private Class<?>[] constraints;
    private boolean allViolationMessages;

    @Override
    public void setValidatorContext(ValidatorContext validatorContext) {
        this.validatorContext = validatorContext;
    }

    @Override
    public void initialize(ValidCollection constraintAnnotation) {
        elementType = constraintAnnotation.elementType();
        constraints = constraintAnnotation.constraints();
        allViolationMessages = constraintAnnotation.allViolationMessages();
    }

    @Override
    public boolean isValid(Collection collection, ConstraintValidatorContext context) {
        boolean valid = true;

        if(collection == null) {
            //null collection cannot be validated
            return false;
        }

        Validator validator = validatorContext.getValidator();

        boolean beanConstrained = validator.getConstraintsForClass(elementType).isBeanConstrained();

        for(Object element : collection) {
            Set<ConstraintViolation<?>> violations = new HashSet<ConstraintViolation<?>> ();

            if(beanConstrained) {
                boolean hasValidCollectionConstraint = hasValidCollectionConstraint(elementType);
                if(hasValidCollectionConstraint) {
                    // elementType has @ValidCollection constraint
                    violations.addAll(validator.validate(element));
                } else {
                    violations.addAll(validator.validate(element));
                }
            } else {
                for(Class<?> constraint : constraints) {
                    String propertyName = constraint.getSimpleName();
                    propertyName = Introspector.decapitalize(propertyName);
                    violations.addAll(validator.validateValue(CollectionElementBean.class, propertyName, element));
                }
            }

            if(!violations.isEmpty()) {
                valid = false;
            }

            if(allViolationMessages) { //TODO improve
                for(ConstraintViolation<?> violation : violations) {
                    logger.debug(violation.getMessage());
                    ConstraintViolationBuilder violationBuilder = context.buildConstraintViolationWithTemplate(violation.getMessage());
                    violationBuilder.addConstraintViolation();
                }
            }

        }

        return valid;
    }

    private boolean hasValidCollectionConstraint(Class<?> beanType) {
        BeanDescriptor beanDescriptor = validatorContext.getValidator().getConstraintsForClass(beanType);
        boolean isBeanConstrained = beanDescriptor.isBeanConstrained();
        if(!isBeanConstrained) {
            return false;
        }
        Set<ConstraintDescriptor<?>> constraintDescriptors = beanDescriptor.getConstraintDescriptors(); 
        for(ConstraintDescriptor<?> constraintDescriptor : constraintDescriptors) {
            if(constraintDescriptor.getAnnotation().annotationType().getName().equals(ValidCollection.class.getName())) {
                return true;
            }
        }
        Set<PropertyDescriptor> propertyDescriptors = beanDescriptor.getConstrainedProperties();
        for(PropertyDescriptor propertyDescriptor : propertyDescriptors) {
            constraintDescriptors = propertyDescriptor.getConstraintDescriptors();
            for(ConstraintDescriptor<?> constraintDescriptor : constraintDescriptors) {
                if(constraintDescriptor.getAnnotation().annotationType().getName().equals(ValidCollection.class.getName())) {
                    return true;
                }
            }    
        }
        return false;
    }

}

ValitatorContextAwarConstraintValidator

public interface ValidatorContextAwareConstraintValidator {

    void setValidatorContext(ValidatorContext validatorContext);

}

CollectionElementBean

    public class CollectionElementBean {

    /* add more properties on-demand */
    private Object notNull;
    private String notBlank;
    private String email;

    protected CollectionElementBean() {
    }

    @NotNull
    public Object getNotNull() { return notNull; }
    public void setNotNull(Object notNull) { this.notNull = notNull; }

    @NotBlank
    public String getNotBlank() { return notBlank; }
    public void setNotBlank(String notBlank) { this.notBlank = notBlank; }

    @Email
    public String getEmail() { return email; }
    public void setEmail(String email) { this.email = email; }

}

ConstrentvalIdatorFactoryImpl

public class ConstraintValidatorFactoryImpl implements ConstraintValidatorFactory {

    private ValidatorContext validatorContext;

    public ConstraintValidatorFactoryImpl(ValidatorContext nativeValidator) {
        this.validatorContext = nativeValidator;
    }

    @Override
    public <T extends ConstraintValidator<?, ?>> T getInstance(Class<T> key) {
        T instance = null;

        try {
            instance = key.newInstance();
        } catch (Exception e) { 
            // could not instantiate class
            e.printStackTrace();
        }

        if(ValidatorContextAwareConstraintValidator.class.isAssignableFrom(key)) {
            ValidatorContextAwareConstraintValidator validator = (ValidatorContextAwareConstraintValidator) instance;
            validator.setValidatorContext(validatorContext);
        }

        return instance;
    }

}

موظف

public class Employee {

    private String firstName;
    private String lastName;
    private List<String> emailAddresses;

    @NotNull
    public String getFirstName() { return firstName; }
    public void setFirstName(String firstName) { this.firstName = firstName; }

    public String getLastName() { return lastName; }
    public void setLastName(String lastName) { this.lastName = lastName; }

    @ValidCollection(elementType=String.class, constraints={Email.class})
    public List<String> getEmailAddresses() { return emailAddresses; }
    public void setEmailAddresses(List<String> emailAddresses) { this.emailAddresses = emailAddresses; }

}

فريق

public class Team {

    private String name;
    private Set<Employee> members;

    public String getName() { return name; }
    public void setName(String name) { this.name = name; }

    @ValidCollection(elementType=Employee.class)
    public Set<Employee> getMembers() { return members; }
    public void setMembers(Set<Employee> members) { this.members = members; }

}

عربة التسوق

public class ShoppingCart {

    private List<String> items;

    @ValidCollection(elementType=String.class, constraints={NotBlank.class})
    public List<String> getItems() { return items; }
    public void setItems(List<String> items) { this.items = items; }

}

ValidCollectionTest

public class ValidCollectionTest {

    private static final Logger logger = LoggerFactory.getLogger(ValidCollectionTest.class);

    private ValidatorFactory validatorFactory;

    @BeforeClass
    public void createValidatorFactory() {
        validatorFactory = Validation.buildDefaultValidatorFactory();
    }

    private Validator getValidator() {
        ValidatorContext validatorContext = validatorFactory.usingContext();
        validatorContext.constraintValidatorFactory(new ConstraintValidatorFactoryImpl(validatorContext));
        Validator validator = validatorContext.getValidator();
        return validator;
    }

    @Test
    public void beanConstrained() {
        Employee se = new Employee();
        se.setFirstName("Santiago");
        se.setLastName("Ennis");
        se.setEmailAddresses(new ArrayList<String> ());
        se.getEmailAddresses().add("segmail.com");
        Employee me = new Employee();
        me.setEmailAddresses(new ArrayList<String> ());
        me.getEmailAddresses().add("me@gmail.com");

        Team team = new Team();
        team.setMembers(new HashSet<Employee>());
        team.getMembers().add(se);
        team.getMembers().add(me);

        Validator validator = getValidator();

        Set<ConstraintViolation<Team>> violations = validator.validate(team);
        for(ConstraintViolation<Team> violation : violations) {
            logger.info(violation.getMessage());
        }
    }

    @Test
    public void beanNotConstrained() {
        ShoppingCart cart = new ShoppingCart();
        cart.setItems(new ArrayList<String> ());
        cart.getItems().add("JSR-303 Book");
        cart.getItems().add("");

        Validator validator = getValidator();

        Set<ConstraintViolation<ShoppingCart>> violations = validator.validate(cart, Default.class);
        for(ConstraintViolation<ShoppingCart> violation : violations) {
            logger.info(violation.getMessage());
        }
    }

}

انتاج |

02:16:37,581  INFO main validation.ValidCollectionTest:66 - {ValidCollection.message}
02:16:38,303  INFO main validation.ValidCollectionTest:66 - may not be null
02:16:39,092  INFO main validation.ValidCollectionTest:66 - not a well-formed email address

02:17:46,460  INFO main validation.ValidCollectionTest:81 - may not be empty
02:17:47,064  INFO main validation.ValidCollectionTest:81 - {ValidCollection.message}

ملحوظة:- عندما يكون لدى الفول قيود لا تحدد constraints سمة @ValidCollection قيد. ال constraints السمة ضرورية عندما لا يكون لدى الفول أي قيود.

Answer 2

ليس لدي سمعة عالية بما يكفي للتعليق على هذا على الإجابة الأصلية ، ولكن ربما تجدر الإشارة إلى هذا السؤال JSR-308 هو في مرحلة الإصدار النهائي وسوف يعالج هذه المشكلة عند إصدارها! سوف يتطلب على الأقل جافا 8 ، ولكن.

الفرق الوحيد هو أن شرح التحقق من الصحة سوف يذهب داخل إعلان النوع.

//@Email
public List<@Email String> getEmailAddresses()
{
   return this.emailAddresses;
}

واسمحوا لي أن أعرف أين تعتقد أنه من الأفضل وضع هذه المعلومات للآخرين الذين يبحثون. شكرًا!

ملاحظة لمزيد من المعلومات ، تحقق من هذا.

Answer 3

ليس من الممكن كتابة تعليق توضيحي عام @EachElement لالتفاف أي تعليق توضيحي - بسبب قيود التعليقات التوضيحية Java نفسها. ومع ذلك ، يمكنك كتابة فئة مصادقة على قيود عامة والتي تنفد التحقق الفعلي لكل عنصر إلى مدقق قيود موجود. يجب عليك كتابة تعليق توضيحي لكل قيد ، ولكن فقط مدقق واحد.

لقد قمت بتنفيذ هذا النهج في jirutka/المجمع المدقق (متوفر في Maven Central). فمثلا:

@EachSize(min = 5, max = 255)
List<String> values;

تتيح لك هذه المكتبة إنشاء "قيود زائفة" بسهولة أي قيود التحقق من الصحة لتعليق مجموعة من الأنواع البسيطة ، دون كتابة مصلحة إضافية أو فصول غلاف غير ضرورية لكل مجموعة. EachX يتم دعم القيد لجميع قيود التحقق من صحة الفول القياسية وقيود محددة السبات.

لإنشاء @EachAwesome لوحدك @Awesome القيد ، فقط نسخ ولصق فئة التعليقات التوضيحية ، استبدل @Constraint التعليقات التوضيحية مع @Constraint(validatedBy = CommonEachValidator.class) وأضف التعليق التوضيحي @EachConstraint(validateAs = Awesome.class). هذا كل شئ!

// common boilerplate
@Documented
@Retention(RUNTIME)
@Target({METHOD, FIELD, ANNOTATION_TYPE})
// this is important!
@EachConstraint(validateAs = Awesome.class)
@Constraint(validatedBy = CommonEachValidator.class)
public @interface EachAwesome {

    // copy&paste all attributes from Awesome annotation here
    String message() default "";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
    String someAttribute();
}

تحرير: تم تحديثه للإصدار الحالي من المكتبة.

Answer 4

شكرا لإجابة رائعة من Becomputer06. لكنني أعتقد أنه يجب إضافة التعليقات التوضيحية التالية إلى تعريف ValiverCollection:

@Target( { ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = ValidCollectionValidator.class)

وما زلت لا أفهم ما يجب القيام به مع مجموعات من أغلفة النوع البدائي وتقييد التعليقات التوضيحية مثل size و min و max وما إلى ذلك ، لأنه لا يمكن تمرير القيمة من خلال طريق Becomputer06.

بالطبع ، يمكنني إنشاء تعليقات توضيحية مخصصة لجميع الحالات في طلبي ، ولكن على أي حال يجب أن أضيف خصائص لهذه التعليقات التوضيحية إلى CollectelementBean. ويبدو أنه حل سيء بما فيه الكفاية.

Answer 5

JSR-303 لديه القدرة على تمديد الأنواع المستهدفة من القيود المدمجة: انظر 7.1.2. تعريفات القيد المفرطة في XML.

يمكنك تنفيذ ملف ConstraintValidator<Email, List<String>> وهو ما يفعل نفس الشيء مثل الإجابات المعطاة ، والتفويض إلى المدقق البدائي. ثم يمكنك الحفاظ على تعريف النموذج الخاص بك والتطبيق @Email على List<String>.

Answer 6

من الممكن أن يكون الحل البسيط البسيط. يمكنك بدلاً من ذلك التحقق من صحة مجموعة من الفصول الخاصة بك التي تغلف خاصية القيمة البسيطة. لهذا العمل ، تحتاج إلى استخدامه @Valid التعليق التوضيحي على المجموعة.

مثال:

public class EmailAddress {

  @Email
  String email;

  public EmailAddress(String email){
    this.email = email;
  }
}

public class Foo {

  /* Validation that works */
  @Valid
  List<EmailAddress> getEmailAddresses(){
    return this.emails.stream().map(EmailAddress::new).collect(toList());
  }

}