Spring boot Thymeleaf設定國際化頁面詳解

2022-07-16 14:01:41

1．編寫多語言國際化組態檔

在專案的類路徑resources下建立名稱為i18n的資料夾，並在該資料夾中根據需要編寫對應的多語言國際化檔案login.properties、login_zh_CN.properties和login_en_US.properties檔案

login.tip=請登入
login.username=使用者名稱
login.password=密碼
login.rememberme=記住我
login.button=登入

login_zh_CN.properties

login.tip=請登入
login.username=使用者名稱
login.password=密碼
login.rememberme=記住我
login.button=登入

login_en_US.properties

login.tip=Please sign in
login.username=Username
login.password=Password
login.rememberme=Remember me
login.button=Login

需要說明的是，Spring Boot預設識別的語言組態檔為類路徑resources下的messages.properties；其他語言國際化檔案的名稱必須嚴格按照“檔案字首名語言程式碼國家程式碼.properties”的形式命名

本範例中，在專案類路徑resources下自定義了一個i18n包用於統一設定管理多語言組態檔，並將專案預設語言組態檔名自定義為login.properties，因此，後續還必須在專案全域性組態檔中進行國際化檔案基礎名設定，才能參照自定義國際化檔案

2．編寫組態檔

開啟專案的application.properties全域性組態檔，在該檔案中新增國際化檔案基礎名設定，內容如檔案

# 設定國際化檔案基礎名
spring.messages.basename=i18n.login

spring.messages.basename=i18n.login”設定了自定義國際化檔案的基礎名。其中，i18n表示國際化檔案相對專案類路徑resources的位置，login表示多語言檔案的字首名。如果開發者完全按照Spring Boot預設識別機制，在專案類路徑resources下編寫messages.properties等國際化檔案，可以省略國際化檔案基礎名的設定

3．客製化區域資訊解析器

在完成上一步中多語言國際化檔案的編寫和設定後，就可以正式在前端頁面中結合Thymeleaf模板相關屬性進行國際化語言設定和展示了，不過這種實現方式預設是使用請求頭中的語言資訊（瀏覽器語言資訊）自動進行語言切換的，有些專案還會提供手動語言切換的功能，這就需要客製化區域解析器了

在專案中建立名為com.lagou.config的包，並在該包下建立一個用於客製化國際化功能區域資訊解析器的自定義設定類MyLocalResovel

package com.lagou.config;
 
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.util.StringUtils;
import org.springframework.web.servlet.LocaleResolver;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Locale;
@Configuration
public class MyLocalResolver implements LocaleResolver {
    // 完成自定義 區域解析方式
    @Override
    public Locale resolveLocale(HttpServletRequest request) {
        // 獲取頁面手動傳遞的語言引數值 : zh_CN   en_US   ""
        String l = request.getParameter("l");
        Locale locale = null;
        if (!StringUtils.isEmpty(l)) {
            // 如果引數不為空，就根據引數值，進行手動語言切換
            String[] s = l.split("_");
            locale = new Locale(s[0], s[1]);
        } else {
            // Accept-Language: zh-CN,zh;q=0.9
            String header = request.getHeader("Accept-Language");
            String[] split = header.split(",");
            String[] split1 = split[0].split("-");
            locale = new Locale(split1[0], split1[1]);
        }
        return locale;
    }
    @Override
    public void setLocale(HttpServletRequest request, HttpServletResponse response, Locale locale) {
    }
    // 將自定義的LocaleResolver重新註冊成一個型別為LocaleResolver的Bean元件
    @Bean
    public LocaleResolver localeResolver() {
        return new MyLocalResolver();
    }
}

MyLocalResolver自定義區域解析器設定類實現了LocaleResolver介面，並重寫了其中的resolveLocale()方法進行自定義語言解析，最後使用@Bean註解將當前設定類註冊成Spring容器中的一個型別為LocaleResolver的Bean元件，這樣就可以覆蓋預設的LocaleResolver元件。其中，在resolveLocale()方法中，根據不同需求（手動切換語言資訊、瀏覽器請求頭自動切換語言資訊）分別獲取了請求引數l和請求頭引數Accept-Language，然後在請求引數l不為空的情況下就以l引數攜帶的語言為標準進行語言切換，否則就客製化通過請求頭資訊進行自動切換。

需要注意的是，在請求引數l的語言手動切換組裝時，使用的是下劃線“_”進行的切割，這是由多語言組態檔的格式決定的（例如login_zh_CN.properties）；而在請求頭引數Accept-Language的語言自動切換組裝時，使用的是短橫線“-”進行的切割，這是由瀏覽器傳送的請求頭資訊樣式決定的（例如Accept-Language: en-US,en;q=0.9,zh-CN;q=0.8,zh;q=0.7）

4．頁面國際化使用

開啟專案templates模板資料夾中的使用者登入頁面login.html，結合Thymeleaf模板引擎實現國際化功能

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
        <meta name="viewport" content="width=device-width, initial-scale=1,shrinkto-
fit=no">
        <title>使用者登入介面</title>
        <link th:href="@{/login/css/bootstrap.min.css}" rel="external nofollow"  rel="stylesheet">
        <link th:href="@{/login/css/signin.css}" rel="external nofollow"  rel="stylesheet">
    </head>
    <body class="text-center">
        <!-- 使用者登入form表單 -->
        <form class="form-signin">
            <img class="mb-4" th:src="@{/login/img/login.jpg}" width="72" height="72">
            <h1 class="h3 mb-3 font-weight-normal" th:text="#{login.tip}">請登入</h1>
            <input type="text" class="form-control"
                   th:placeholder="#{login.username}" required="" autofocus="">
            <input type="password" class="form-control"
                   th:placeholder="#{login.password}" required="">
            <div class="checkbox mb-3">
                <label>
                    <input type="checkbox" value="remember-me" > [[#{login.rememberme}]]
                </label>
            </div>
            <button class="btn btn-lg btn-primary btn-block" type="submit" th:text="#{login.button}">登入</button>
            <p class="mt-5 mb-3 text-muted">© <span
                    th:text="${currentYear}">2019</span>-<span
                    th:text="${currentYear}+1">2020</span></p>
            <a class="btn btn-sm" th:href="@{/toLoginPage(l='zh_CN')}" rel="external nofollow" >中文</a> <!--注意這個路徑是我們controller存取頁面的路徑，不同的是這次攜帶了引數，可以幫我們用來區分locale-->
            <a class="btn btn-sm" th:href="@{/toLoginPage(l='en_US')}" rel="external nofollow" >English</a>
        </form>
    </body>
</html>

使用Thymeleaf模板的#{}訊息表示式設定了國際化展示的部分資訊。在對記住我rememberme國際化設定時，需要國際化設定的rememberme在input標籤外部，所以這裡使用了行內表示式[[#login.rememberme}]]動態獲取國際化檔案中的login.rememberme資訊。另外，在表單尾部還提供了中文、English手動切換語言的功能連結，在單擊連結時會分別攜帶國家語言引數向“/”路徑請求跳轉，通過後臺客制化的區域解析器進行手動語言切換。

注：省略了controller控制層處理