springboot实现国际化,推荐这样实战使用

单体架构和微服务架构,处理方式稍微不通,你能get到吗?
最近新开发的项目中须要使用到国际化功能,项目是基于SpringBoot来进行开发,借此机会整理一篇关于SpringBoot实现国际化i18n功能的文章,分享给你们。前端

依赖引入

在Spring Boot的web项目中无需引入其余特殊的配置,默认的web starter中便已经涵盖了所需的基础组件。对应的依赖pom配置以下:web

org.springframework.boot spring-boot-starter-web 2.2.2.RELEASE

国际化项目结构

这里的项目主要是对外部的api接口,也就是先后端分离的项目。重点介绍后台的国际化配置,以及在接口使用中怎么根据key获取到对应的国际化文案内容。spring

首先经过总体看一下项目的目录结构:后端

image

配置解析器

在上面引入了对应的依赖以后,首先用来初始化LocaleResolver类,该类为默认的解析器,用于设置当前会话的默认国际化语言。api

/**

  • 配置国际化语言

  • */
    @Configuration
    public class LocaleConfig {

    /**

    • 默认解析器 其中locale表示默认语言
    • /
      @Bean
      public LocaleResolver localeResolver() {
      SessionLocaleResolver localeResolver = new SessionLocaleResolver();
      localeResolver.setDefaultLocale(Locale.CHINA);
      return localeResolver;
      }
      }

这里是经过@Configuration注解来实例化配置类,在该配置类中经过@Bean注解的方法注入了建立的SessionLocaleResolver。微信

配置拦截器

有了解析器,还须要拦截器来对请求的语言参数进行获取,采用默认的LocaleChangeInterceptor做为拦截器来指定切换国际化语言的参数名。好比当请求的url中包含?lang=zh_CN表示读取国际化文件messages_zh_CN.properties。app

/**

  • Web相关配置

  • */
    @Configuration
    public class WebConfig implements WebMvcConfigurer {

    /**

    • 默认拦截器 其中lang表示切换语言的参数名
    • /
      @Override
      public void addInterceptors(InterceptorRegistry registry) {
      LocaleChangeInterceptor localeInterceptor = new LocaleChangeInterceptor();
      localeInterceptor.setParamName(“lang”);
      registry.addInterceptor(localeInterceptor);
      }
      }

这里经过实现接口WebMvcConfigurer的addInterceptors方法来完成拦截器的初始化和对应参数的设置。前后端分离

国际化文件

在完成了上面的基础配置以后,就须要定义具体的国际化文件,在文件中定义具体要进行国际化的参数项。ide

在Spring Boot中国际化文件的名称默认为messages,咱们这里就以messages来定义国际化文件。spring-boot

依次定义messages.properties、messages_en_US.properties、messages_zh_CN.properties、messages_zh_TW.properties。

其中messages.properties表示默认的,里面能够没有值,但必须有这样的一个文件,其余三个分别对应英文、中文、中文繁体。

三个文件的内容依次为:

username=zhangsan

username=张三

username=張三

这里针对国际化文件的放置位置仍是有讲究的,若是采用Spring Boot默认的查找路径,那么直接放在resources顶级目录下便可。

但若是想放到其余目录下,好比statistics/i18n/目录下,则须要在application.properties中配置以下:

spring.messages.basename=statistics/i18n/messages

注意前面是没有斜杠的,表示相对路径。而文件名为messages,也不须要添加properties后缀。用过Spring Boot的都知道它会为我们处理的。

工具类

若是是页面获取国际化内容,则此时后台的操做已经算是完事了,就差前端进行对应的js处理和展现了。咱们这里若是只提供api的话,针对api内部份内容的国际化,仍是须要根据key来获取对应的值的。

这里就须要一个工具类,来进行处理:

/**

  • 国际化工具类

  • */
    @Component
    public class MessageUtils {

    private static MessageSource messageSource;

    public MessageUtils(MessageSource messageSource) {

      MessageUtils.messageSource = messageSource;

    }

    /**

    • 获取单个国际化翻译值
    • /
      public static String get(String msgKey) {
      try {
        return messageSource.getMessage(msgKey, null, LocaleContextHolder.getLocale());
      } catch (Exception e) {
        return msgKey;
      }
      }

}

主要为了注入MessageSource,该工具上经过@Component进行了实例化。

具体使用

准备好以上内容以后,就能够在Controller层进行使用了,下面直接看代码。

@RestController
@RequestMapping(“/i18n”)
public class I18nController {

@RequestMapping("/user")
public String getUserName() {
    return MessageUtils.get("username");
}

}

直接定义了请求处理方法,在方法内经过key得到对应的国际化值。

而请求的url格式为:http://localhost:8080/i18n/user?lang=zh_TW

此时页面会展现:

張三

说明国际化的内容已经能够正常使用了。

最后,关注微信公众号“程序新视界”,回复“009”,获取完整源代码。

**程序新视界**:精彩和成长都不容错过

程序新视界-微信公众号

相关文章

springboot实现国际化,推荐这样实战使用

本作品采用《CC 协议》,转载必须注明作者和本文链接
zhaozhangxiao
讨论数量: 0
(= ̄ω ̄=)··· 暂无内容!

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!