Spring Boot(四)：Thymeleaf 使用詳解

在上篇文章Spring Boot (二)：Web 綜合開發中簡單介紹了一下 Thymeleaf，這篇文章將更加全面詳細的介紹 Thymeleaf 的使用。Thymeleaf 是新一代的模板引擎，在 Spring4.0 中推薦使用 Thymeleaf 來做前端模版引擎。

Thymeleaf 介紹

簡單說，Thymeleaf 是一個跟 Velocity、FreeMarker 類似的模板引擎，它可以完全替代 JSP 。相較與其他的模板引擎，它有如下三個極吸引人的特點：

• 1.Thymeleaf 在有網絡和無網絡的環境下皆可運行，即它可以讓美工在瀏覽器查看頁面的靜態效果，也可以讓程序員在服務器查看帶數據的動態頁面效果。這是由於它支持 html 原型，然后在 html 標簽里增加額外的屬性來達到模板+數據的展示方式。瀏覽器解釋 html 時會忽略未定義的標簽屬性，所以 Thymeleaf 的模板可以靜態地運行；當有數據返回到頁面時，Thymeleaf 標簽會動態地替換掉靜態內容，使頁面動態顯示。
• 2.Thymeleaf 開箱即用的特性。它提供標准和 Spring 標准兩種方言，可以直接套用模板實現 JSTL、 OGNL表達式效果，避免每天套模板、改 Jstl、改標簽的困擾。同時開發人員也可以擴展和創建自定義的方言。
• 3.Thymeleaf 提供 Spring 標准方言和一個與 SpringMVC 完美集成的可選模塊，可以快速的實現表單綁定、屬性編輯器、國際化等功能。

標准表達式語法

它們分為四類：

• 1.變量表達式
• 2.選擇或星號表達式
• 3.文字國際化表達式
• 4.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>  

文字國際化表達式

文字國際化表達式允許我們從一個外部文件獲取區域文字信息(.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}">

變量表達式和星號表達有什么區別嗎？

如果不考慮上下文的情況下，兩者沒有區別；星號語法評估在選定對象上表達，而不是整個上下文
什么是選定對象？就是父標簽的值，如下：

<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標簽都有那些？

關鍵字	功能介紹	案例
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="src=@{/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。

幾種常用的使用方法

1、賦值、字符串拼接

<p  th:text="${collect.description}">description</p>
<span th:text="'Welcome to our application, ' + ${user.name} + '!'">

字符串拼接還有另外一種簡潔的寫法

<span th:text="|Welcome to our application, ${user.name}!|">

2、條件判斷 If/Unless

Thymeleaf中使用th:if和th:unless屬性進行條件判斷，下面的例子中，<a>標簽只有在th:if中條件成立時才顯示：

<a th:if="${myself=='yes'}" > </i> </a>
<a th:unless=${session.user != null} th:href="@{/login}" >Login</a>

th:unless 於 th:if 恰好相反，只有表達式中的條件不成立，才會顯示其內容。

也可以使用 (if) ? (then) : (else)這種語法來判斷顯示的內容

3、for 循環

<tr  th:each="collect,iterStat : ${collects}"> 
   <th scope="row" th:text="${collect.id}">1</th>
   <td >
      <img th:src="${collect.webLogo}"/>
   </td>
   <td th:text="${collect.url}">Mark</td>
   <td th:text="${collect.title}">Otto</td>
   <td th:text="${collect.description}">@mdo</td>
   <td th:text="${terStat.index}">index</td>
</tr>

iterStat稱作狀態變量，屬性有：

• index:當前迭代對象的 index（從0開始計算）
• count: 當前迭代對象的 index(從1開始計算)
• size:被迭代對象的大小
• current:當前迭代變量
• even/odd:布爾值，當前循環是否是偶數/奇數（從0開始計算）
• first:布爾值，當前循環是否是第一個
• last:布爾值，當前循環是否是最后一個

4、URL

URL 在 Web 應用模板中占據着十分重要的地位，需要特別注意的是 Thymeleaf 對於 URL 的處理是通過語法 @{...} 來處理的。
如果需要 Thymeleaf 對 URL 進行渲染，那么務必使用 th:href，th:src 等屬性，下面是一個例子

<!-- Will produce 'http://localhost:8080/standard/unread' (plus rewriting) -->
 <a  th:href="@{/standard/{type}(type=${type})}">view</a>

<!-- Will produce '/gtvg/order/3/details' (plus rewriting) -->
<a href="details.html" th:href="@{/order/{orderId}/details(orderId=${o.id})}">view</a>

設置背景

<div th:style="'background:url(' + @{/<path-to-image>} + ');'"></div>

根據屬性值改變背景

 <div class="media-object resource-card-image"  th:style="'background:url(' + @{(${collect.webLogo}=='' ? 'img/favicon.png' : ${collect.webLogo})} + ')'" ></div>

幾點說明：

• 上例中 URL 最后的(orderId=${o.id}) 表示將括號內的內容作為 URL 參數處理，該語法避免使用字符串拼接，大大提高了可讀性
• @{...}表達式中可以通過{orderId}訪問 Context 中的 orderId 變量
• @{/order}是 Context 相關的相對路徑，在渲染時會自動添加上當前 Web 應用的 Context 名字，假設 context 名字為 app，那么結果應該是 /app/order

5、內聯 js

內聯文本：[[...]] 內聯文本的表示方式，使用時，必須先用th:inline="text/javascript/none"激活，th:inline可以在父級標簽內使用，甚至作為 body 的標簽。內聯文本盡管比th:text的代碼少，不利於原型顯示。

<script th:inline="javascript">
/*<![CDATA[*/
...
var username = /*[[${sesion.user.name}]]*/ 'Sebastian';
var size = /*[[${size}]]*/ 0;
...
/*]]>*/
</script>

js 附加代碼：

/*[+
var msg = 'This is a working application';
+]*/

js 移除代碼：

/*[- */
var msg = 'This is a non-working template';
/* -]*/

6、內嵌變量

為了模板更加易用，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
• maps
  ...

下面用一段代碼來舉例一些常用的方法：

dates

/*
 * Format date with the specified pattern
 * Also works with arrays, lists or sets
 */
${#dates.format(date, 'dd/MMM/yyyy HH:mm')}
${#dates.arrayFormat(datesArray, 'dd/MMM/yyyy HH:mm')}
${#dates.listFormat(datesList, 'dd/MMM/yyyy HH:mm')}
${#dates.setFormat(datesSet, 'dd/MMM/yyyy HH:mm')}

/*
 * Create a date (java.util.Date) object for the current date and time
 */
${#dates.createNow()}

/*
 * Create a date (java.util.Date) object for the current date (time set to 00:00)
 */
${#dates.createToday()}

strings

/*
 * Check whether a String is empty (or null). Performs a trim() operation before check
 * Also works with arrays, lists or sets
 */
${#strings.isEmpty(name)}
${#strings.arrayIsEmpty(nameArr)}
${#strings.listIsEmpty(nameList)}
${#strings.setIsEmpty(nameSet)}

/*
 * Check whether a String starts or ends with a fragment
 * Also works with arrays, lists or sets
 */
${#strings.startsWith(name,'Don')}                  // also array*, list* and set*
${#strings.endsWith(name,endingFragment)}           // also array*, list* and set*

/*
 * Compute length
 * Also works with arrays, lists or sets
 */
${#strings.length(str)}

/*
 * Null-safe comparison and concatenation
 */
${#strings.equals(str)}
${#strings.equalsIgnoreCase(str)}
${#strings.concat(str)}
${#strings.concatReplaceNulls(str)}

/*
 * Random
 */
${#strings.randomAlphanumeric(count)}

使用 Thymeleaf 布局

Spring Boot 2.0 將布局單獨提取了出來，需要單獨引入依賴：thymeleaf-layout-dialect。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<dependency>
    <groupId>nz.net.ultraq.thymeleaf</groupId>
    <artifactId>thymeleaf-layout-dialect</artifactId>
</dependency>

定義代碼片段

<footer th:fragment="copy"> 
&copy; 2019
</footer>

在頁面任何地方引入：

<body>
    <div th:insert="layout/copyright :: copyright"></div>
    <div th:replace="layout/copyright :: copyright"></div>
</body>

th:insert 和 th:replace 區別，insert 只是加載，replace 是替換。Thymeleaf 3.0 推薦使用 th:insert 替換 2.0 的 th:replace。

返回的 HTML 如下：

<body> 
   <div> &copy; 2019 </div> 
  <footer>&copy; 2019 </footer> 
</body>

下面是一個常用的后台頁面布局，將整個頁面分為頭部，尾部、菜單欄、隱藏欄，點擊菜單只改變 content 區域的頁面

<body class="layout-fixed">
  <div th:fragment="navbar"  class="wrapper"  role="navigation">
	<div th:replace="fragments/header :: header">Header</div>
	<div th:replace="fragments/left :: left">left</div>
	<div th:replace="fragments/sidebar :: sidebar">sidebar</div>
	<div layout:fragment="content" id="content" ></div>
	<div th:replace="fragments/footer :: footer">footer</div>
  </div>
</body>

任何頁面想使用這樣的布局值只需要替換中見的 content 模塊即可

<html xmlns:th="http://www.thymeleaf.org" layout:decorator="layout">
 <body>
    <section layout:fragment="content">
  ...

也可以在引用模版的時候傳參

<head th:include="layout :: htmlhead" th:with="title='Hello'"></head>

layout 是文件地址，如果有文件夾可以這樣寫fileName/layout:htmlhead，htmlhead 是指定義的代碼片段 如th:fragment="copy"

文章示例項目

示例代碼-github

示例代碼-碼雲

文章內容已經升級到 Spring Boot 2.x

參考

thymeleaf官方指南
新一代Java模板引擎Thymeleaf
Thymeleaf基本知識
thymeleaf總結文章
Thymeleaf 模板的使用
thymeleaf 學習筆記