spring boot(四)之thymeleaf使用詳解

在上篇文章springboot(二)：web綜合開(kāi)發(fā)中簡(jiǎn)單介紹了一下thymeleaf，這篇文章將更加全面詳細(xì)的介紹thymeleaf的使用。thymeleaf 是新一代的模板引擎，在spring4.0中推薦使用thymeleaf來(lái)做前端模版引擎。

thymeleaf介紹

簡(jiǎn)單說(shuō)， Thymeleaf 是一個(gè)跟 Velocity、FreeMarker 類(lèi)似的模板引擎，它可以完全替代 JSP 。相較與其他的模板引擎，它有如下三個(gè)極吸引人的特點(diǎn)：

1.Thymeleaf 在有網(wǎng)絡(luò)和無(wú)網(wǎng)絡(luò)的環(huán)境下皆可運(yùn)行，即它可以讓美工在瀏覽器查看頁(yè)面的靜態(tài)效果，也可以讓程序員在服務(wù)器查看帶數(shù)據(jù)的動(dòng)態(tài)頁(yè)面效果。這是由于它支持 html 原型，然后在 html 標(biāo)簽里增加額外的屬性來(lái)達(dá)到模板+數(shù)據(jù)的展示方式。瀏覽器解釋 html 時(shí)會(huì)忽略未定義的標(biāo)簽屬性，所以 thymeleaf 的模板可以靜態(tài)地運(yùn)行；當(dāng)有數(shù)據(jù)返回到頁(yè)面時(shí)，Thymeleaf 標(biāo)簽會(huì)動(dòng)態(tài)地替換掉靜態(tài)內(nèi)容，使頁(yè)面動(dòng)態(tài)顯示。

2.Thymeleaf 開(kāi)箱即用的特性。它提供標(biāo)準(zhǔn)和spring標(biāo)準(zhǔn)兩種方言，可以直接套用模板實(shí)現(xiàn)JSTL、 OGNL表達(dá)式效果，避免每天套模板、該jstl、改標(biāo)簽的困擾。同時(shí)開(kāi)發(fā)人員也可以擴(kuò)展和創(chuàng)建自定義的方言。

3.Thymeleaf 提供spring標(biāo)準(zhǔn)方言和一個(gè)與 SpringMVC 完美集成的可選模塊，可以快速的實(shí)現(xiàn)表單綁定、屬性編輯器、國(guó)際化等功能。

標(biāo)準(zhǔn)表達(dá)式語(yǔ)法

它們分為四類(lèi)：

1.變量表達(dá)式
2.選擇或星號(hào)表達(dá)式
3.文字國(guó)際化表達(dá)式
4.URL表達(dá)式

變量表達(dá)式

變量表達(dá)式即OGNL表達(dá)式或Spring EL表達(dá)式(在Spring術(shù)語(yǔ)中也叫model attributes)。如下所示：

${session.user.name}

它們將以HTML標(biāo)簽的一個(gè)屬性來(lái)表示：

<span th:text="${book.author.name}"> 
<li th:each="book : ${books}"> 

選擇表達(dá)式很像變量表達(dá)式，不過(guò)它們用一個(gè)預(yù)先選擇的對(duì)象來(lái)代替上下文變量容器(map)來(lái)執(zhí)行，如下：

*{customer.name}

被指定的object由th:object屬性定義：

 <div th:object="${book}"> 
 ... 
 <span th:text="*{title}">...</span> 
 ... 
 </div> 

文字國(guó)際化表達(dá)式

文字國(guó)際化表達(dá)式允許我們從一個(gè)外部文件獲取區(qū)域文字信息(.properties)，用Key索引Value，還可以提供一組參數(shù)(可選).

 #{main.title} 
 #{message.entrycreated(${entryId})} 

可以在模板文件中找到這樣的表達(dá)式代碼：

<table> 
 ... 
 <th th:text="#{header.address.city}">...</th> 
 <th th:text="#{header.address.country}">...</th> 
 ... 
 </table> 

URL表達(dá)式

URL表達(dá)式指的是把一個(gè)有用的上下文或回話信息添加到URL，這個(gè)過(guò)程經(jīng)常被叫做URL重寫(xiě)。

@{/order/list}

URL還可以設(shè)置參數(shù)：

@{/order/details(id=${orderId})}

相對(duì)路徑：

@{../documents/report}

讓我們看這些表達(dá)式：

 <form th:action="@{/createOrder}"> 
 <a href="main.html" rel="external nofollow" th:href="@{/main}" rel="external nofollow" >

變量表達(dá)式和星號(hào)表達(dá)有什么區(qū)別嗎？

如果不考慮上下文的情況下，兩者沒(méi)有區(qū)別；星號(hào)語(yǔ)法評(píng)估在選定對(duì)象上表達(dá)，而不是整個(gè)上下文

什么是選定對(duì)象？就是父標(biāo)簽的值，如下：

 <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>

這是完全等價(jià)于：

 <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>

當(dāng)然，美元符號(hào)和星號(hào)語(yǔ)法可以混合使用：

 <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>

表達(dá)式支持的語(yǔ)法

字面（Literals）

• 文本文字（Text literals）: 'one text', 'Another one!',…
• 數(shù)字文本（Number literals）: 0, 34, 3.0, 12.3,…
• 布爾文本（Boolean literals）: true, false
• 空（Null literal）: null
• 文字標(biāo)記（Literal tokens）: one, sometext, main,…
  

文本操作（Text operations）

• 字符串連接(String concatenation): +
• 文本替換（Literal substitutions）: |The name is ${name}|
  

算術(shù)運(yùn)算（Arithmetic operations）

• 二元運(yùn)算符（Binary operators）: +, -, *, /, %
• 減號(hào)（單目運(yùn)算符）Minus sign (unary operator): -
  

布爾操作（Boolean operations）

• 二元運(yùn)算符（Binary operators）:and, or
• 布爾否定（一元運(yùn)算符）Boolean negation (unary operator):!, not
  

比較和等價(jià)(Comparisons and equality)

• 比較（Comparators）: >, <, >=, <= (gt, lt, ge, le)
• 等值運(yùn)算符（Equality operators）:==, != (eq, ne)
  

條件運(yùn)算符（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標(biāo)簽都有那些？

th:attr 設(shè)置標(biāo)簽屬性，多個(gè)屬性可以用逗號(hào)分隔 比如 th:attr="src=@{/image/aa.jpg},title=#{logo}"，此標(biāo)簽不太優(yōu)雅，一般用的比較少。

還有非常多的標(biāo)簽，這里只列出最常用的幾個(gè),由于一個(gè)標(biāo)簽內(nèi)可以包含多個(gè)th:x屬性，其生效的優(yōu)先級(jí)順序?yàn)?

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

字符串拼接還有另外一種簡(jiǎn)潔的寫(xiě)法

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

2、條件判斷 If/Unless

Thymeleaf中使用th:if和th:unless屬性進(jìn)行條件判斷，下面的例子中，<a>標(biāo)簽只有在th:if中條件成立時(shí)才顯示：

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

th:unless于th:if恰好相反，只有表達(dá)式中的條件不成立，才會(huì)顯示其內(nèi)容。

也可以使用 (if) ? (then) : (else) 這種語(yǔ)法來(lái)判斷顯示的內(nèi)容

3、for 循環(huán)

<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稱(chēng)作狀態(tài)變量，屬性有：

index:當(dāng)前迭代對(duì)象的index（從0開(kāi)始計(jì)算）
count: 當(dāng)前迭代對(duì)象的index(從1開(kāi)始計(jì)算)
size:被迭代對(duì)象的大小
current:當(dāng)前迭代變量
even/odd:布爾值，當(dāng)前循環(huán)是否是偶數(shù)/奇數(shù)（從0開(kāi)始計(jì)算）
first:布爾值，當(dāng)前循環(huán)是否是第一個(gè)
last:布爾值，當(dāng)前循環(huán)是否是最后一個(gè)

4、URL

URL在Web應(yīng)用模板中占據(jù)著十分重要的地位，需要特別注意的是Thymeleaf對(duì)于URL的處理是通過(guò)語(yǔ)法@{...}來(lái)處理的。
如果需要Thymeleaf對(duì)URL進(jìn)行渲染，那么務(wù)必使用th:href，th:src等屬性，下面是一個(gè)例子

<!-- Will produce 'http://localhost:8080/standard/unread' (plus rewriting) -->
 <a th:href="@{/standard/{type}(type=${type})}" rel="external nofollow" >view</a>
<!-- Will produce '/gtvg/order/3/details' (plus rewriting) -->
<a href="details.html" rel="external nofollow" th:href="@{/order/{orderId}/details(orderId=${o.id})}" rel="external nofollow" >view</a>

設(shè)置背景

<div th:></div>

根據(jù)屬性值改變背景

 <div class="media-object resource-card-image" th: ></div>

幾點(diǎn)說(shuō)明：

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

5、內(nèi)聯(lián)js

內(nèi)聯(lián)文本：[[...]]內(nèi)聯(lián)文本的表示方式，使用時(shí)，必須先用th:inline="text/javascript/none"激活，th:inline可以在父級(jí)標(biāo)簽內(nèi)使用，甚至作為body的標(biāo)簽。內(nèi)聯(lián)文本盡管比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、內(nèi)嵌變量

為了模板更加易用，Thymeleaf還提供了一系列Utility對(duì)象（內(nèi)置于Context中），可以通過(guò)#直接訪問(wèn)：

dates ： java.util.Date的功能方法類(lèi)。
calendars : 類(lèi)似#dates，面向java.util.Calendar
numbers : 格式化數(shù)字的功能方法類(lèi)
strings : 字符串對(duì)象的功能類(lèi)，contains,startWiths,prepending/appending等等。
objects: 對(duì)objects的功能類(lèi)操作。
bools: 對(duì)布爾值求值的功能方法。
arrays：對(duì)數(shù)組的功能類(lèi)方法。
lists: 對(duì)lists功能類(lèi)方法
sets
maps
...

下面用一段代碼來(lái)舉例一些常用的方法：

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布局

使用thymeleaf布局非常的方便

定義代碼片段

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

在頁(yè)面任何地方引入：

<body> 
 <div th:include="footer :: copy"></div>
 <div th:replace="footer :: copy"></div>
 </body>

th:include 和 th:replace區(qū)別，include只是加載，replace是替換

返回的HTML如下：

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

下面是一個(gè)常用的后臺(tái)頁(yè)面布局，將整個(gè)頁(yè)面分為頭部，尾部、菜單欄、隱藏欄，點(diǎn)擊菜單只改變content區(qū)域的頁(yè)面

<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>

任何頁(yè)面想使用這樣的布局值只需要替換中見(jiàn)的 content模塊即可

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

也可以在引用模版的時(shí)候傳參

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

layout 是文件地址，如果有文件夾可以這樣寫(xiě) fileName/layout:htmlhead

htmlhead 是指定義的代碼片段 如 th:fragment="copy"

源碼案例

這里有一個(gè)開(kāi)源項(xiàng)目幾乎使用了這里介紹的所有標(biāo)簽和布局，大家可以參考：

cloudfavorites

以上所述是小編給大家介紹的spring boot(四)之thymeleaf使用詳解，希望對(duì)大家有所幫助，如果大家有任何疑問(wèn)請(qǐng)給我留言，小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對(duì)億速云網(wǎng)站的支持！