当前位置:主页 > java教程 > SpringBoot Validation提示信息国际化配置

SpringBoot Validation提示信息国际化配置方式

发布:2023-03-25 08:20:01 59


我们帮大家精选了相关的编程文章,网友贾博涉根据主题投稿了本篇教程内容,涉及到SpringBoot、Validation、Validation提示信息、Validation国际化配置、SpringBoot Validation提示信息国际化配置相关内容,已被754网友关注,相关难点技巧可以阅读下方的电子资料。

SpringBoot Validation提示信息国际化配置

引言

之前介绍过Spring Boot Validation的使用及扩展

本文在此基础上重点讲解下Spring Boot 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;

/**
 * Spring Web验证器自定义国际化文件配置<br/>
 * 注:适用于Spring Boot 2.5.*
 *
 * @author luohq
 * @date 2022-05-21
 */
@Configuration
public class WebValidationConfig implements WebMvcConfigurer {

    /**
     * 国际化消息源
     */
    private MessageSource messageSource;

    public WebValidationConfig(MessageSource messageSource) {
        //注入Spring Boot国际化消息源(需通过spring.messages明确指定)
        this.messageSource = messageSource;
    }

    /**
     * 使用自定义LocalValidatorFactoryBean,
     * 设置Spring国际化消息源
     */
    @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如何实现异步响应请求(前端请求超时的问题解决)

    发布:2023-04-21

    这篇文章主要给大家介绍了关于springboot如何实现异步响应请求(前端请求超时的问题解决)的相关资料,文中通过实例代码介绍的非常详细,对大家学习或者使用springboot具有一定的参考学习价值,需要的朋友可以参考下


  • SpringBoot系列教程JPA基础环境搭建的步骤

    发布:2019-07-25

    这篇文章主要介绍了SpringBoot系列教程JPA之基础环境搭建的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习


  • springboot 防止重复请求防止重复点击的操作

    发布:2023-04-18

    这篇文章主要介绍了springboot 防止重复请求防止重复点击的操作,URL 拦截器可以使用 spring 拦截器,但使用 spring,每个需要过滤的新 URL 都需要添加配置,因此这里使用 AOP 注解 的形式来实现,结合实例代码给大家介绍的非常详细,需要的朋友可以参考下


  • Springboot Oauth2 Server搭建Oauth2认证服务步骤分享

    发布:2020-02-02

    这篇文章主要介绍了Springboot Oauth2 Server 搭建Oauth2认证服务,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧


  • SpringBoot访问静态资源的配置及顺序说明

    SpringBoot访问静态资源的配置及顺序说明

    发布:2022-07-06

    给网友们整理关于SpringBoot的教程,这篇文章主要介绍了SpringBoot访问静态资源的配置及顺序说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教


  • springboot的三种启动方式总结

    发布:2019-06-21

    这篇文章主要介绍了详解springboot的三种启动方式,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧


  • SpringBoot集成tomcat详解实现过程

    发布:2023-03-26

    采用spring boot之后,一切变得如此简单,打包->java-jar->运维,只需要一个jar包便可以随意部署安装。这篇文章,将对 spring boot集成tomcat的源码进行分析,探索其内部的原理


  • springboot+webmagic实现java爬虫jdbc及mysql实例代码

    发布:2020-02-10

    今天小编就为大家分享一篇springboot+webmagic实现java爬虫jdbc及mysql的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧


网友讨论