最近新開發的專案中需要使用到國際化功能,專案是基于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”,獲取完整源代碼,

轉載請註明出處,本文鏈接:https://www.uj5u.com/houduan/148747.html
標籤:Java
上一篇:操作OFFICE,BCB6.0
