spring boot 學習筆記 （4）模板引擎 Thymeleaf
Thymeleaf 是⾯向 Web 和獨⽴環境的現代伺服器端 Java 模板引擎，能夠處理 HTML、XML、JavaScript、CSS 甚⾄純⽂本。
Thymeleaf 特點
簡單說，Thymeleaf 是一個跟 Velocity、FreeMarker 類似的模板引擎，它可以完全替代 JSP。與其他的模板引擎相比較，它有如下三個極吸引人的特點。
-
Thymeleaf 在有網路和無網路的環境下皆可執行，即它可以讓美工在瀏覽器檢視頁面的靜態效果，也可以讓程式設計師在伺服器檢視帶資料的動態頁面效果。這是由於它支援 HTML 原型，然後在 HTML 標籤裡增加額外的屬性來達到模板 + 資料的展示方式。瀏覽器解釋 HTML 時會忽略未定義的標籤屬性，所以 Thymeleaf 的模板可以靜態地執行；當有資料返回到頁面時，Thymeleaf 標籤會動態地替換掉靜態內容，使頁面動態顯示。
-
Thymeleaf 開箱即用的特性。它支援標準方言和 Spring 方言，可以直接套用模板實現 JSTL、 OGNL 表示式效果，避免每天套模板、改 JSTL、改標籤的困擾。同時開發人員也可以擴充套件和建立自定義的方言。
-
Thymeleaf 提供 Spring 標準方言和一個與 SpringMVC 完美整合的可選模組，可以快速地實現表單繫結、屬性編輯器、國際化等功能。
常用語法
相關配置
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-thymeleaf</artifactId> </dependency>
在 application.properties 中新增配置：
spring.thymeleaf.cache=false
其中，propertiesspring.thymeleaf.cache=false 是關閉 Thymeleaf 的快取，不然在開發過程中修改頁面不會立刻生效需要重啟，生產可配置為 true。
所有使用 Thymeleaf 的頁面必須在 HTML 標籤宣告 Thymeleaf：
<html xmlns:th="http://www.thymeleaf.org">賦值和拼接：
<p th:text="${userName}">neo</p> <span th:text="'Welcome to our application, ' + ${userName} + '!'"></span>
字串拼接還有另外一種簡潔的寫法：
<span th:text="|Welcome to our application, ${userName}!|"></span>使用 ModelMap 以 KV 的方式儲存傳遞到頁面。
@RequestMapping("/string")
public String string(ModelMap map) {
map.addAttribute("userName", "ityouknow");
return "string";
}條件判斷 If/Unless
Thymeleaf 中使用 th:if 和 th:unless 屬性進行條件判斷，在下面的例子中，<a> 標籤只有在 th:if 中條件成立時才顯示：
<a th:if="${flag == 'yes'}" th:href="@{http://favorites.ren/}"> home </a>
<a th:unless="${flag != 'no'}" th:href="@{http://www.ityouknow.com/}" >ityouknow</a>
th:unless 與 th:if 恰好相反，只有表示式中的條件不成立，才會顯示其內容。
for 迴圈
按照鍵 users，傳遞到前端：
@RequestMapping("/list")
public String list(ModelMap map) {
map.addAttribute("users", getUserList());
return "list";
}
頁面 list.html 進行資料展示：
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8"></meta>
<title>Example If/Unless </title>
</head>
<body>
<div >
<h1>for 迴圈</h1>
<table>
<tr th:each="user,iterStat : ${users}">
<td th:text="${user.name}">neo</td>
<td th:text="${user.age}">6</td>
<td th:text="${user.pass}">213</td>
<td th:text="${iterStat.index}">index</td>
</tr>
</table>
</div>
</body>
</html>
iterStat 稱作狀態變數，屬性有：
- index，當前迭代物件的 index（從 0 開始計算）；
- count，當前迭代物件的 index（從 1 開始計算）；
- size，被迭代物件的大小；
- current，當前迭代變數；
- even/odd，布林值，當前迴圈是否是偶數/奇數（從 0 開始計算）；
- first，布林值，當前迴圈是否是第一個；
- last，布林值，當前迴圈是否是最後一個。
URL
URL 在 Web 應用模板中佔據著十分重要的地位，需要特別注意的是 Thymeleaf 對於 URL 的處理是通過語法@{...}來處理的。如果需要 Thymeleaf 對 URL 進行渲染，那麼務必使用 th:href、th:src 等屬性，下面是一個例子：
<a th:href="@{http://www.ityouknow.com/{type}(type=${type})}">link1</a>
<a th:href="@{http://www.ityouknow.com/{pageId}/can-use-springcloud.html(pageId=${pageId})}">view</a>
也可以使用@{...}設定背景：
<div th:style="'background:url(' + @{${img url}} + ');'">
幾點說明：
- 上例中 URL 最後的
(pageId=${pageId})表示將括號內的內容作為 URL 引數處理，該語法避免使用字串拼接，大大提高了可讀性； @{...}表示式中可以通過{pageId}訪問 Context 中的 pageId 變數；@{/order}是 Context 相關的相對路徑，在渲染時會自動新增上當前 Web 應用的 Context 名字，假設 context 名字為 app，那麼結果應該是/app/order。
三目運算
三目運算及表單顯示：
<input th:value="${name}"/>
<input th:value="${age gt 30 ? '中年':'年輕'}"/>
說明：在表單標籤中顯示內容使用：th:value;${age gt 30 ? '中年':'年輕'}表示如果 age 大於 30 則顯示中年，否則顯示年輕。
- gt：great than（大於）
- ge：great equal（大於等於）
- eq：equal（等於）
- lt：less than（小於）
- le：less equal（小於等於）
- ne：not equal（不等於）
結合三目運算也可以將上面的 if else 改成這樣：
<a th:if="${flag eq 'yes'}" th:href="@{http://favorites.ren/}"> favorites </a>
switch 選擇
switch\case 多用於多條件判斷的場景下，以性別舉例：
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8"></meta>
<title>Example switch </title>
</head>
<body>
<div >
<div th:switch="${sex}">
<p th:case="'woman'">她是一個姑娘...</p>
<p th:case="'man'">這是一個爺們!</p>
<!-- *: case的預設的選項 -->
<p th:case="*">未知性別的一個傢伙。</p>
</div>
</div>
</body>
</html>
*: case的預設的選項
高階用法
內聯 [ [ ] ]
如果不想通過 th 標籤而是簡單地訪問 model 物件資料，或是想在 javascript 程式碼塊裡訪問 model 中的資料，則要使用內聯的方法。
內聯文字：[ [...] ] 內聯文字的表示方式，使用時，必須先用在 th:inline="text/javascript/none" 啟用，th:inline 可以在父級標籤內使用，甚至可以作為 body 的標籤。內聯文字比 th:text 的程式碼少，不利於原型顯示。
頁面 inline.html（文字內聯）：
<div>
<h1>內聯</h1>
<div th:inline="text" >
<p>Hello, [[${userName}]] !</p>
<br/>
</div>
</div>
以上程式碼等價於：
<div>
<h1>不使用內聯</h1>
<p th:text="'Hello, ' + ${userName} + ' !'"></p>
<br/>
</div>
通過以上程式碼可以看出使用內聯語法會更簡潔一些。
如果想在指令碼中使用後端傳遞的值，則必須使用指令碼內聯，指令碼內聯可以在 js 中取到後臺傳過來的引數：
<script th:inline="javascript">
var name = [[${userName}]] + ', Sebastian';
alert(name);
</script>
這段指令碼的含義是在訪問頁面的時候，根據後端傳值拼接 name 值，並以 alert 的方式彈框展示。
後端傳值：
@RequestMapping("/inline")
public String inline(ModelMap map) {
map.addAttribute("userName", "neo");
return "inline";
}
頁面會先跳出一個 alert 提示框，然後再展示使用內聯和不使用內聯的頁面內容。
基本物件
Thymeleaf 包含了一些基本物件，可以用於我們的檢視中，這些基本物件使用 # 開頭。
#ctx：上下文物件#vars：上下文變數#locale：區域物件#request：（僅 Web 環境可用）HttpServletRequest 物件#response：（僅 Web 環境可用）HttpServletResponse 物件#session：（僅 Web 環境可用）HttpSession 物件#servletContext：（僅 Web 環境可用）ServletContext 物件
Thymeleaf 在 Web 環境中，有一系列的快捷方式用於訪問請求引數、會話屬性等應用屬性，以其中幾個常用的物件作為示例來演示。
#request：直接訪問與當前請求關聯的 javax.servlet.http.HttpServletRequest 物件；#session：直接訪問與當前請求關聯的 javax.servlet.http.HttpSession 物件。
後臺新增方法傳值：
@RequestMapping("/object")
public String object(HttpServletRequest request) {
request.setAttribute("request","i am request");
request.getSession().setAttribute("session","i am session");
return "object";
}
使用 request 和 session 分別傳遞了一個值，再來檢視頁面 object.html。
<body>
<div >
<h1>基本物件</h1>
<p th:text="${#request.getAttribute('request')}">
<br/>
<p th:text="${session.session}"></p>
Established locale country: <span th:text="${#locale.country}">CN</span>.
</div>
</body>
啟動專案後在瀏覽器中輸入該網址：http://localhost:8080/object，則會出現下面的結果：
基本物件
i am request
i am session
Established locale country: CN.
第一個展示了 request 如何使用引數，第二行展示了 session 的使用，session 直接使用 . 即可獲取到 session 中的值，最後展示了 locale 的用法。
內嵌變數
為了模板更加易用，Thymeleaf 還提供了一系列 Utility 物件（內置於 Context 中），可以通過 # 直接訪問。
- dates：java.util.Date 的功能方法類
- calendars：類似 #dates，面向 java.util.Calendar
- numbers：格式化數字的功能方法類
- strings：字串物件的功能類，contains、startWiths、prepending/appending 等
- objects：對 objects 的功能類操作
- bools：對布林值求值的功能方法
- arrays：對陣列的功能類方法
- lists：對 lists 的功能類方法
- sets：set 的實用方法
- maps：map 的實用方法
- …
下面用一段程式碼來舉例說明一些常用的方法，頁面是 utility.html。
1. dates
可以使用 dates 對日期格式化，建立當前時間等操作。
<!--格式化時間-->
<p th:text="${#dates.format(date, 'yyyy-MM-dd HH:mm:ss')}">neo</p>
<!--建立當前時間 精確到天-->
<p th:text="${#dates.createToday()}">neo</p>
<!--建立當前時間 精確到秒-->
<p th:text="${#dates.createNow()}">neo</p>
2. strings
strings 內建了一些對字串經常使用的函式。
<!--判斷是否為空-->
<p th:text="${#strings.isEmpty(userName)}">userName</p>
<!--判斷 list 是否為空-->
<p th:text="${#strings.listIsEmpty(users)}">userName</p>
<!--輸出字串長度-->
<p th:text="${#strings.length(userName)}">userName</p>
<!--拼接字串-->
<p th:text="${#strings.concat(userName,userName,userName)}"></p>
<!--建立自定長度的字串-->
<p th:text="${#strings.randomAlphanumeric(count)}">userName</p>
後端傳值：
@RequestMapping("/utility")
public String utility(ModelMap map) {
map.addAttribute("userName", "neo");
map.addAttribute("users", getUserList());
map.addAttribute("count", 12);
map.addAttribute("date", new Date());
return "utility";
}
啟動專案後在瀏覽器中輸入該網址：http://localhost:8080/utility，則會出現下面的結果：
內嵌變數
2018-09-26 20:49:07
Wed Sep 26 00:00:00 CST 2018
Wed Sep 26 20:49:07 CST 2018
false
[false, false, false]
3
neoneoneo
QKERBVPRHFS9
接下來總結一下 Thymeleaf 表示式。
表示式
表示式共分為以下五類。
- 變量表達式：${...}
- 選擇或星號表示式：*{...}
- 文字國際化表示式：#{...}
- URL 表示式：@{...}
- 片段表示式：~{...}
變量表達式
變量表達式即 OGNL 表示式或 Spring EL 表示式（在 Spring 術語中也叫 model attributes），類似 ${session.user.name}。
它們將以 HTML 標籤的一個屬性來表示：
<span th:text="${book.author.name}">
<li th:each="book : ${books}">
選擇（星號）表示式
選擇表示式很像變量表達式，不過它們用一個預先選擇的物件來代替上下文變數容器（map）來執行，類似：*{customer.name}。
被指定的 object 由 th:object 屬性定義：
<div th:object="${book}">
...
<span th:text="*{title}">...</span>
...
</div>
title 即為 book 的屬性。
文字國際化表示式
文字國際化表示式允許我們從一個外部檔案獲取區域文字資訊（.properties），用 Key 索引 Value，還可以提供一組引數（可選）。
#{main.title}
#{message.entrycreated(${entryId})}
可以在模板檔案中找到這樣的表示式程式碼：
<table>
...
<th th:text="#{header.address.city}">...</th>
<th th:text="#{header.address.country}">...</th>
...
</table>
URL 表示式
URL 表示式指的是把一個有用的上下文或回話資訊新增到 URL，這個過程經常被叫做 URL 重寫，比如@{/order/list}。
- URL 還可以設定引數：
@{/order/details(id=${orderId})} - 相對路徑：
@{../documents/report}
讓我們看這些表示式：
<form th:action="@{/createOrder}">
<a href="main.html" th:href="@{/main}">
片段表示式
片段表示式是 3.x 版本新增的內容。片段表示式是一種標記的片段，並將其移動到模板中的方法。片段表示式的優勢是，片段可以被複制或者作為引數傳遞給其他模板等。
最常見的用法是使用 th:insert 或 th:replace: 插入片段：
<div th:insert="~{commons :: main}">...</div>
也可以在頁面的其他位置去使用：
<div th:with="frag=~{footer :: #main/text()}">
<p th:insert="${frag}">
</div>
片段表示式可以有引數。
變量表達式和星號表達有什麼區別
如果不考慮上下文的情況下，兩者沒有區別；星號語法是在選定物件上表達，而不是整個上下文。什麼是選定物件？就是父標籤的值，如下：
<div th:object="${session.user}">
<p>Name: <span th:text="*{firstName}">Sebastian</span>.</p>
<p>Surname: <span th:text="*{lastName}">Pepper</span>.</p>
<p>Nationality: <span th:text="*{nationality}">Saturn</span>.</p>
</div>
這是完全等價於：
<div th:object="${session.user}">
<p>Name: <span th:text="${session.user.firstName}">Sebastian</span>.</p>
<p>Surname: <span th:text="${session.user.lastName}">Pepper</span>.</p>
<p>Nationality: <span th:text="${session.user.nationality}">Saturn</span>.</p>
</div>
當然，兩種語法可以混合使用：
<div th:object="${session.user}">
<p>Name: <span th:text="*{firstName}">Sebastian</span>.</p>
<p>Surname: <span th:text="${session.user.lastName}">Pepper</span>.</p>
<p>Nationality: <span th:text="*{nationality}">Saturn</span>.</p>
</div>
表示式支援的語法
字面（Literals）
- 文字文字（Text literals）：
'one text', 'Another one!',… - 數字文字（Number literals）：
0, 34, 3.0, 12.3,… - 布林文字（Boolean literals）：
true, false - 空（Null literal）：
null - 文字標記（Literal tokens）：
one, sometext, main,…
文字操作（Text operations）
- 字串連線（String concatenation）：
+ - 文字替換（Literal substitutions）：
|The name is ${name}|
算術運算（Arithmetic operations）
- 二元運算子（Binary operators）：
+, -, *, /, % - 減號（單目運算子）Minus sign（unary operator）：
-
布林操作（Boolean operations）
- 二元運算子（Binary operators）：
and, or - 布林否定（一元運算子）Boolean negation (unary operator)：
!, not
比較和等價（Comparisons and equality）
- 比較（Comparators）：
>, <, >=, <= (gt, lt, ge, le) - 等值運算子（Equality operators）：
==, != (eq, ne)
條件運算子（Conditional operators）
- If-then：
(if) ? (then) - If-then-else：
(if) ? (then) : (else) - Default: (value) ?：
(defaultvalue)
所有這些特徵可以被組合並巢狀：
'User is of type ' + (${user.isAdmin()} ? 'Administrator' : (${user.type} ?: 'Unknown'))
常用 th 標籤
頁面常用的 HTML 標籤幾乎都有 Thymeleaf 對應的 th 標籤。
| 關鍵字 | 功能介紹 | 案例 |
|---|---|---|
| th:id | 替換 id | <input th:id="'xxx' + ${collect.id}"/> |
| th:text | 文字替換 | <p th:text="${collect.description}">description</p> |
| th:utext | 支援 html 的文字替換 | <p th:utext="${htmlcontent}">conten</p> |
| th:object | 替換物件 | <div th:object="${session.user}"> |
| th:value | 屬性賦值 | <input th:value="${user.name}" /> |
| th:with | 變數賦值運算 | <div th:with="isEven=${prodStat.count}%2==0"></div> |
| th:style | 設定樣式 | th:style="'display:' + @{(${sitrue} ? 'none' : 'inline-block')} + ''" |
| th:onclick | 點選事件 | th:onclick="'getCollect()'" |
| th:each | 屬性賦值 | tr th:each="user,userStat:${users}"> |
| th:if | 判斷條件 | <a th:if="${userId == collect.userId}" > |
| th:unless | 和 th:if 判斷相反 | <a th:href="@{/login}" th:unless=${session.user != null}>Login</a> |
| th:href | 連結地址 | <a th:href="@{/login}" th:unless=${session.user != null}>Login</a> /> |
| th:switch | 多路選擇 配合 th:case 使用 | <div th:switch="${user.role}"> |
| th:case | th:switch 的一個分支 | <p th:case="'admin'">User is an administrator</p> |
| th:fragment | 佈局標籤，定義一個程式碼片段，方便其他地方引用 | <div th:fragment="alert"> |
| th:include | 佈局標籤，替換內容到引入的檔案 | <head th:include="layout :: htmlhead" th:with="title='xx'"></head> /> |
| th:replace | 佈局標籤，替換整個標籤到引入的檔案 | <div th:replace="fragments/header :: title"></div> |
| th:selected | selected 選擇框 選中 | th:selected="(${xxx.id} == ${configObj.dd})" |
| th:src | 圖片類地址引入 | <img class="img-responsive" alt="App Logo" th:src="@{/img/logo.png}" /> |
| th:inline | 定義 js 指令碼可以使用變數 | <script type="text/javascript" th:inline="javascript"> |
| th:action | 表單提交的地址 | <form action="subscribe.html" th:action="@{/subscribe}"> |
| th:remove | 刪除某個屬性 | <tr th:remove="all">1.all：刪除包含標籤和所有的子節點； 2.body：不包含標記刪除，但刪除其所有的子節點； 3.tag：包含標記的刪除，但不刪除它的子節點； 4.all-but-first：刪除所有包含標籤的子節點，除了第一個。 5.none：什麼也不做。這個值是有用的動態評估 |
| th:attr | 設定標籤屬性，多個屬性可以用逗號分隔 | 比如 th:attr="[email protected]{/image/aa.jpg},title=#{logo}"，此標籤不太優雅，一般用的比較少 |
還有非常多的標籤，這裡只列出最常用的幾個，由於一個標籤內可以包含多個 th:x 屬性，其生效的優先順序順序為：
include,each,if/unless/switch/case,with,attr/attrprepend/attrappend,value/href,src ,etc,text/utext,fragment,remove。
Thymeleaf 配置
我們可以通過 application.properties 檔案靈活的配置 Thymeleaf 的各項特性，以下為 Thymeleaf 的配置和預設引數：
# THYMELEAF (ThymeleafAutoConfiguration)
#開啟模板快取（預設值：true）
spring.thymeleaf.cache=true
#檢查模板是否存在，然後再呈現
spring.thymeleaf.check-template=true
#檢查模板位置是否正確（預設值:true）
spring.thymeleaf.check-template-location=true
#Content-Type的值（預設值：text/html）
spring.thymeleaf.content-type=text/html
#開啟MVC Thymeleaf檢視解析（預設值：true）
spring.thymeleaf.enabled=true
#模板編碼
spring.thymeleaf.encoding=UTF-8
#要被排除在解析之外的檢視名稱列表，用逗號分隔
spring.thymeleaf.excluded-view-names=
#要運用於模板之上的模板模式。另見StandardTemplate-ModeHandlers(預設值：HTML5)
spring.thymeleaf.mode=HTML5
#在構建URL時新增到檢視名稱前的字首（預設值：classpath:/templates/）
spring.thymeleaf.prefix=classpath:/templates/
#在構建URL時新增到檢視名稱後的字尾（預設值：.html）
spring.thymeleaf.suffix=.html
#Thymeleaf 模板解析器在解析器鏈中的順序，預設情況下，它排第一位，順序從1開始，只有在定義了額外的 TemplateResolver Bean 時才需要設定這個屬性。
spring.thymeleaf.template-resolver-order=
#可解析的檢視名稱列表，用逗號分隔
spring.thymeleaf.view-names=
在實際專案中可以根據實際使用情況來修改。