最近新開發的項目中需要使用到國際化功能，項目是基於SpringBoot來進行開發，藉此機會整理一篇關於SpringBoot實現國際化i18n功能的文章，分享給大家。 依賴引入 在Spring Boot的web項目中無需引入其他特殊的配置，預設的web starter中便已經涵蓋了所需的基礎組件。對應 ...
最近新開發的項目中需要使用到國際化功能，項目是基於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獲取到對應的國際化文案內容。
首先通過整體看一下項目的目錄結構：
配置解析器
在上面引入了對應的依賴之後，首先用來初始化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”，獲取完整源代碼。
