Spring MessageSource獲取消息不符合預期的問題解決方案

更新時間：2024年01月31日 08:37:58 作者：基督山伯爵_Neo

最近我參與的產品要做國際化支持,選擇了用Spring MessageSource來實現,這個Spring 框架提供的工具使用很簡單,網上有各種教程文章,這里不做贅述,只說一個實際遇到的問題及解決方案,需要的朋友可以參考下

場景

項目需要支持中、英文，所以在 spring boot 項目 resources 目錄下創(chuàng)建兩個消息配置文件 messages.properties 和 messages_en.properties 分別對應中文和英文消息。
項目中使用以下代碼獲取對應語種的消息（通過code）

@Component
@RequiredArgsConstructor
public class LocalizationUtils {

    private final MessageSource messageSource;

    public String getLocalizedMessageFromCode(String code) {
        // 語種信息由請求通過請求頭攜帶，例如英文為en_us
        final Locale locale = new Locale(language);
        return messageSource.getMessage(code, null, locale);
    }

}

項目打包為docker鏡像，部署到了K8S集群上，關鍵信息是：構建docker鏡像的基礎鏡像的默認語言是英文。

問題

當瀏覽器請求接口，攜帶請求頭信息為zh（期望獲取中文消息時），通過上面的工具類方法始終獲取到的是英文消息，不符合預期！

Spring 的 MessageSource 的工作方式

MessageSource在查找消息時，會首先嘗試使用與當前Locale完全匹配的消息文件。如果沒有找到完全匹配的文件，它會逐步回退到更通用的語言設置，最后回退到默認的messages.properties文件。

我創(chuàng)建了一個新的Locale對象，其語言設置為zh。然而，我的項目中沒有一個名為messages_zh.properties的文件，那么MessageSource將無法找到與zh完全匹配的消息文件。在這種情況下，它會回退到默認的messages.properties文件。
我的產品構建成docker鏡像，實際運行在docker中，構建docker鏡像的基礎鏡像的默認語言設置是英文。而MessageSource在回退到默認消息文件之前，會嘗試使用與操作系統(tǒng)語言設置匹配的消息文件。 在我的項目中對應的就是 messages_en.properties。
最后才會根據默認消息配置文件messages.properties返回消息。
另外，new Locale(language)方法創(chuàng)建Locale時，參數language大小寫 會影響結果，所以最好把language參數轉換成小寫，然后調用該方法。

解決辦法

Dockerfile 中添加行設置默認語言為中文，根據上面提到的機制，先找完全匹配的messages_zh.properties，然后嘗試使用與操作系統(tǒng)語言設置匹配的消息文件messages_zh.properties，因為這個消息文件不存在，所以使用messages.properties。

ENV LANG zh_CN.UTF-8

設置應用程序的默認語言為中文，在啟動類中添加一行代碼

@SpringBootApplication
public class AppApplication {

    public static void main(String[] args) {
        // 設置默認語言為中文
        Locale.setDefault(new Locale("zh"));
        SpringApplication.run(AppApplication.class, args);
    }

}