Spring Boot 主要通過 Maven 或 Gradle 這樣的構(gòu)建系統(tǒng)以繼承方式添加依賴，同時繼承了 Spring 框架中的優(yōu)秀元素，減少了 Spring MVC 架構(gòu)中的復雜配置，內(nèi)置 Tomcat，Jetty 容器氧猬，使用 Java application 運行程序，而不是傳統(tǒng)地把 WAR 包置于 Tomcat 等容器中運行坏瘩，從而簡化加速開發(fā)流程盅抚。此外，Spring Boot 學習簡單桑腮、輕量級、容易擴展蛉幸∑铺郑基于這些優(yōu)秀的特點，Spring Boot 成為了蓬勃發(fā)展的快速應(yīng)用開發(fā)領(lǐng)域的領(lǐng)導者奕纫。
在互聯(lián)網(wǎng)日益發(fā)展的當今時代提陶，一個應(yīng)用程序需要在全球范圍內(nèi)使用勢在必然。傳統(tǒng)的程序設(shè)計方法將可翻譯信息如菜單按鈕的標簽匹层、提示信息隙笆、幫助文檔等文字信息硬編碼在程序代碼中，但這些已經(jīng)不能很好的適應(yīng)全球化發(fā)展升筏，而且程序的擴展性差撑柔，維護成本高。一個能支持全球化的應(yīng)用程序您访，必須實現(xiàn)單一可執(zhí)行的程序铅忿，動態(tài)地使用資源（Single Source Single Executable）。
對于一個能支持全球化的應(yīng)用程序來說灵汪，需要考慮下面三方面的設(shè)計檀训，如圖 1 所示柑潦。
圖 1. 多語言應(yīng)用程序模型
-
區(qū)域模型的定制化（Locale Model）:
Locale 模型是一個多語言應(yīng)用程序的基礎(chǔ)，用來確定界面語言以及日期時間等的格式化方式峻凫，通常包括語言環(huán)境（Language Locale）和文化環(huán)境（Cultural Locale）渗鬼。一個應(yīng)用程序的 Locale 獲取有下面幾種常見的方式:
Locale.getDefault();
一個應(yīng)用程序具體選擇哪種方式獲取區(qū)域信息（Locale），這需要取決于該應(yīng)用程序的用戶需求荧琼。
資源文件的外部化: 這里主要指界面語言譬胎，根據(jù)用戶選擇的 Locale 模型，自動地顯示與之對應(yīng)的界面語言铭腕，讓客戶感覺這個產(chǎn)品是為他們而設(shè)計的银择。
日期時間等多元文化的支持: 包括貨幣、日歷累舷、時間浩考、日期、排序被盈、界面方向性（Bi-directional) 等符合各個國家自己習慣的顯示方式析孽。
下面主要從上述三方面分別介紹基于 Spring Boot 應(yīng)用程序如何支持多語言的，包括 RESTful 消息和內(nèi)容的國際化支持只怎。
Spring Boot 中的區(qū)域模型介紹
在自定義應(yīng)用程序區(qū)域模型（Locale）之前袜瞬，需要了解一下 Spring Boot 中區(qū)域解析器的原理∩肀ぃ基于 Spring 框架的應(yīng)用程序中邓尤，用戶的區(qū)域信息是通過區(qū)域解析器 LocaleResolver 來識別的，LocaleResolver 是 Spring 框架基于 Web 提供的區(qū)域解析器接口贴谎，允許通過 HTTP 請求和響應(yīng)修改區(qū)域設(shè)置汞扎，如清單 1 所示。
清單 1. Spring 框架中的區(qū)域解析器
public interface LocaleResolver {
Locale resolveLocale(HttpServletRequest request);
void setLocale(HttpServletRequest request, @Nullable HttpServletResponse response, @Nullable Locale locale);
}
LocaleResolver 在 Spring 框架中有四種具體的實現(xiàn)：
- 按 HTTP 請求頭部解析區(qū)域（AcceptHeaderLocaleResolver）: Spring 采用的默認區(qū)域解析器就是基于請求頭部擅这，它通過檢驗 HTTP 請求的 accept-language 頭部來解析區(qū)域澈魄，這個頭部是由用戶的 Web 瀏覽器設(shè)定決定的。
- 按會話屬性解析區(qū)域（SessionLocaleResolver）: 它通過檢驗用戶會話中預置的屬性來解析區(qū)域仲翎。如果該會話屬性不存在痹扇，它會根據(jù) accept-language HTTP 頭部確定默認區(qū)域。
- 按 Cookie 解析區(qū)域（CookieLocaleResolver）: 如果 Cookie 存在溯香，它會根據(jù) accept-languageHTTP 頭部確定默認區(qū)域鲫构。
- FixedLocaleResolver: 此解析器始終返回固定的默認區(qū)域設(shè)置，通常取自 JVM 的默認區(qū)域設(shè)置。
除了 Spring 框架中提供的四種實現(xiàn)外，還可以創(chuàng)建自定義的區(qū)域解析器嘲碧。在 Spring Boot 自動配置中可以看到清單 2 的代碼冗荸。
清單 2. 自定義 Spring 框架中的區(qū)域解析器
//向容器中加入了 LocaleResolver 對象
@Bean
@ConditionalOnMissingBean
@ConditionalOnProperty(
prefix = "spring.mvc",
name = {"locale"}
)
public LocaleResolver localeResolver() {
if (this.mvcProperties.getLocaleResolver() == org.springframework.boot.autoconfigure.web.servlet.WebMvcProperties.LocaleResolver.FIXED) {
return new FixedLocaleResolver(this.mvcProperties.getLocale());
} else {
AcceptHeaderLocaleResolver localeResolver = new AcceptHeaderLocaleResolver();
localeResolver.setDefaultLocale(this.mvcProperties.getLocale());
return localeResolver;
}
}
當我們的應(yīng)用程序需要自定義區(qū)域解析器（LocaleResovler）的時候禀梳，可以通過下面幾個步驟實現(xiàn)杜窄。
第一步：自定義區(qū)域解析器
自定義區(qū)域解析器是對 Spring 中 LocaleResolver 接口的實現(xiàn)，可以基于應(yīng)用程序的實際需求算途，取自于用戶自定義的語言選擇界面塞耕、用戶操作系統(tǒng)或者瀏覽器的語言設(shè)定。清單 3 是一個示例嘴瓤，首先判斷用戶請求中是否含有 lang 這個參數(shù)扫外，如果有，就使用這個參數(shù)所帶的區(qū)域信息廓脆；如果沒有筛谚，就取自瀏覽器請求頭部中的 accept-language 信息。
清單 3. 自定義區(qū)域解析器
public class CustomLocaleResolver implements LocaleResolver{
@Override
public Locale resolveLocale(HttpServletRequest request) {
String paramLanguage = request.getParameter("lang");
if(!StringUtils.isEmpty(paramLanguage)){
String[] splits = paramLanguage.split("-");
return new Locale(splits[0], splits[1]);
}else{
String acceptLanguage = request.getHeader("Accept-Language").split(",")[0];
String[] splits = acceptLanguage.split("-");
return new Locale(splits[0], splits[1]);
}
// 如果想使用當前系統(tǒng)的語言停忿，則使用Locale.getDefault()
}
@Override
public void setLocale(HttpServletRequest request, HttpServletResponse response, Locale locale) {
}
}
第二步： 將自定義的區(qū)域解析器添加到 IOC 容器中
通常添加在自定義的 config 文件中驾讲，下面的例子將自定義的 CustomLocaleResolver 通過 @Bean
注添加到 IOC 容器，如清單 4 所示席赂。
清單 4. 自定義區(qū)域解析器添加到 IOC
@Configuration
public class CustomMvcConfigure extends WebMvcConfigurationSupport {
@Bean
public LocaleResolver localeResolver(){
return new CustomLocaleResolver();
}
}
如此吮铭，在程序中就可以調(diào)用我們自定義的區(qū)域解析器。
Thymeleaf 模板引擎對多語言的支持
Thymeleaf 是一個基于 Apache License 2.0 許可颅停，支持 XML谓晌、XHTML、HTML5 的開源模板引擎癞揉，主要用于 Web 或者非 Web 環(huán)境中的應(yīng)用開發(fā)纸肉，在有網(wǎng)絡(luò)和無網(wǎng)絡(luò)的環(huán)境下皆可運行，它既可以在瀏覽器端查看靜態(tài)頁面喊熟，也可以顯示動態(tài)頁面柏肪。這是由于它支持 HTML 原型，然后在 HTML 標簽里增加額外的屬性來達到模板+ 數(shù)據(jù)的展示方式逊移。瀏覽器解析 HTML 時會忽略未定義的標簽屬性预吆，所以 Thymeleaf 模板可以靜態(tài)地運行龙填；當有數(shù)據(jù)返回到頁面時胳泉，Thymeleaf 標簽會動態(tài)地替換掉靜態(tài)內(nèi)容，使頁面動態(tài)顯示岩遗。
在 Spring MVC 框架中扇商，通常我們用 JSP 來展示 Web 前端，JSP 本質(zhì)上也是模板引擎宿礁，然而 Spring Boot 官方推薦使用 Thymeleaf 模板引擎案铺，Thymeleaf 完全可以替代 JSP 或者其他模板引擎如 Velocity、FreeMarker 等梆靖。雖然 Spring 官方推薦使用 Thymeleaf控汉，但是并不是說 Spring Boot 不支持 JSP笔诵。
在 Spring Boot 項目中使用 Thymeleaf 模板支持多語言的步驟如下：
第一步: 封裝用戶語言環(huán)境
在我們的實驗中，設(shè)計一個簡單的登錄頁面姑子，登錄頁面有個語言選擇下拉列表乎婿，將使用用戶選的語言來顯示登錄頁面上的標簽，如圖 2 所示街佑。
圖 2. 資源文件組織結(jié)構(gòu)
為了使我們的程序能夠使用指定的 Locale,首先需要添加 LocaleResolver Bean谢翎。在我們的示例中，使用了用戶選擇的 Locale沐旨，所以需要配置 LocaleChangeInterceptor 攔截器森逮，主要用來檢查傳入的請求，如果請求中有 lang 的參數(shù)(可配置）磁携，如 http://localhost:8089/login?lang=zh_CN 褒侧，那么該 Interceptor 將使用 localResolver 改變當前用戶的默認 Locale。清單 5 為示例代碼颜武，根據(jù)用戶選擇的語言顯示對應(yīng)的界面璃搜。
清單 5. 自定義 LocaleResolver
@Configuration
@ComponentScan(basePackages = "com.example.config")
public class MvcConfig implements WebMvcConfigurer {
@Bean
public LocaleResolver localeResolver() {
SessionLocaleResolver slr = new SessionLocaleResolver();
slr.setDefaultLocale(Locale.US);
return slr;
}
@Bean
public LocaleChangeInterceptor localeChangeInterceptor() {
LocaleChangeInterceptor lci = new LocaleChangeInterceptor();
lci.setParamName("lang");
return lci;
}
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(localeChangeInterceptor());
}
}
第二步: 定義多語言資源文件
默認情況下，資源文件是直接放在 src/main/resource 目錄下鳞上，為了實現(xiàn)代碼的結(jié)構(gòu)化这吻，我們在 resource 目錄下創(chuàng)建 i18n 文件夾，然后在 i18n 目錄下創(chuàng)建資源文件（當然也可以在 i18n目錄下創(chuàng)建不同的子目錄篙议，在子目錄下再創(chuàng)建資源文件）唾糯，這種情況下，我們需要在配置文件 application.properties 中重新指定資源文件的 basename：spring.messages.basename 鬼贱。資源文件名可以根據(jù)自己的項目定義移怯，但是通常的規(guī)范是：模塊名語言國家 .properties ，在本實例中我們命名為如 log_zh_CN.properties ,資源文件的目錄結(jié)構(gòu)如圖 3 所示这难。
圖 3. 資源文件組織結(jié)構(gòu)
對應(yīng)資源文件中的每一個 property key 舟误，一般都是小寫字母開頭，用下劃線表示這個 key 在程序中的層級結(jié)構(gòu)姻乓，并且按照字母順序排序嵌溢，便于管理和查找，如清單 6 所示蹋岩。
清單 6. 英文資源文件示例
login_home=Home
login_login=Log In
login_login_page=Login page
login_languge_selector=Language Selector
login_please_select_language_to_display=Please select the language to display
login_password=Password
login_username=Username
第三步：在 Thymeleaf 模板引擎中調(diào)用多語言資源
在 Spring Boot 架構(gòu)中使用 Thymeleaf 模板赖草，首先需要在 pom.xml 中引入 Thymeleaf 模板依賴 pring-boot-starter-thymeleaf ，如清單 7 所示剪个。
清單 7. pom.xml 引入依賴
><dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
此外秧骑，還需要在 application.properties 中配置 Thymeleaf 視圖解析器，如清單 8 所示。
清單 8. 配置 Thymeleaf
>#============ thymeleaf ====================================
spring.thymeleaf.mode=HTML
spring.thymeleaf.encoding=UTF-8
spring.thymeleaf.servlet.content-type=text/html
spring.thymeleaf.prefix=classpath:/templates/
spring.thymeleaf.cache=false
根據(jù)業(yè)務(wù)需求編寫 Thymeleaf 模板 HTML 文件乎折，默認的模板映射路徑是: src/main/resources/templates 绒疗，也可以在 application.properties 中配置自定義的模板路徑 spring.thymeleaf.prefix=classpath:/templates/myTemplates/ 。
在 Thymeleaf 模板文件中骂澄，將所有的硬編碼字符串抽取出來放到資源文件中忌堂，然后用資源文件中的鍵值 #{Property Key} 來表示界面顯示的標簽信息：
- 普通的標簽字符串：用
**th:**text= "#{login_login}"表示； - 作為賦值的字符串酗洒，如
value="Login"士修，表示成**th:**value="#{login_login}"；如placeholder="Login"樱衷，表示成**th:**placeholder="#{login_login}"
清單 9 是一個簡單登錄頁面的 Thymeleaf 模板內(nèi)容(只列出了部分關(guān)鍵代碼)棋嘲，其中所有顯示的標簽信息都抽取到資源文件中，如 th:text="#(login_login_page)" 矩桂，從而根據(jù)用戶選擇的語言自動讀取對應(yīng)的資源文件中的字符串來顯示沸移。
清單 9. 編寫 Thymeleaf 模板文件
><body>
<div layout:fragment="content" th:remove="tag">
<div class="row">
<div class="col-md-6 col-md-offset-3">
<h1 th:text="#{login_login_page}"></h1>
<form th:action="@{/login}" method="post">
<div class="form-group">
<label for="username" th:text="#{login_username}"></label>:
<input type="text" id="username" name="username" class="form-control" autofocus="autofocus" th:placeholder="#{login_username}">
</div><div class="form-group">
<label for="password" th:text="#{login_password}"></label>:
<input type="password" id="password" name="password"
class="form-control" th:placeholder="#{login_password}">
</div> <div class="form-group">
<div class="row">
<div class="col-sm-6 col-sm-offset-3">
<input type="submit" name="login-submit" id="login-submit"
class="form-control btn btn-info" th:value="#{login_login}">
</div></div></div>
</form></div></div>
<div class="row"><div class="col-md-6 col-md-offset-3">
<div class="form-group">
<label th:text="#{login_languge_selector}"></label>
<select class="form-control" id ="locales">
<option value="" th:text="#{login_please_select_language_to_display}"></option>
<option th:selected="${displayLang=='en_US'}" value="en_US">English</option>
<option th:selected="${displayLang=='zh_CN'}" value="zh_CN">簡體中文</option>
<option th:selected="${displayLang=='ja_JP'}" value="ja_JP">日本語</option>
<option th:selected="${displayLang=='zh_TW'}" value="zh_TW">繁體中文</option>
</select>
</div></div><div></div></div></div>
</body>
在實驗中遇到一個問題，界面字符串全部顯示為 ??Properties_Key_語言?? 侄榴，如圖 4 所示雹锣。
圖 4. 不能正確讀取 properties 文件
經(jīng)過一步步排查，原因是在配置文件 application.properties 錯誤配置了資源文件的路徑如圖 5 所示癞蚕。正確的路徑為 spring.messages.basename=**i18n/login** 蕊爵。
圖 5. spring.messages.basename 路徑不正確
Spring Boot 中時間日期格式化
Java 8 提供了更便捷的日期時間 API 如 LocalDate、LocalTime 和 LocalDateTime桦山，Spring Boot 架構(gòu)中推薦使用 Java 8 中新的時間日期 API攒射。LocalDate 較 Date 類的優(yōu)點體現(xiàn)在以下幾個方面:
- Date 類打印出來的日期可讀性差，通常需要使用
SimpleDateFormat進行格式化恒水，而 LocalDate 默認的格式為YYYY-MM-DD会放。 - LocalDate 較 Date 在日期計算及格式化方面更簡單易用。
- Date 類同時包括了日期和時間钉凌，而 LocalDate咧最、LocalTime 和 LocalDateTime 分別表示日期、時間御雕、日期和時間矢沿，使用起來非常靈活。
- Date 類不支持多線程安全饮笛，LocalDate 等新的接口是線程安全的咨察。
對于后臺 Java 程序中的時間日期格式化問題论熙，通常會重新定制化時間日期格式化接口福青，比如將 Locale 參數(shù)、想要顯示的樣式參數(shù)傳入進去。清單 10 是格式化時間日期的接口示例代碼无午，清單 11 是具體實現(xiàn)的示例代碼媒役，這里只列舉了幾種典型的格式化情況。
清單 10. 時間日期格式化接口
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.util.Locale;
public interface I18nFormatter {
String formaFullDateTime(LocalDateTime date, Locale locale);
String formatFullDate(LocalDate originalDate, Locale locale);
String formatMediumDateTime(LocalDateTime date, Locale locale);
String formatMediumDate(LocalDate originalDate, Locale locale);
String formatMediumDateShortTime(LocalDateTime date, Locale locale);
String formatMediumTime(LocalTime originalDate, Locale locale);
String formatShortDateTime(LocalDateTime originalDate, Locale locale);
String formatShortDate(LocalDate originalDate, Locale locale);
String formatShortTime(LocalTime originalDate, Locale locale);
String formatShortDateMediumTime(LocalDateTime originalDate, Locale locale);
清單 11. 時間日期格式化實現(xiàn)
@Service("I18nFormatter")
public class I18nFormatterImpl implements I18nFormatter {
@Override
public String formatFullDate(LocalDate originalDate, Locale locale) {
DateTimeFormatter dateFormat =DateTimeFormatter.ofLocalizedDate(FormatStyle.FULL).withLocale(locale);
return dateFormat.format(originalDate);
}
@Override
public String formatMediumDateTime(LocalDateTime date, Locale locale) {
DateTimeFormatter dateFormat = DateTimeFormatter.ofLocalizedDateTime(FormatStyle.MEDIUM, FormatStyle.MEDIUM).withLocale(locale);
return dateFormat.format(date);
}
@Override
public String formatShortTime(LocalTime originalDate, Locale locale) {
DateTimeFormatter dateFormat = DateTimeFormatter.ofLocalizedTime(FormatStyle.SHORT).withLocale(locale);
return dateFormat.format(originalDate);
}
}
在 Spring Boot 架構(gòu)中接口與接口之間宪迟、前后端之間都使用 JSON 格式傳輸數(shù)據(jù)酣衷。對于日期格式的數(shù)據(jù)，如果采用默認方式不做處理次泽，易讀性和可用性不是很好穿仪。如清單 12 就是默認 JSON 格式的日期。請求得到的 JSON 格式日期可讀性很差意荤，如圖 6 所示啊片。
清單 12. 默認的時間日期
@RestController
public class LocalDateTimeController {
@GetMapping("/time")
public DateTime timeMapping() {
return new DateTime();
}
public class DateTime {
protected LocalDate localDate;
protected LocalDateTime localDateTime;
protected LocalTime localTime;
public DateTime() {
localDate = LocalDate.now();
localDateTime = LocalDateTime.now();
localTime = LocalTime.now();
}
public LocalDate getLocalDate() {
return localDate;
}
public LocalDateTime getLocalDateTime() {
return localDateTime;
}
public LocalTime getLocalTime() {
return localTime;
}
}
圖 6. 默認格式返回的 JSON 格式日期
下面我們采用 @JsonFormat 序列化屬性值，如清單 13 所示玖像。
清單 13. 使用 @JsonFormat 進行標注
public class JsonDateTime extends DateTime {
@Override
@JsonFormat(pattern="yyyy-MM-dd")
public LocalDate getLocalDate() {
return super.localDate;
}
@Override
@JsonFormat(pattern="yyyy-MM-dd HH:mm")
public LocalDateTime getLocalDateTime() {
return super.localDateTime;
}
@Override
@JsonFormat(pattern="HH:mm")
public LocalTime getLocalTime() {
return localTime;
}
圖 7. @JsonFormat 格式化后的 Json 格式日期
清單 13 我們只是對 JSON 格式的日期進行了格式化紫谷，但是還沒有實現(xiàn)多語言化。我們采用中定義的多語言格式化方法對 JSON 格式日期進行格式化捐寥，將日期參數(shù)定義為 String 類型笤昨。如清單 14 所示。
清單 14. 使用多語言格式化方法
@RestController
public class LocalDateTimeController{
@GetMapping("/g11nDateTime")
public G11nDateTime g11nDateTimeMapping(@RequestParam(value = "language") String language) {
Locale locale = new Locale("en", "US");
if(!StringUtils.isEmpty(language)){
String[] splits = language.split("_");
locale = new Locale(splits[0], splits[1]);
}
return new G11nDateTime(locale);
}
public class G11nDateTime {
protected String localDate;
protected String localDateTime;
protected String localTime;
public G11nDateTime(Locale locale) {
I18nFormatterImpl formatter = new I18nFormatterImpl();
localDate = formatter.formatFullDate(LocalDate.now(), locale);
localDateTime = formatter.formatMediumDateShortTime(LocalDateTime.now(), locale);
localTime = formatter.formatShortTime(LocalTime.now(), locale);
}
public String getLocalDate() {
return localDate;
}
public String getLocalDateTime() {
return localDateTime;
}
public String getLocalTime() {
return localTime;
}
}
當傳入的語言參數(shù)為 zh_CN 時握恳，響應(yīng)的日期如圖 8 所示瞒窒。
圖 8. 多語言的 JSON 格式日期
Spring Boot RESTful API 多語言支持
隨著 Spring Boot 的快速發(fā)展，基于 RESTful
準的微服務(wù)接口應(yīng)用也越來越廣泛乡洼，RESTful API 使用 HTTP 協(xié)議來表示創(chuàng)建根竿、檢索、更新和刪除 (CRUD) 操作就珠。下面主要介紹在 Spring Boot 框架下寇壳，如何實現(xiàn)服務(wù)器端 RESTful API 的多語言支持，主要涉及到返回的內(nèi)容和消息妻怎。通常有以下幾方面需要考慮壳炎，如圖 9 所示。
圖 9. RESTful API 多語言支持
第一步: 封裝和自定義資源文件讀取工具
現(xiàn)行的開發(fā)框架大部分都會提供接口讀取資源文件逼侦。涉及到資源文件讀取時匿辩，ResourceBundle 是一個機制，主要用來根據(jù)不同的用戶區(qū)域信息自動地讀取對應(yīng)的資源文件榛丢，ResourceBundle 是 Java 中的資源文件讀取接口铲球，圖 10 總結(jié)了 Java 程序中 ResourceBundle 的管理機制。
圖 10. Java 程序 Resource Bundle 管理流程
Spring 定義了訪問資源文件的 MessageSource 接口晰赞，該接口有幾個重要的方法用來讀取資源文件稼病，如表 1 所示选侨。
表 1. MessageSource 接口說明
| 方法名 | 說明 |
|---|---|
String getMessage(String code, Object[] args, String defaultMessage, Locale locale) |
code ：表示資源文件中的 Property Key 。 |
args ：用于傳遞占位符所代表的運行期參數(shù)然走。
defaultMessage ：當在資源找不到對應(yīng)屬性名時援制，返回參數(shù)所指定的默認值。
locale ：表示區(qū)域信息芍瑞。 |
| String getMessage(String code, Object[] args, Locale locale)throws NoSuchMessageException | 找不到資源中對應(yīng)的屬性名時晨仑，直接拋出 NoSuchMessageException 異常。 |
| String getMessage(MessageSourceResolvable resolvable, Locale locale) throws NoSuchMessageException | 將屬性名拆檬、參數(shù)數(shù)組以及默認信息封裝起來洪己，它的功能和第一個接口方法相同。 |
MessageSource 被 HierarchicalMessageSource 和 ApplicationContext 兩個接口繼承竟贯，如圖 11 所示码泛。
圖 11. MessageSource 類圖
ResourceBundleMessageSource 和 ReloadableResourceBundleMessageSource 是在 Java ResourceBundle 基礎(chǔ)上 HierarchicalMessageSource 的兩個具體實現(xiàn)類。他們與 ResourceBundle 的區(qū)別是不需要分別加載不同語言的資源文件澄耍，通過資源文件名 （baseName） 就可以加載整套的國際化資源文件噪珊；同時不再需要顯示的調(diào)用 MessageFormat 方法，使用起來更加簡單便捷齐莲；還可以讀取 XML 格式的資源文件痢站。
`ReloadableResourceBundleMessageSource` 可以定時刷新資源文件，以便在應(yīng)用程序不重啟的情況下感知資源文件的更新选酗，還可以設(shè)置讀取資源文件的編碼方式阵难。 `cacheSeconds` 屬性讓 `ReloadableResourceBundleMessageSource` 根據(jù)設(shè)定的時間刷新監(jiān)測資源文件是否有更新，但是刷新周期不能太短芒填，否則影響應(yīng)用程序的性能呜叫。如果 `cacheSeconds` 設(shè)置 -1，表示永遠不刷新殿衰，這個時候 `ReloadableResourceBundleMessageSource` 和 `ResourceBundleMessageSource` 功能等同朱庆。
清單 15 在 ReloadableResourceBundleMessageSource 類的基礎(chǔ)上，自定義資源文件讀取接口闷祥，讀取自定路徑的資源文件娱颊。
清單 15. 自定義資源文件讀取接口
public class CustomizeMessageResource {
private final static Logger logger = LoggerFactory.getLogger(CustomizeMessageResource.class);
private static MessageSourceAccessor accessor;
private static final String PATH_PARENT = "classpath:i18n/";
private static final String SUFFIX = ".properties";
public CustomizeMessageResource() {}
private void initMessageSourceAccessor() throws IOException{
logger.info("init initMessageSourceAccessor...");
ResourcePatternResolver resourcePatternResolver = new PathMatchingResourcePatternResolver();
Resource resource = resourcePatternResolver.getResource(PATH_PARENT + "message" + SUFFIX);
String fileName = resource.getURL().toString();
int lastIndex = fileName.lastIndexOf(".");
String baseName = fileName.substring(0,lastIndex);
ReloadableResourceBundleMessageSource reloadableResourceBundleMessageSource = new ReloadableResourceBundleMessageSource();
reloadableResourceBundleMessageSource.setBasename(baseName);
reloadableResourceBundleMessageSource.setCacheSeconds(1800);
reloadableResourceBundleMessageSource.setDefaultEncoding("UTF-8");
accessor = new MessageSourceAccessor(reloadableResourceBundleMessageSource);
}
public String getMessage(String key, String lang) throws IOException {
initMessageSourceAccessor();
Locale locale = new Locale("en", "US");
if (!lang.isEmpty()) {
locale = new Locale(lang.split("_")[0], lang.split("_")[1]);
}
return accessor.getMessage(key, null, "No such Property key", locale);
}
public String getMessage(String key, String lang, Object... parameters) throws IOException {
initMessageSourceAccessor();
Locale locale = new Locale("en", "US");
if (!lang.isEmpty()) {
locale = new Locale(lang.split("_")[0], lang.split("_")[1]);
}
return accessor.getMessage(key, parameters, "No such Property key", locale);
}
第二步: 設(shè)計多語言的 API 返回狀態(tài)碼
RESTful API 都會有返回狀態(tài)碼，為了支持多語言凯砍，在設(shè)計返回狀態(tài)碼接口的時候也需要考慮多語言的支持箱硕，下面以上傳文件為例來說明如何設(shè)計反饋狀態(tài)碼以及返回接口的封裝。在設(shè)計返回狀態(tài)碼的時候悟衩，涉及到顯示的消息內(nèi)容剧罩，這里用資源文件里的 Property Key 來表示，這樣在返回狀態(tài)封裝類中比較容易動態(tài)地讀取不同語言的返回消息座泳，如清單 16 所示惠昔。
清單 16. 多語言 API 返回狀態(tài)碼
public enum G11nUploadCode {
OK(200, "OK", "api_upload_response_ok"),
ERROR(400, "WRONG REQUEST", "api_upload_response_wrong_request"),
CREATED(201, "CREATED", "api_upload_response_create"),
UNAUTHORIZED(401, "UNAUTHORIZED", "api_upload_response_unauthorized"),
FORBIDDEN(403, "FORBIDDEN", "api_upload_response_forbidden"),
NOT_FOUND(404, "NOT FOUND", "api_upload_response_not_found");
private int code;
private String status;
private String propertyKey;
private G11nUploadCode(int code, String status, String propertyKey) {
this.code = code;
this.status= status;
this.propertyKey = propertyKey;
}
public void seCode(int code) {
this.code = code;
}
public int getCode() {
return this.code;
}
public String getStatus() {
return this.status;
}
public void seStatus(String status) {
this.status = status;
}
public void setPropertyKey(String propertyKey) {
this.propertyKey = propertyKey;
}
public String getPropertyKey() {
return this.propertyKey;
}
}
第三步: 多語言 API 返回接口封裝
利用第一步中自定義的資源文件讀取工具幕与，動態(tài)的讀取多余的返回信息，如清單 17 所示舰罚。
清單 17. 多語言 API 返回狀態(tài)碼
public class G11nUploadResult implements Serializable {
private static final long serialVersionUID = 1L;
private int code;
private String status;
private Object data;
public void setCode(int code) {
this.code = code;
}
public int getCode() {
return this.code;
}
public void setStatus(String status) {
this.status = status;
}
public String getStatus() {
return this.status;
}
public void setData(Object data) {
this.data = data;
}
public Object getData() {
return this.data;
}
public G11nUploadResult() {}
public G11nUploadResult(int code, String status, Object data) {
this.code = code;
this.status = status;
this.data = data;
}
public G11nUploadResult(G11nUploadCode responseCodeI18n, String language) throws IOException{
CustomizeMessageResource customizeMessageResource = new CustomizeMessageResource();
this.code = responseCodeI18n.getCode();
this.status = responseCodeI18n.getStatus();
System.out.println("Status: " + this.status);
this.data = customizeMessageResource.getMessage(responseCodeI18n.getPropertyKey(), language);
}
}
第四步: 在控制器中調(diào)用多語言的返回碼
本步操作如清單 18 所示。
清單 18. 控制器中調(diào)用多語言返回碼
@RestController
@Api(value="uploadFiles")
public class UploadFilesController {
private final Logger logger = LoggerFactory.getLogger(UploadFilesController.class);
private static String UPLOADED_FOLDER = "/users/tester/upload/";
@PostMapping("/uploadfiles")
public G11nUploadResult uploadFile(@RequestParam("file") MultipartFile uploadfile) throws IOException {
logger.debug("Single file uploa!");
G11nUploadResult result = new G11nUploadResult();
CustomizeMessageResource customizeMessageResource = new CustomizeMessageResource();
if (uploadfile.isEmpty()) {
return new G11nUploadResult(G11nUploadCode.ERROR, "zh_CN");
}
try {
saveUploadedFiles(Arrays.asList(uploadfile));
} catch (IOException e) {
return new G11nUploadResult(G11nUploadCode.NOT_FOUND, "zh_CN");
}
logger.info("Successfully uploaded - " + uploadfile.getOriginalFilename());
result.setStatus("OK");
result.setData(customizeMessageResource.getMessage("success_upload", "zh_CN", uploadfile.getOriginalFilename()));
return result;
}
}
圖 12 是測試上傳文件的結(jié)果薛耻，在調(diào)用 API 的時候营罢，傳遞的參數(shù)是簡體中文 (zh_CN) ，返回的狀態(tài)和信息顯示為中文信息饼齿，使用開發(fā)者熟悉的語言顯示返回信息便于讀取查看饲漾。
圖 12. MessageSource 類圖
結(jié)束語
本文總結(jié)了在 Spring Boot 框架下，如何開發(fā)一個多語言的應(yīng)用程序及 RESTful API缕溉。闡述了 Spring Boot 架構(gòu)下區(qū)域模型的原理考传，基于已有的區(qū)域模型定制化應(yīng)用程序自己的區(qū)域模型；Thymeleaf 模板引擎對多語言的支持证鸥；Spring Boot 中時間日期格式化僚楞；以及 Spring Boot RESTful API 多語言支持實踐。希望這篇文章能為正在開發(fā)國際化應(yīng)用程序和微服務(wù)的您提供一定的參考枉层。
