这篇文章主要介绍“SpringBoot Validation提示信息国际化如何配置”,在日常操作中,相信很多人在SpringBoot Validation提示信息国际化如何配置问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”SpringBoot Validation提示信息国际化如何配置”的疑惑有所帮助!接下来,请跟着小编一起来学习吧!
Spring Boot Validation支持JSR-380(aka. Bean Validation 2.0,part of Jakarta EE and JavaSE)注解,可通过验证注解的message属性设置验证错误提示信息,且每个验证注解都有默认的message配置,例如@NotBlank
的message属性值设置如下图:
默认的message = "{...}"
的形式即指定国际化属性的名称,后续会根据语言环境替换为对应的值,而这些国际化属性的定义可参见hibernate-validator
中的org.hibernate.validator.ValidationMessages.properties
等一些列国际化属性定义:
而我们在实际使用过程中,除了可以设置message="{propName}"
的形式来读取国际化属性,亦可以直接设置值message="具体的提示信息",而不明确设置message则使用之前提到的org.hibernate.validator.ValidationMessages.properties
中的默认配置。
Spring Boot Validation起初其并不直接支持读取Spring Boot自身的国际化配置(通过spring.messages进行配置),而是需要在resources/ValidationMessages.properties中进行配置的国际化属性才会生效,而后续在Spring Boot 2.6+版本才支持Validation与Spring Boot自身的国际化配置相结合。
接下来结合Spring Boot 2.5和2.6版本分别介绍下Spring Boot Validation如何集成自定义国际化验证提示信息。
Spring Boot 2.5.x
在Spring Boot 2.5.x版本中,Spring Boot Validation默认只支持读取resources/ValidationMessages.properties
系列文件的中的国际化属性,且中文需要进行ASCII转码才可正确显示
如下图:
而就算Spring Boot应用亦声明了自身的国际化配置,但是Spring Boot Validation框架是读取不到的
例如:
Spring Boot应用自身的国际化配置如下图,但是在验证注解message属性设置i18n/messages.properties中的"{propName}"
是读取不到的:
而想要Spring Boot Validation框架和Spring Boot自身使用同样的国际化配置,则可通过如下方式进行配置:
import org.springframework.context.MessageSource;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.validation.Validator;import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean;import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;@Configurationpublic class WebValidationConfig implements WebMvcConfigurer { private MessageSource messageSource; public WebValidationConfig(MessageSource messageSource) { //注入Spring Boot国际化消息源(需通过spring.messages明确指定) this.messageSource = messageSource; } @Bean @Override public Validator getValidator() { LocalValidatorFactoryBean bean = new LocalValidatorFactoryBean(); //仅兼容Spring Boot spring.messages设置的国际化文件和原hibernate-validator的国际化文件 //不支持resource/ValidationMessages.properties系列 bean.setValidationMessageSource(this.messageSource); return bean; }}
注:
通过上述配置类进行配置后,
仅兼容Spring Boot spring.messages设置的国际化文件和原hibernate-validator的国际化文件
不再支持resource/ValidationMessages.properties系列
Spring Boot 2.6.x
翻了Github上Spring Boot框架的Release说明,发现其在2021-08-20发布的v2.6.0-M2中提到了支持使用自身国际化MessageSource解析验证提示信息,也就是说Spring Boot 2.6.x版本之后已支持验证注解message属性引用Spring Boot自身国际化配置。
实际测试Spring Boot 2.6.x版本,验证注解message="{propName}"
:
可以直接读取通过
spring.messages
设置的国际化配置中的属性(设置UTF-8编码后中文可无需ASCII转码),同时亦支持读取
resources
/ValidationMessages.properties
中的配置(中文需ASCII转码),且依旧支持原
hibernate-validator
的国际化文件。
且读取优先级依次从上到下,即最上面的优先生效。
具体的配置及使用方式见下图:
Spring Boot 2.6关于Spring Boot Validation与MessageSource的融合,具体实现细节可参见Release中提到的GitHub Pull Request #17530:
到此,关于“SpringBoot Validation提示信息国际化如何配置”的学习就结束了,希望能够解决大家的疑惑。理论与实践的搭配能更好的帮助大家学习,快去试试吧!若想继续学习更多相关知识,请继续关注编程网网站,小编会继续努力为大家带来更多实用的文章!