SpringBoot Thymeleaf使用教程(實用版)

使用Thymeleaf 三大理由:

    1. 簡潔漂亮 容易理解
    1. 完美支持HTML5 使用瀏覽器直接打開頁面
    1. 不新增標籤 只需增強屬性

學習目標

  • 快速掌握Thymeleaf的基本使用(五大基礎語法+常用內置對象)

快速查閱

專題閱讀:《SpringBoot 佈道系列》

源碼下載:SpringBoot Thymeleaf Enhance

官方指南: Thymleaf 3.0 官方教程

相關教程:SpringBoot Thymeleaf 基本介紹SpringBoot 在IDEA中實現熱部署(實用版)

使用教程

溫馨提示:Thymeleaf 最爲顯著的特徵是增強屬性,任何屬性都可以通過th:xx 來完成交互,例如th:value最終會覆蓋value屬性。

一、基礎語法

變量表達式 ${}

使用方法:直接使用th:xx = "${}" 獲取對象屬性 。例如:

<form id="userForm">
    <input id="id" name="id" th:value="${user.id}"/>
    <input id="username" name="username" th:value="${user.username}"/>
    <input id="password" name="password" th:value="${user.password}"/>
</form>

<div th:text="hello"></div>

<div th:text="${user.username}"></div>

選擇變量表達式 *{}

使用方法:首先通過th:object 獲取對象,然後使用th:xx = "*{}"獲取對象屬性。

這種簡寫風格極爲清爽,推薦大家在實際項目中使用。 例如:

<form id="userForm" th:object="${user}">
    <input id="id" name="id" th:value="*{id}"/>
    <input id="username" name="username" th:value="*{username}"/>
    <input id="password" name="password" th:value="*{password}"/>
</form>

鏈接表達式 @{}

使用方法:通過鏈接表達式@{}直接拿到應用路徑,然後拼接靜態資源路徑。例如:

<script th:src="@{/webjars/jquery/jquery.js}"></script>
<link th:href="@{/webjars/bootstrap/css/bootstrap.css}" rel="stylesheet" type="text/css">

片段表達式 ~{}

片段表達式是Thymeleaf的特色之一,細粒度可以達到標籤級別,這是JSP無法做到的。
片段表達式擁有三種語法:

  • ~{ viewName } 表示引入完整頁面
  • ~{ viewName ::selector} 表示在指定頁面尋找片段 其中selector可爲片段名、jquery選擇器等
  • ~{ ::selector} 表示在當前頁尋找

使用方法:首先通過th:fragment定製片段 ,然後通過th:replace 填寫片段路徑和片段名。例如:

<!-- /views/common/head.html-->
<head th:fragment="static">
        <script th:src="@{/webjars/jquery/3.3.1/jquery.js}"></script>
</head>

<!-- /views/your.html -->
<div th:replace="~{common/head::static}"></div>

在實際使用中,我們往往使用更簡潔的表達,去掉表達式外殼直接填寫片段名。例如:

<!-- your.html -->
<div th:replace="common/head::static"></div>

值得注意的是,使用替換路徑th:replace 開頭請勿添加斜槓,避免部署運行的時候出現路徑報錯。(因爲默認拼接的路徑爲spring.thymeleaf.prefix = classpath:/templates/

消息表達式

即通常的國際化屬性:#{msg} 用於獲取國際化語言翻譯值。例如:

 <title th:text="#{user.title}"></title>

其它表達式

在基礎語法中,默認支持字符串連接、數學運算、布爾邏輯和三目運算等。例如:

<input name="name" th:value="${'I am '+(user.name!=null?user.name:'NoBody')}"/>

二、內置對象

官方文檔: 附錄A: Thymeleaf 3.0 基礎對象
官方文檔: 附錄B: Thymeleaf 3.0 工具類

七大基礎對象:

  • ${#ctx} 上下文對象,可用於獲取其它內置對象。
  • ${#vars}: 上下文變量。
  • ${#locale}:上下文區域設置。
  • ${#request}: HttpServletRequest對象。
  • ${#response}: HttpServletResponse對象。
  • ${#session}: HttpSession對象。
  • ${#servletContext}: ServletContext對象。

常用的工具類:

  • #strings:字符串工具類
  • #lists:List 工具類
  • #arrays:數組工具類
  • #sets:Set 工具類
  • #maps:常用Map方法。
  • #objects:一般對象類,通常用來判斷非空
  • #bools:常用的布爾方法。
  • #execInfo:獲取頁面模板的處理信息。
  • #messages:在變量表達式中獲取外部消息的方法,與使用#{...}語法獲取的方法相同。
  • #uris:轉義部分URL / URI的方法。
  • #conversions:用於執行已配置的轉換服務的方法。
  • #dates:時間操作和時間格式化等。
  • #calendars:用於更復雜時間的格式化。
  • #numbers:格式化數字對象的方法。
  • #aggregates:在數組或集合上創建聚合的方法。
  • #ids:處理可能重複的id屬性的方法。

三、迭代循環

想要遍歷List集合很簡單,配合th:each 即可快速完成迭代。例如遍歷用戶列表:

<div th:each="user:${userList}">
    賬號:<input th:value="${user.username}"/>
    密碼:<input th:value="${user.password}"/>
</div>

在集合的迭代過程還可以獲取狀態變量,只需在變量後面指定狀態變量名即可,狀態變量可用於獲取集合的下標/序號、總數、是否爲單數/偶數行、是否爲第一個/最後一個。例如:

<div th:each="user,stat:${userList}" th:class="${stat.even}?'even':'odd'">
    下標:<input th:value="${stat.index}"/>
    序號:<input th:value="${stat.count}"/>
    賬號:<input th:value="${user.username}"/>
    密碼:<input th:value="${user.password}"/>
</div>

如果缺省狀態變量名,則迭代器會默認幫我們生成以變量名開頭的狀態變量 xxStat, 例如:

<div th:each="user:${userList}" th:class="${userStat.even}?'even':'odd'">
    下標:<input th:value="${userStat.index}"/>
    序號:<input th:value="${userStat.count}"/>
    賬號:<input th:value="${user.username}"/>
    密碼:<input th:value="${user.password}"/>
</div>

四、條件判斷

條件判斷通常用於動態頁面的初始化,例如:

<div th:if="${userList}">
    <div>的確存在..</div>
</div>

如果想取反則使用unless 例如:

<div th:unless="${userList}">
    <div>不存在..</div>
</div>

五、日期格式化

使用默認的日期格式(toString方法) 並不是我們預期的格式:Mon Dec 03 23:16:50 CST 2018

<input type="text" th:value="${user.createTime}"/>

此時可以通過時間工具類#dates來對日期進行格式化:2018-12-03 23:16:50

<input type="text" th:value="${#dates.format(user.createTime,'yyyy-MM-dd HH:mm:ss')}"/>

六、內聯寫法

  • (1)爲什麼要使用內聯寫法?·答:因爲 JS無法獲取服務端返回的變量。

  • (2)如何使用內聯表達式?答:標準格式爲:[[${xx}]] ,可以讀取服務端變量,也可以調用內置對象的方法。例如獲取用戶變量和應用路徑:

    <script th:inline="javascript">
        var user = [[${user}]];`
        var APP_PATH = [[${#request.getContextPath()}]];
        var LANG_COUNTRY = [[${#locale.getLanguage()+'_'+#locale.getCountry()}]];
    </script>
  • (3)標籤引入的JS裏面能使用內聯表達式嗎?答:不能!內聯表達式僅在頁面生效,因爲Thymeleaf只負責解析一級視圖,不能識別外部標籤JS裏面的表達式。

七、國際化

需要了解更多關於國際化的精彩描述請前往 SpringBoot 快速實現國際化i18n

例如在國際化文件中編寫了user.title這個鍵值,然後使用#{}讀取這個KEY即可獲取翻譯。

    <title th:text="#{user.title}">用戶登陸</title>

八、詳細教程

======== 有了上述基礎後 下面正式開始Thymeleaf 的詳細教程 ==============

首先通過Spring Initializr創建項目,如圖所示:

然後在POM文件引入web 、thymeleaf等依賴:

<dependencies>
        <dependency><!--Web相關依賴-->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency><!--頁面模板依賴-->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
        <dependency><!--熱部署依賴-->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
        </dependency>
    </dependencies>

然後在src/main/resources/application.yml 配置頁面路徑:

spring:
  thymeleaf:
    cache: false #關閉緩存
    prefix: classpath:/views/ #調整頁面路徑

接着在src/main/java/com/hehe/web/UserController 獲取用戶信息:

@RestController
public class UserController {
    private List<User> userList = new ArrayList<>();
    {
        userList.add(new User("1", "socks", "123456", new Date()));
        userList.add(new User("2", "admin", "111111", new Date()));
        userList.add(new User("3", "jacks", "222222", null));
    }
    @GetMapping("/")
    public ModelAndView index() {
        return new ModelAndView("user/user", "userList", userList);
    }
}

public class User {
    private String id;
    private String username;
    private String password;
    private Date createTime;
    //省略get/set方法..
}

開始編寫公共頁面:src/main/resources/views/common/head.html ,其中static爲頁面片段:

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<!--聲明static爲頁面片段名稱-->
<head th:fragment="static">
    <link th:href="@{/webjars/bootstrap/css/bootstrap.css}" rel="stylesheet" type="text/css"/>
    <script th:src="@{/webjars/jquery/jquery.js}"></script>
</head>
</html>

接着編寫用戶列表頁:src/main/resources/views/user/user.html 配合th:each顯示用戶列表信息。

使用說明:這裏 th:replace="common/head::static" 表示將引用${spring.thymeleaf.prefix}/common/head.htmlstatic頁面片段,值得注意的是由於替換路徑默認會拼接前綴路徑,所以開頭切勿在添加斜槓,否則在打包成JAR部署運行時將提示報Templates not found...

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8"/>
    <title th:text="用戶信息">User</title>
    <!--默認拼接前綴路徑,開頭請勿再添加斜槓,防止部署運行報錯!-->
    <script th:replace="common/head::static"></script>
</head>
<body>

<div th:each="user,userStat:${userList}" th:class="${userStat.even}?'even':'odd'">
    序號:<input type="text" th:value="${userStat.count}"/>
    賬號:<input type="text" th:value="${user.username}"/>
    密碼:<input type="password" th:value="${user.password}"/>
    時間:<input type="text" th:value="${user.createTime}"/>
    時間:<input type="text" th:value="${#dates.format(user.createTime,'yyyy-MM-dd HH:mm:ss')}"/>
</div>

<script th:inline="javascript">
    //通過內聯表達式獲取用戶信息
    var userList = [[${userList}]];
    console.log(userList)
</script>
</body>
</html>

然後編寫單個用戶頁面:

至此大功告成,然後快速啓動項目,如圖所示:

然後訪問用戶列表: http://localhost:8080 ,如圖所示:

然後訪問單個用戶: http://localhost:8080/user/1 ,如圖所示:

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章