Генерация кода ошибки для свойства в Hibernate Validator

Question

Я смотрю на использование Hibernate Validator для моих требований. Я хочу проверить JavaBean, где свойства могут иметь несколько проверок проверки. Например:

class MyValidationBean
{
   @NotNull
   @Length( min = 5, max = 10 )
   private String myProperty;
}

Но если это свойство не проходит проверку, я хочу, чтобы с ConstraintViolation был связан определенный код ошибки, независимо от того, произошла ли ошибка из-за @Required или @Length, хотя я хотел бы сохранить сообщение об ошибке.

class MyValidationBean
{
   @NotNull
   @Length( min = 5, max = 10 )
   @ErrorCode( "1234" )
   private String myProperty;
}

Что-то похожее на вышесказанное было бы хорошо, но оно не должно быть точно таким же. Я не вижу способа сделать это с Hibernate Validator. Возможно ли это?

Answer 1

Вы можете создать пользовательскую аннотацию, чтобы получить поведение, которое вы ищете, а затем при проверке и использовании рефлексии вы можете извлечь значение аннотации. Примерно так:

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ErrorCode {
    String value();
}

В вашем бобе:

@NotNull
@Length( min = 5, max = 10 )
@ErrorCode("1234")
public String myProperty;

При проверке вашего бина:

Set<ConstraintViolation<MyValidationBean>> constraintViolations = validator.validate(myValidationBean);    
for (ConstraintViolation<MyValidationBean>cv: constraintViolations) {
    ErrorCode errorCode = cv.getRootBeanClass().getField(cv.getPropertyPath().toString()).getAnnotation(ErrorCode.class);
    System.out.println("ErrorCode:" + errorCode.value());
}

Сказав, что я, вероятно, поставлю под сомнение требования для получения кодов ошибок для этих типов сообщений.

Answer 2

Из раздела 4.2. ConstraintViolation спецификации:

Метод getMessageTemplate возвращает сообщение об ошибке без интерполяции (обычно это атрибут message в объявлении ограничения). Фреймворки могут использовать это в качестве ключа кода ошибки.

Я думаю, это ваш лучший вариант.

Answer 3

Я бы попытался изолировать это поведение на уровне DAO приложения.

Используя ваш пример, мы получили бы:

public class MyValidationBeanDAO {
    public void persist(MyValidationBean element) throws DAOException{
        Set<ConstraintViolation> constraintViolations = validator.validate(element);
        if(!constraintViolations.isEmpty()){
            throw new DAOException("1234", contraintViolations);
        }
        // it's ok, just persist it
        session.saveOrUpdate(element);
    }
}

И следующий класс исключений:

public class DAOException extends Exception {
private final String errorCode;
private final Set<ConstraintViolation> constraintViolations;

public DAOException(String errorCode, Set<ConstraintViolation> constraintViolations){
    super(String.format("Errorcode %s", errorCode));
    this.errorCode = errorCode;
    this.constraintViolations = constraintViolations;
}
// getters for properties here
}

Вы можете добавить некоторую информацию аннотации, основанную на том, какое свойство здесь не проверено, но всегда делайте это с помощью метода DAO.

Надеюсь, это помогло.