Spring?boot?Thymeleaf配置國際化頁面詳解

更新時間：2022年07月16日 08:47:46 作者：悠然予夏

這篇文章主要給大家介紹了關于Spring?Boot?Thymeleaf實現(xiàn)國際化的相關資料，文中通過示例代碼介紹的非常詳細，對大家學習或者使用Spring?Boot具有一定的參考學習價值，需要的朋友們下面來一起學習學習吧

1．編寫多語言國際化配置文件

在項目的類路徑resources下創(chuàng)建名稱為i18n的文件夾，并在該文件夾中根據(jù)需要編寫對應的多語言國際化文件login.properties、login_zh_CN.properties和login_en_US.properties文件

login.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

login.properties為自定義默認語言配置文件，login_zh_CN.properties為自定義中文國際化文件，login_en_US.properties為自定義英文國際化文件

需要說明的是，Spring Boot默認識別的語言配置文件為類路徑resources下的messages.properties；其他語言國際化文件的名稱必須嚴格按照“文件前綴名語言代碼國家代碼.properties”的形式命名

本示例中，在項目類路徑resources下自定義了一個i18n包用于統(tǒng)一配置管理多語言配置文件，并將項目默認語言配置文件名自定義為login.properties，因此，后續(xù)還必須在項目全局配置文件中進行國際化文件基礎名配置，才能引用自定義國際化文件

2．編寫配置文件

打開項目的application.properties全局配置文件，在該文件中添加國際化文件基礎名設置，內(nèi)容如文件

# 配置國際化文件基礎名
spring.messages.basename=i18n.login

spring.messages.basename=i18n.login”設置了自定義國際化文件的基礎名。其中，i18n表示國際化文件相對項目類路徑resources的位置，login表示多語言文件的前綴名。如果開發(fā)者完全按照Spring Boot默認識別機制，在項目類路徑resources下編寫messages.properties等國際化文件，可以省略國際化文件基礎名的配置

3．定制區(qū)域信息解析器

在完成上一步中多語言國際化文件的編寫和配置后，就可以正式在前端頁面中結合Thymeleaf模板相關屬性進行國際化語言設置和展示了，不過這種實現(xiàn)方式默認是使用請求頭中的語言信息（瀏覽器語言信息）自動進行語言切換的，有些項目還會提供手動語言切換的功能，這就需要定制區(qū)域解析器了

在項目中創(chuàng)建名為com.lagou.config的包，并在該包下創(chuàng)建一個用于定制國際化功能區(qū)域信息解析器的自定義配置類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 {
    // 完成自定義 區(qū)域解析方式
    @Override
    public Locale resolveLocale(HttpServletRequest request) {
        // 獲取頁面手動傳遞的語言參數(shù)值 : zh_CN   en_US   ""
        String l = request.getParameter("l");
        Locale locale = null;
        if (!StringUtils.isEmpty(l)) {
            // 如果參數(shù)不為空，就根據(jù)參數(shù)值，進行手動語言切換
            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自定義區(qū)域解析器配置類實現(xiàn)了LocaleResolver接口，并重寫了其中的resolveLocale()方法進行自定義語言解析，最后使用@Bean注解將當前配置類注冊成Spring容器中的一個類型為LocaleResolver的Bean組件，這樣就可以覆蓋默認的LocaleResolver組件。其中，在resolveLocale()方法中，根據(jù)不同需求（手動切換語言信息、瀏覽器請求頭自動切換語言信息）分別獲取了請求參數(shù)l和請求頭參數(shù)Accept-Language，然后在請求參數(shù)l不為空的情況下就以l參數(shù)攜帶的語言為標準進行語言切換，否則就定制通過請求頭信息進行自動切換。

需要注意的是，在請求參數(shù)l的語言手動切換組裝時，使用的是下劃線“_”進行的切割，這是由多語言配置文件的格式?jīng)Q定的（例如login_zh_CN.properties）；而在請求頭參數(shù)Accept-Language的語言自動切換組裝時，使用的是短橫線“-”進行的切割，這是由瀏覽器發(fā)送的請求頭信息樣式?jīng)Q定的（例如Accept-Language: en-US,en;q=0.9,zh-CN;q=0.8,zh;q=0.7）

4．頁面國際化使用

打開項目templates模板文件夾中的用戶登錄頁面login.html，結合Thymeleaf模板引擎實現(xiàn)國際化功能

<!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訪問頁面的路徑，不同的是這次攜帶了參數(shù)，可以幫我們用來區(qū)分locale-->
            <a class="btn btn-sm" th:href="@{/toLoginPage(l='en_US')}" rel="external nofollow" >English</a>
        </form>
    </body>
</html>

使用Thymeleaf模板的#{}消息表達式設置了國際化展示的部分信息。在對記住我rememberme國際化設置時，需要國際化設置的rememberme在input標簽外部，所以這里使用了行內(nèi)表達式[[#login.rememberme}]]動態(tài)獲取國際化文件中的login.rememberme信息。另外，在表單尾部還提供了中文、English手動切換語言的功能鏈接，在單擊鏈接時會分別攜帶國家語言參數(shù)向“/”路徑請求跳轉，通過后臺定制的區(qū)域解析器進行手動語言切換。

注：省略了controller控制層處理