Thymeleaf使用詳解

時間 2019-11-17

標籤 thymeleaf 使用詳解简体版

原文原文鏈接

Thymeleaf介紹

簡單說，Thymeleaf是一個跟Velocity、FreeMarker相似的模板引擎，他能夠徹底替代JSP。相較與其餘的模板引擎，他有以下三個及吸引人的特色：

Thymeleaf在有網絡和無網絡的環境下皆可運行，即他可讓美工在瀏覽器查看頁面的靜態效果，也可讓程序員在服務器查看數據的動態頁面效果。這是因爲它支持HTML原型，而後在HTML標籤裏增長額外的屬性來達到模板+數據的展現方式。瀏覽器解釋HTML時會忽略未定義的標籤屬性，因此Thymeleaf的模板能夠靜態地運行；當有數據返回頁面時，Thymeleaf標籤會動態地替換掉靜態內容，使頁面動態顯示
Thymeleaf開箱即用的特性。它提供標準和Spring標準兩種方言，能夠直接套用模板實現JSTL、OGNL表達式的效果，避免天天套模板、改JSTL、改標籤的困擾，同時開發人員能夠擴展和建立自定義的方言
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}">複製代碼

變量表達式和星號表達的區別

若是不考慮上下文的狀況下，二者沒有區別；星號語法評估在選定對象上表達，而不是整個上下文

什麼是選定對象？就是父標籤的值，以下：javascript

<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>複製代碼

這是徹底等價於：html

<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>複製代碼

經常使用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

幾種經常使用的使用方法

一、賦值、字符串拼接

<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:布爾值，當前循環是不是最後一個

四、內聯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';