场景
validator 校验参数不通时,将错误信息保存到 BindingResult,最后使用 i18n 根据不同国家和地区展示对应的异常信息。要求配置好后不需要再在应用程序中添加额外代码,就能实现上述功能。
在 springboot 大行其道的今天,使用 spring boot 的 validator 校验请求参数,再由 BindingResult 将异常信息抛出,这种解决方法随处可见。但坑就在这里:spring boot 的 validator 不支持异常信息国际化,要使用 hibernate validator 实现 i18n。
错误的配置
我起初的配置是:
import org.springframework.validation.Validator;
@Configuration
public class I18DemoConfig {
@Bean
public MessageSource messageSource() {
ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();
messageSource.setBasename("ValidationMessages");
messageSource.setDefaultEncoding("UTF-8");
return messageSource;
}
@Bean
public Validator getValidator() {
LocalValidatorFactoryBean bean = new LocalValidatorFactoryBean();
bean.setValidationMessageSource(messageSource());
return bean;
}
}
ValidationMessages_zh_CN.properties:
vo.UserVo.AGE_MUST_GREATERTHAN_18=年龄不能小于18岁
校验的参数是:
@Min(value = 18, message = "{vo.UserVo.AGE_MUST_GREATERTHAN_18}")
private int age;
可得到 BindingResult 中 defaultMessage 的内容总是:"{vo.UserVo.AGE_MUST_GREATERTHAN_18}" 。但是执行:
String result = messageSource.getMessage("vo.UserVo.EMAIL_NOT_EMPTY", null, Locale.CHINA)
却又能拿出想要的结果:result = 年龄不能小于18岁 。
这说明 i18n 本身配置是成功的,但是 i18n 在 validator 中没有生效。 起初我认为是 spring boot validation 版本的问题,好多资料中都是这么使用的,为何唯独我这么配置就不 work。最后在犄角旮旯里发现这么配置 validator 竟然成功了!!
import javax.validation.Validator
@Bean(name = "validator")
public Validator localValidatorFactoryBean(){
MessageSourceResourceBundleLocator messageSourceResourceBundleLocator = new MessageSourceResourceBundleLocator(messageSource());
ResourceBundleMessageInterpolator resourceBundleMessageInterpolator = new ResourceBundleMessageInterpolator(messageSourceResourceBundleLocator);
return Validation.byDefaultProvider().configure()
.messageInterpolator(resourceBundleMessageInterpolator)
.buildValidatorFactory()
.getValidator();
}
当我还在庆幸好容易搞定后,突然发现这两个不一样呢: org.springframework.validation.Validator VS javax.validation.Validator 前者 i18n 不生效,后者生效。
继续查原因…。 找到了个地方 spring 的开发人员说:spring boot validation 不支持插入信息,spring framework 是通过使用 Hibernate validator 实现该功能的。
正确的配置
import org.springframework.context.MessageSource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.support.ResourceBundleMessageSource;
import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean;
import org.springframework.web.servlet.LocaleResolver;
import org.springframework.web.servlet.i18n.AcceptHeaderLocaleResolver;
import javax.validation.Validator;
import java.util.Locale;
import static java.util.Arrays.asList;
@Configuration
public class I18DemoConfig {
@Bean
public MessageSource messageSource() {
ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();
messageSource.setBasename("ValidationMessages");
messageSource.setDefaultEncoding("UTF-8");
return messageSource;
}
@Bean
public Validator getValidator() {
LocalValidatorFactoryBean bean = new LocalValidatorFactoryBean();
bean.setValidationMessageSource(messageSource());
return bean;
}
@Bean
public LocaleResolver localeResolver() {
AcceptHeaderLocaleResolver resolver = new AcceptHeaderLocaleResolver();
resolver.setSupportedLocales(asList(Locale.CHINA, Locale.US));
resolver.setDefaultLocale(Locale.CHINA);
return resolver;
}
}
resource 下的配置文件:
-
配置文件内容: # ValidationMessages_en_US.properties
vo.UserVo.AGE_MUST_GREATERTHAN_18=Must be at least 18 years old
# ValidationMessages_zh_CN.properties
vo.UserVo.AGE_MUST_GREATERTHAN_18=年龄不能小于18岁
-
messageSource() 配置国际化信息存放的文件前缀,以及使用 utf8 编码,不然汉子展示到前端是乱码。en_US 和 zh_CN 分别是美式英语和简体汉语的缩写,其他语言缩写见此处。 -
Valuator 不能使用 spring 框架的,不然 i18n 不生效。 -
LocaleResolver 是判断当前的国家及区域,从而使用对应的语言渲染信息。AcceptHeaderLocaleResolver 标识要从请求头中的 Accept-Language 字段判定国家地区,当然还有别的判断方式,比如中 session 或者 rquestParam 中获取指定字段做判定,有需求的可以查下。这里支持两种语言:Locale.CHINA, Locale.US 默认使用前者。
测试
英文:
中文:
|