На основе аннотации Spring bean валидация

Я изучаю подход, основанный на аннотации, для проверки Spring beans с помощью spring modules. В этот учебник в качестве примера используется bean (getters and seters опущены):

public final class User {  

  @NotBlank  
  @Length(max = 80)  
  private String name;  

  @NotBlank  
  @Email  
  @Length(max = 80)  
  private String email;  

  @NotBlank  
  @Length(max = 4000)  
  private String text;  
}

Сообщение об ошибке, которое используется, если определенное правило проверки не оспаривается, должно следовать этому формату:

bean-class.bean-propery[validation-rule]=Validation Error message

Примеры для класса, показанного выше, включают в себя:

User.email[not.blank]=Please enter your e-mail address.  
User.email[email]=Please enter a valid e-mail address.  
User.email[length]=Please enter no more than {2} characters.

Тот факт, что ключи сообщения содержат имя класса, представляет собой пару проблем:

  • Если класс переименован, необходимо также изменить клавиши сообщения

  • Если у меня есть другой класс (например, Person) с свойством электронной почты, которое проверено идентично с User.email, мне нужно дублировать сообщения, например.

    Person.email [not.blank] = Пожалуйста, введите свой адрес электронной почты.
    Person.email [email] = Пожалуйста, введите действительный адрес электронной почты.
    Person.email [length] = Введите не более {2} символов.

Фактически, в документации утверждается, что можно настроить сообщение по умолчанию для определенного правила (например, @Email) следующим образом:

email=email address is invalid

Это сообщение по умолчанию должно использоваться, если не удается найти сообщение bean для конкретного правила. Однако, мой опыт заключается в том, что это просто не работает.

Альтернативным механизмом предотвращения дублирования сообщений является передача ключа сообщения об ошибке в аннотацию правила. Например, предположим, что я определил следующее сообщение об ошибке по умолчанию для правила @Email

badEmail=Email address is invalid

Это сообщение должно использоваться, если я аннотирую соответствующее свойство следующим образом:

@Email(errorCode="badEmail")
private String email;

Однако я попробовал это, и снова, он просто не работает. Кто-нибудь нашел способ избежать дублирования сообщений об ошибках при использовании этой рамки проверки?

Ответы

Ответ 1

Я быстро просмотрел API BeanValidator, и похоже, что вы можете попробовать свойство errorCodeConverter.

Вам нужно будет реализовать собственный ErrorCodeConverter или использовать одну из предоставленных реализаций?

....
<bean id="validator" class="org.springmodules.validation.bean.BeanValidator"
    p:configurationLoader-ref="configurationLoader"
    p:errorCodeConverter-ref="errorCodeConverter" />

<bean id="errorCodeConverter" class="contact.MyErrorCodeConverter" />
....

Примечание: ConfigurationLoader - это еще один bean, определенный в XML файле конфигурации, используемом в учебнике

Преобразователь примеров:

package contact;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springmodules.validation.bean.converter.ErrorCodeConverter;

public class MyErrorCodeConverter implements ErrorCodeConverter {

    private Log log = LogFactory.getLog(MyErrorCodeConverter.class);

    @Override
    public String convertPropertyErrorCode(String errorCode, Class clazz, String property) {
        log.error(String.format("Property %s %s %s", errorCode, clazz.getClass().getName(), property));
        return errorCode;  // <------ use the errorCode only
    }

    @Override
    public String convertGlobalErrorCode(String errorCode, Class clazz) {
        log.error(String.format("Global %s %s", errorCode, clazz.getClass().getName()));
        return errorCode;
    }
}

Теперь свойства должны работать:

MyEmailErrorCode=Bad email

class Foo {
    @Email(errorCode="MyEmailErrorCode")
    String email
}

Ответ 2

Spring У проверки есть ErrorCodeConverter, который делает это:

org.springmodules.validation.bean.converter.KeepAsIsErrorCodeConverter

Когда это используется, пакет ресурсов будет проверяться на следующие коды:

[errorCode.commandBeanName.fieldName, errorCode.fieldName, errorCode.fieldClassName, errorCode]

  • errorCode - это фактический код ошибки проверки, например. not.blank, электронная почта.
  • commandBeanName совпадает с именем ключа модели, которое ссылается на форма поддержки bean.
  • fieldName - это имя поля.
  • fieldClassName - это имя класса поля, например. java.lang.String, java.lang.Integer

Так, например, если у меня есть bean, на который ссылаются в модели ключом "formBean", а поле emailAddress типа java.lang.String не содержит адрес электронной почты, что вызывает сообщение errorCode. Рамка проверки будет пытаться разрешить следующие коды сообщений:

[email.formBean.emailAddress, email.emailAddress, email.java.lang.String, email]

Если код errorCode заменяется кодом errorCode "badEmail" следующим образом:

@email (ERRORCODE = "badEmail" )

Коды сообщений, которые будет проверять инфраструктура, будут следующими:

[badEmail.formBean.emailAddress, badEmail.emailAddress, badEmail.java.lang.String, badEmail]

Я хотел бы предложить сохранить errodCode одинаково. Таким образом, одно сообщение может использоваться для всех полей, которые связаны с этим кодом ошибок. Если вам нужно быть более конкретным с сообщением для определенного поля, вы можете добавить сообщение в пакеты ресурсов с кодом errorCode.commandBeanName.field.

Ответ 3

Добавьте следующий beans в ваш applicationContext.xml файл.

<bean id="configurationLoader"
    class="org.springmodules.validation.bean.conf.loader.annotation.AnnotationBeanValidationConfigurationLoader" />

<!-- Use the error codes as is. Don't convert them to <Bean class name>.<bean field being validated>[errorCode]. -->    
<bean id="errorCodeConverter"
    class="org.springmodules.validation.bean.converter.KeepAsIsErrorCodeConverter"/>

 <!-- shortCircuitFieldValidation = true ==> If the first rule fails on a field, no need to check 
    other rules for that field -->   
<bean id="validator" class="org.springmodules.validation.bean.BeanValidator"
    p:configurationLoader-ref="configurationLoader"
    p:shortCircuitFieldValidation="true" 
    p:errorCodeConverter-ref="errorCodeConverter"/>