一、Thymeleaf介紹

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

1、Thymeleaf 在有網路和無網路的環境下皆可執行，即它可以讓美工在瀏覽器檢視頁面的靜態效果，也可以讓程式設計師在伺服器檢視帶資料的動態頁面效果。這是由於它支援 html 原型，然後在 html 標籤裡增加額外的屬性來達到模板+資料的展示方式。瀏覽器解釋 html 時會忽略未定義的標籤屬性，所以 Thymeleaf 的模板可以靜態地執行；當有資料返回到頁面時，Thymeleaf 標籤會動態地替換掉靜態內容，使頁面動態顯示。

2、Thymeleaf 開箱即用的特性。它提供標準和 Spring 標準兩種方言，可以直接套用模板實現 JSTL、 OGNL表示式效果，避免每天套模板、改 Jstl、改標籤的困擾。同時開發人員也可以擴充套件和建立自定義的方言。

Thymeleaf 提供 Spring 標準方言和一個與 SpringMVC 完美整合的可選模組，可以快速的實現表單繫結、屬性編輯器、國際化等功能。

二、Thymeleaf常用語法

1. 標準表示式語法

• 變量表達式

變量表達式即 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'))
    

2. 常用th標籤有哪些?

還有非常多的標籤，這裡只列出最常用的幾個,由於一個標籤內可以包含多個th:x屬性，其生效的優先順序順序為:

include,each,if/unless/switch/case,with,attr/attrprepend/attrappend,value/href,src ,etc,text/utext,fragment,remove。

3. 幾種常用的使用方法

• 賦值、字串拼接

<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}!|">

• 條件判斷 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)這種語法來判斷顯示的內容

• 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:布林值，當前迴圈是否是最後一個

• 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

• 內聯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';
/* -]*/

• 內嵌變數

為了模板更加易用，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=&q