SpringBoot實現國際化i18n功能

最近新開發的項目中須要使用到國際化功能,項目是基於SpringBoot來進行開發,藉此機會整理一篇關於SpringBoot實現國際化i18n功能的文章,分享給你們。前端

依賴引入

在Spring Boot的web項目中無需引入其餘特殊的配置,默認的web starter中便已經涵蓋了所需的基礎組件。對應的依賴pom配置以下:web

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

國際化項目結構

這裏的項目主要是對外部的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」,獲取完整源代碼。


<center>程序新視界:精彩和成長都不容錯過</center>

程序新視界-微信公衆號

相關文章
相關標籤/搜索