最近新开发的项目中需要使用到国际化功能,项目是基于SpringBoot来进行开发,借此机会整理一篇关于SpringBoot实现国际化i18n功能的文章,分享给大家。

依赖引入

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

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <version>2.2.2.RELEASE</version>
</dependency>

国际化项目结构

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

首先通过整体看一下项目的目录结构:

image

配置解析器

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

/**
 * 配置国际化语言
 *
 **/
@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。

/**
 * 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方法来完成拦截器的初始化和对应参数的设置。

国际化文件

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

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

依次定义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实现国际化i18n功能插图(1)

关注公众号:程序新视界,一个让你软实力、硬技术同步提升的平台

除非注明,否则均为程序新视界原创文章,转载必须以链接形式标明本文链接

本文链接:http://www.choupangxia.com/2020/07/07/springboot-i18n/