SpringBoot 使用validation数据校验之国际化问题怎么搞？满满的方案，值得收藏

admin 管理员组

文章数量: 887007

SpringBoot 使用validation数据校验之国际化问题怎么搞？满满的方案，值得收藏

 

相关历史文章（阅读本文前，您可能需要先看下之前的系列👇）

国内最全的Spring Boot系列之四

享元模式：共享女友 - 第355篇

Spring Boot @ConditionalOnClass上的注解你了解多少-java元注解和注解 - 第404篇

SpringBoot 使用validation数据校验-超级详细超级多干货 - 第406篇

SpringBoot 使用validation数据校验之分组校验怎么玩？·分组还有这么多讲究 - 第408篇

SpringBoot 使用validation数据校验之自定义校验注解·源码分析+实例 - 第410篇

​

悟纤：师傅，这个验证的信息现在直接写死在代码中了，那如果产品经理哪天不开心了，要让我国际化这可怎么办呢？宝宝好害怕(灬ꈍ ꈍ灬)

师傅：徒儿，莫慌，遇事要保持淡定。

悟纤：我是想蛋定，但怎奈蛋不定呢？

师傅：那你晃荡吧~

师傅：对于验证信息国际化，这个问题吧，小问题，很容易就破了，待为师带你破破这其中的奥妙。让你轻松和国外美眉过障碍沟通…

       Spring Boot validation系列：

（1）✅《SpringBoot 使用validation数据校验-超级详细超级多干货》

（2）✅《SpringBoot 使用validation数据校验之分组校验怎么玩？·分组还有这么多的讲究》

（3）✅《SpringBoot 使用validation数据校验之自定义校验注解·源码分析+实例》

（4）✅《SpringBoot 使用validation数据校验之国际化问题怎么搞？》满满的干货

       这一节我们来看看《SpringBoot 使用validation数据校验之国际化问题怎么搞？》。

缘起

       在前面的hibernate-validation的数据校验的使用，我们的提示信息都是直接写在了代码的message属性了，那代码一旦编译成class文件了，想修改还比较难，那我们如果产品有需求国际化的，那么对于提示信息是不是也要跟着国际化呢？

答案是肯定的，那么对于validation的验证信息如何国际化呢？如果你还不知道的话，本文将详细为你揭晓！

一、validation国际化

1.1 思路说明

       在Spring Boot项目中，对于validation的国际化非常简单，只需要简单的几个步骤：

（1）校验注解message属性，使用{key}的方式进行编码，比如：{username.notBlank}；

（2）创建配置文件，默认文件名称ValidationMessages；

（3）在配置文件中配置key-value。

1.2 具体的操作示例

       接下来的操作基于前面的文章的例子往下编码的。

1.2.1校验注解message属性

       修改UserInfo的校验注解，这里我们拿一个属性来举例说明：

@NotBlank(message = "{username.notBlank}")
privateStringusername;

说明：这里的message已经不是具体的信息了，而是配置了key的方式{username.notBlank}

1.2.2建配置文件，默认文件名称ValidationMessages

       在resources的目录下，创建配置文件，默认文件名称ValidationMessages.properties：

文件名称说明：

（1）默认：ValidationMessages.properties；

（2）中文：ValidationMessages.zh_CN.properties；

（3）英文：ValidationMessages.en_US.properties；

1.2.3在配置文件中配置key-value

       在配置文件中配置key-value：

username.notBlank = username is not blank!

       至此编码完毕，可以启动进行测试了，如果正常的情况下，那么提示信息就会变成：

二、validation国际化进阶

2.1 乱码问题

       一切看起来似乎很完美，就在我们沉静在快乐之中的时候，产品发话了，这中文呢？

       O(∩_∩)O哈哈~ 高兴的太早了，

       于是乎，我就吧信息修改成了中文：

username.notBlank = 用户名不能为空

       一启动，乍一看还以为闹鬼了：

       NND，这是一坨什么鬼东西。

       这就是中文乱码了，为啥会乱码呢？可以看《SpringBoot使用@Value读取.properties中文乱码及解决方法》，这里不重复赘述。

那怎么搞呢？中文出现乱码，是因为读取properties文件的编码方式不是utf-8，那关键是怎么破呢？

2.1.1 方案一：修改IntelliJ Idea的文件配置

       修改Idea的文件配置：

       修改之后，重新启动程序就可以了。

2.1.2 方案二：中文转换为ASCII

       可以使用一些在线工具或者使用一些插件，转换为ASCII码，转换为：

username.notBlank = \u7528\u6237\u540d\u4e0d\u80fd\u4e3a\u7a7a

      

       重启访问就可以了。

在线转换工具：

2.1.3 方案三：编码设置编码为UTF-8

       对于读取配置文件是ValidationMessageSource的属性，只要对这个对象进行配置即可：

@Beanpublic MessageSource messageSource() {    ResourceBundleMessageSource source = new ResourceBundleMessageSource();    source.setDefaultEncoding("utf-8");//读取配置文件的编码格式    source.setCacheMillis(-1);//缓存时间，-1表示不过期    source.setBasename("ValidationMessages");//配置文件前缀名，设置为Messages,那你的配置文件必须以Messages.properties/Message_en.properties...    return source;}​@Beanpublic Validator validator() {    LocalValidatorFactoryBean factoryBean = new LocalValidatorFactoryBean();    MessageInterpolatorFactory interpolatorFactory = new MessageInterpolatorFactory();    factoryBean.setMessageInterpolator(interpolatorFactory.getObject());    factoryBean.setValidationMessageSource(messageSource());    return factoryBean;}​

       这段代码放在@Configuration配置的类或者启动类都可正常执行。

2.2如何自定义资源文件夹?

       Spring Boot 表单验证 @Validated 的 message 国际化资源文件默认必须放在 resources/ValidationMessages.properties 中。

现在我想把资源文件放到 resources/i18n/validation/message.properties 中，请问该如何修改?

2.2.1 方案一：重新定义ResourceBundleMessageSource

       重新定义ResourceBundleMessageSource，然后设置basename属性：

@Beanpublic Validator getValidator() {    ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();    //i18n/validation:目录名称；message:文件名称,规则message*.properties    messageSource.setBasename("i18n/validation/message");    //解决中文乱码    messageSource.setDefaultEncoding("UTF-8");​    LocalValidatorFactoryBean validator = new LocalValidatorFactoryBean();    validator.setValidationMessageSource(messageSource);    return validator;}​

       目录结构如下：

说明：

（1）i18n和validation：目录名称，需要进行创建目录；

（2）message是文件名称；

2.2.2 方案二：配置文件配置

       通过配置application.properties进行指定：

spring.messages.basename=i18n/validation/messagespring.messages.encoding=UTF-8

       原本很欢喜的觉得，到这里就可以了，可惜启动完之后，没啥效果。

不知道是不是Spring Boot版本的问题，让配置这两个，居然不能生效。

       如果你可以的话，那么恭喜你，这是最简单的方式，既设置了路径又设置了编码，如果不可以的话，那么就需要如下的配置文件了：

import org.springframework.beans.factory.annotation.Autowired;import org.springframework.context.MessageSource;import org.springframework.context.annotation.Bean;import org.springframework.validation.Validator;import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean;import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;​/** *  * * @author 悟纤「公众号SpringBoot」 * @date 2021-10-18 * @slogan 大道至简 悟在天成 *///@Configurationpublic class WebMvcConfig implements WebMvcConfigurer {​​    /**     * 实体类字段校验国际化引入     */    @Autowired    private MessageSource messageSource;​    /**     * 实体类字段校验国际化引入     */    @Override    public Validator getValidator() {        return validator();    }​    /**     * 实体类字段校验国际化引入     */    @Bean    public Validator validator() {        LocalValidatorFactoryBean validator = new LocalValidatorFactoryBean();        validator.setValidationMessageSource(messageSource);        return validator;    }​}​

2.3 乱码以及如何自定义资源文件夹的方案总结

       通过上面的方案，那么当前来说，最好的方案是：

@Beanpublic Validator getValidator() {    ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();    //i18n/validation:目录名称；message:文件名称,规则message*.properties    messageSource.setBasename("i18n/validation/message");    //解决中文乱码    messageSource.setDefaultEncoding("UTF-8");​    LocalValidatorFactoryBean validator = new LocalValidatorFactoryBean();    validator.setValidationMessageSource(messageSource);    return validator;}

       一个配置，既解决了乱码问题又解决了路径问题。

       如果spring.messages.basename/spring.messages.encoding可以直接生效的话，那么这种方案肯定是最好的，也是优先推荐使用。

2.4 动态配置参数

2.4.1 校验注解属性参数动态

       对于密码的设置，我们把信息修改到配置文件：

代码：

@Length(min = 6,max = 20,message = "{password.length}")private String password;

配置文件：

password.length=密码长度在6-20之间

现在这个代码是可以正常运行的，现在如果我们修改了@Length的，max=30，那么配置文件也需要修改了，所以我们希望“密码长度在6-20”这个描述的6和20是获取的@Length配置的min和max，很简单，直接是{min}和{max}就可以了：

password.length=密码长度在{min}-{max}之间

2.4.2 获取到输入参数

       我们现在有这么一个需求，就是校验信息，要把用户输入的值，告知用户，也就是入如下：

password.length=密码[当前用户填写的密码的值]长度在{min}-{max}之间

“当前用户填写的密码的值”这个是动态的，用户输入什么就是什么，这个怎么搞呢？也很简单，如下示例：

password.length=密码[${validatedValue}]长度在{min}-{max}之间

踩坑说明：这里的${validatedValue}就是固定的编码方式，很容易写成错误的方式${password}。

2.4.3 部分代码部分配置文件的方式

       如果你有这么变态的需求，就是一部分信息是在代码的，一部分的信息是在配置文件的，也可以实现的，只需要修改代码即可：

@Length(min = 6,max = 20,message = "您的 {password.length}",groups = {ValidGroup.Update.class,ValidGroup.Insert.class})private String password;

2.4.4 组装key

通过这里，我们可以随意的进行配置的组装，啥意思呢，如果您的信息是由两个key构成的，那么就可以写成：

@Length(min = 6,max = 20,message = "您的 {password.length}，{modify}",groups = {ValidGroup.Update.class,ValidGroup.Insert.class})private String password;

三、总结

       至此Spring Boot Validation就高一段落了，最后简单的进行总结：

       Java API规范(JSR303)定义了Bean校验的标准validation-api，但没有提供实现。hibernate validation是对这个规范的实现，并增加了校验注解如@Email、@Length等。SpringValidation是对hibernate validation的二次封装，用于支持spring mvc参数自动校验。

    过完这一周就就元旦了，在此祝大家元旦快乐，一帆风顺，心想事成，写代码行行无BUG。

我就是我，是颜色不一样的烟火。
我就是我，是与众不同的小苹果。

à云课堂学院：悟空学院

学院中有Spring Boot相关的课程！！

SpringBoot视频：从零开始学Spring Boot Plus - 网易云课堂

SpringBoot交流平台：

SpringSecurity5.0视频：权限管理spring security - 网易云课堂

ShardingJDBC分库分表：分库分表Sharding-JDBC实战 - 网易云课堂

分布式事务解决方案：分布式事务解决方案「手写代码」 - 网易云课堂

JVM内存模型调优实战：深入理解JVM内存模型/调优实战 - 网易云课堂

Spring入门到精通：Spring零基础从入门到精通 - 网易云课堂

大话设计模式之爱你：大话设计模式之爱你一万年 - 网易云课堂

本文标签： SpringBoot 使用validation数据校验之国际化问题怎么搞满满的方案，值得收藏