一. 什么是Thymeleaf
Thymeleaf是面向Web和獨(dú)立環(huán)境的現(xiàn)代服務(wù)器端Java模板引擎命贴。
Thymeleaf的主要目標(biāo)是為您的開(kāi)發(fā)工作流程帶來(lái)優(yōu)雅的自然模板 - 可以正確顯示在瀏覽器中的HTML,也可以作為靜態(tài)原型工作欢峰,從而在開(kāi)發(fā)團(tuán)隊(duì)中進(jìn)行更強(qiáng)大的協(xié)作兑凿。
隨著Spring框架的模塊埃碱,與您最喜歡的工具的集成催蝗,以及插入自己的功能的能力苦酱,Thymeleaf是現(xiàn)代HTML5 JVM Web開(kāi)發(fā)的理想選擇,盡管它可以做的更多给猾。
好吧疫萤,我承認(rèn)剛才那段是Thymeleaf官方的說(shuō)明,我只不過(guò)機(jī)翻了一下敢伸。下面咱們說(shuō)點(diǎn)人話扯饶。Thymeleaf就是jsp的高端升級(jí)版。
二. 什么情況適合使用Thymeleaf
Thymeleaf顯然是一個(gè)開(kāi)發(fā)頁(yè)面的技術(shù)池颈,現(xiàn)在各種前端技術(shù)層出不窮尾序,比如現(xiàn)在主流的Vue、React躯砰、AngularJS等每币。很多人可能會(huì)要問(wèn),這個(gè)Thymeleaf相對(duì)于這些前端框架到底有啥優(yōu)勢(shì)琢歇。
其實(shí)兰怠,Thymeleaf跟那些前端框架根本不是一個(gè)類型的東西,也沒(méi)有啥可比性李茫。
Thymeleaf和老牌的jsp屬于非前后分離的思路來(lái)開(kāi)發(fā)的揭保。后端通過(guò)數(shù)據(jù)渲染html的模板,渲染后模板就是個(gè)完整的html頁(yè)面魄宏,將頁(yè)面返回給請(qǐng)求方秸侣。
主流的前端框架是基于前后端分離的思路來(lái)開(kāi)發(fā)的,前端頁(yè)面通過(guò)ajax來(lái)調(diào)用后端的rest接口來(lái)獲取數(shù)據(jù),再通過(guò)js進(jìn)行渲染頁(yè)面(不管什么前端技術(shù)其實(shí)都是對(duì)js進(jìn)行了封裝味榛,js依然是底層核心)椭坚。
使用前后分離主要有下面幾個(gè)好處
- 因?yàn)槊看握?qǐng)求服務(wù)器獲取的數(shù)據(jù)從整個(gè)頁(yè)面變成了僅僅是核心數(shù)據(jù),加載速度明顯提升励负。
- 前端人員和后端人員可以互相獨(dú)立開(kāi)發(fā)藕溅,最后在通過(guò)接口聯(lián)調(diào)即可。以前是不分前端工程師继榆、后端工程師的巾表,現(xiàn)在前后分離后,才出現(xiàn)了這樣的分類略吨。而且現(xiàn)在前端技術(shù)也越來(lái)越先進(jìn)集币。前后分離以后可以方便兩條技術(shù)路線的人員各自鉆研自己的技術(shù)。
- 前端頁(yè)面脫離后端服務(wù)器后翠忠,可以和后端分開(kāi)部署鞠苟。這時(shí)就可以對(duì)前端頁(yè)面的服務(wù)器進(jìn)行一些專門(mén)的網(wǎng)絡(luò)優(yōu)化進(jìn)一步提高訪問(wèn)速度。
- 后端只需要一套rest接口就可以同時(shí)服務(wù)于電腦頁(yè)面秽之、IOS客戶端当娱、安卓客戶端。甚至現(xiàn)在還有些前端技術(shù)可以直接把前端頁(yè)面打包成IOS考榨、安卓的客戶端跨细。
- ......
說(shuō)了這么多前后分離的好處,你可能就要問(wèn)了河质,那我們?yōu)槭裁催€要用那個(gè)看起來(lái)那么low的模板引擎呢冀惭?
為了速度。前后分離方式掀鹅,前端頁(yè)面通過(guò)ajax來(lái)調(diào)用后端的rest接口來(lái)獲取數(shù)據(jù)散休,再通過(guò)js進(jìn)行渲染頁(yè)面。獲取數(shù)據(jù)和通過(guò)js渲染頁(yè)面的代碼乐尊,很多時(shí)候比頁(yè)面本身要多的多戚丸,而且通過(guò)js來(lái)操作dom進(jìn)行渲染,稍微復(fù)雜些的頁(yè)面往往就會(huì)把渲染邏輯搞的錯(cuò)綜復(fù)雜科吭。相信從jsp時(shí)代一路走到現(xiàn)在的老程序員都深知工作量是成倍的往上翻昏滴。
固然剛才列舉了前后分離的種種好處,但這些好處大多數(shù)都是集中在app開(kāi)發(fā)上对人,其他某些場(chǎng)景下這些好處并不明顯谣殊。最典型的一個(gè)場(chǎng)景就是管理后臺(tái)。管理后臺(tái)往往對(duì)頁(yè)面的花哨性要求不高牺弄,并發(fā)量也不大姻几,而且功能往往還不少。這種場(chǎng)景下,前后分離技術(shù)上導(dǎo)致的工作量大幅度增加蛇捌,人員上分離導(dǎo)致額外的聯(lián)調(diào)成本都成了不少的負(fù)擔(dān)抚恒。Thymeleaf作為模板引擎這時(shí)候優(yōu)勢(shì)就非常大。只需要在html原型的頁(yè)面上稍微加幾個(gè)標(biāo)簽络拌,即可完成渲染俭驮。而且加上的標(biāo)簽并不影響原型頁(yè)面直接通過(guò)html打開(kāi)。
說(shuō)了這么多春贸,總結(jié)一下混萝,Thymeleaf是一個(gè)供后端人員使用的,為快速開(kāi)發(fā)頁(yè)面而生的Java模板引擎萍恕。
三. 如何在Springboot中引入Thymeleaf
Thymeleaf作為spring官方推薦的模板引擎逸嘀,在spring體系中使用異常方便。這里以gradle構(gòu)建的項(xiàng)目為例來(lái)說(shuō)明允粤。
首先崭倘,你要先修改build.gradle引入Springboot對(duì)Thymeleaf提供的依賴包。在dependencies中增加如下配置类垫。
compile('org.springframework.boot:spring-boot-starter-thymeleaf')
等待gradle幫你自己下載完依賴包后司光,你可以看到引入的Thymeleaf的版本。
嗯悉患?springboot1.5.7默認(rèn)引用的Thymeleaf依賴包居然還是2.1.5版本飘庄。最新的Thymeleaf不是已經(jīng)更新3.x版本了么。如果我想使用最新版的Thymeleaf要怎么辦呢购撼。
在build.gradle文件中,buildscript下增加配置谴仙,完整的配置如下圖
ext['thymeleaf.version'] = '3.0.7.RELEASE'
ext['thymeleaf-layout-dialect.version'] = '2.2.2'
等待gradle下載完成迂求,你可以看到引入的Thymeleaf已經(jīng)是最新版本了。
四. 快速入門(mén)
接下來(lái)要在項(xiàng)目中使用Thymeleaf了晃跺,這里用一個(gè)簡(jiǎn)單的單表查詢來(lái)舉個(gè)栗子揩局。
一般來(lái)說(shuō),開(kāi)發(fā)一個(gè)需要渲染數(shù)據(jù)的頁(yè)面掀虎,分為三個(gè)步驟凌盯。
- 開(kāi)發(fā)靜態(tài)頁(yè)面,即常說(shuō)的模型烹玉。
- 獲取數(shù)據(jù)驰怎。
- 使用數(shù)據(jù)對(duì)靜態(tài)頁(yè)面進(jìn)行渲染。
這里我們先做第一個(gè)步驟二打,開(kāi)發(fā)靜態(tài)頁(yè)面县忌。為了簡(jiǎn)單,就不做任何css了,下面是頁(yè)面的源碼症杏。
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>標(biāo)題</title>
</head>
<body>
<strong>標(biāo)題</strong>
<form action="list.html" method="post">
<input type="hidden" name="pageNumber">
用戶名:<input type="text" name="username">
<br/>
姓名:<input type="text" name="name">
<br/>
<button type="submit">提交</button> <button type="reset">重置</button>
</form>
<table>
<thead>
<tr>
<th class="am-hide-sm-only">id</th>
<th>用戶名</th>
<th>姓名</th>
<th class="am-hide-sm-only">電話</th>
<th class="am-hide-sm-only">郵箱</th>
<th class="am-hide-sm-only">是否可用</th>
<th>操作</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>用戶名</td>
<td>姓名</td>
<td>電話</td>
<td>郵箱</td>
<td>
<span>可用</span><span>不可用</span>
</td>
<td><button>修改</button><button>刪除</button></td>
</tr>
</tbody>
</table>
</body>
</html>
直接使用瀏覽器打開(kāi)該頁(yè)面装获,長(zhǎng)成這樣。
現(xiàn)在有了靜態(tài)頁(yè)面厉颤,該獲取數(shù)據(jù)了穴豫。下面是controller層的代碼。
/**
* 用戶管理
*/
@Controller
@RequestMapping("/users")
public class UserController
{
@Autowired
private UserRepository userRepository;
@Value("${pageSize}")
private Integer pageSize;
/**
* 分頁(yè)查詢信息
*/
@RequestMapping(method = {RequestMethod.GET, RequestMethod.POST})
public String list(Model model, User user, @RequestParam(value = "pageNumber", required = false, defaultValue = "0") Integer pageNumber)
{
ExampleMatcher matcher = ExampleMatcher.matching().withStringMatcher(ExampleMatcher.StringMatcher.CONTAINING);
PageRequest pageRequest = new PageRequest(pageNumber, pageSize);
Page<User> page = userRepository.findAll(Example.of(user, matcher), pageRequest);
//分頁(yè)查詢數(shù)據(jù)
model.addAttribute("page", page);
//查詢條件
model.addAttribute("user", user);
//頁(yè)面標(biāo)題
model.addAttribute("title", "用戶管理");
//轉(zhuǎn)到待渲染模板逼友,所有模板都在templates文件夾下精肃,users/list指templates文件夾下的users文件夾下的list.html頁(yè)面。
return "users/list";
}
}
這里使用spring-data-jpa從數(shù)據(jù)庫(kù)里查詢到了記錄并和查詢條件翁逞、頁(yè)面標(biāo)題一起轉(zhuǎn)到待渲染的模板肋杖。這里,我們將剛才的靜態(tài)頁(yè)面文件復(fù)制到對(duì)應(yīng)的位置挖函。如下圖状植。
下面,我們要對(duì)該文件進(jìn)行適當(dāng)?shù)母脑煸勾怪蔀橐粋€(gè)Thymeleaf模板文件津畸。先貼上改造后的文件。
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<title th:text="${title}">標(biāo)題</title>
<meta charset="UTF-8">
</head>
<body>
<strong th:text="${title}">標(biāo)題</strong>
<form th:action="@{/users}" th:object="${user}" method="post">
<input type="hidden" name="pageNumber" th:value="${page.number}">
用戶名:<input type="text" name="username" th:value="*{username}">
<br/>
姓名:<input type="text" name="name" th:value="*{name}">
<br/>
<button type="submit">提交</button> <button type="reset">重置</button>
</form>
<table>
<thead>
<tr>
<th class="am-hide-sm-only">id</th>
<th>用戶名</th>
<th>姓名</th>
<th class="am-hide-sm-only">電話</th>
<th class="am-hide-sm-only">郵箱</th>
<th class="am-hide-sm-only">是否可用</th>
<th>操作</th>
</tr>
</thead>
<tbody>
<tr th:each="user : ${page.content}">
<td th:text="${user.id}">id</td>
<td th:text="${user.username}">用戶名</td>
<td th:text="${user.name}">姓名</td>
<td th:text="${user.phone}">電話</td>
<td th:text="${user.email}">郵箱</td>
<td th:switch="${user.enabled}">
<span th:case="true">可用</span><span th:case="false">不可用</span>
</td>
<td><button>修改</button><button>刪除</button></td>
</tr>
</tbody>
</table>
</body>
</html>
可以看到必怜,我們對(duì)html代碼的結(jié)構(gòu)絲毫未改動(dòng)肉拓,只是在一些標(biāo)簽里面添加了th:xxx="yyy"
的屬性。
我們重新使用瀏覽器打開(kāi)Thymeleaf改造過(guò)的html文件梳庆。發(fā)現(xiàn)雖然我們添加了那么多th:xxx="yyy"
的標(biāo)簽暖途,但是,頁(yè)面居然和之前一模一樣膏执。
下面我們啟動(dòng)服務(wù)驻售,通過(guò)controller定義的那個(gè)url來(lái)訪問(wèn)渲染后的頁(yè)面。
同一個(gè)文件更米,瀏覽器直接打開(kāi)就是原型欺栗,服務(wù)器渲染后打開(kāi)就是真實(shí)的功能頁(yè)面。
這里我們就可以看出Thymeleaf的一個(gè)核心功能征峦,就是將其邏輯注入到模板文件中迟几,不會(huì)影響模板被用作設(shè)計(jì)原型。做到了原型即頁(yè)面栏笆。
Thymeleaf的核心語(yǔ)法就是th:xxx="yyy"
类腮,即設(shè)置html標(biāo)簽中xxx屬性的值為yyy對(duì)應(yīng)的值。
五. 設(shè)置屬性
我們先來(lái)說(shuō)一說(shuō)th:xxx
的部分蛉加,即設(shè)置屬性存哲。
Thymeleaf的核心功能就是通過(guò)在html標(biāo)簽里面追加屬性因宇。可以設(shè)置的屬性非常多祟偷,詳細(xì)的可以參考 Thymeleaf所有屬性的還沒(méi)發(fā)文檔察滑。這里我們就挑選些常用的舉幾個(gè)例子,其他大家可以舉一反三推斷出用法修肠。
th:object="yyy"
將對(duì)象作為一個(gè)范圍內(nèi)可用的變量贺辰。一般和選擇表達(dá)式*{zzz}
配合使用,選擇表達(dá)式后面會(huì)講到嵌施。th:text="yyy"
這個(gè)屬性可以添加到幾乎所有分為頭尾兩部分<></>
的html標(biāo)簽中饲化,如<title></title>
、<td><td/>
等吗伤。th:text="yyy"
的作用是把表達(dá)式y(tǒng)yy對(duì)應(yīng)的值添加到標(biāo)簽的中間吃靠。
如<td th:text="user">用戶名</td>
渲染后就是<td>user<td/>
。th:value="${title}"
這個(gè)屬性一般和<input />
標(biāo)簽搭配使用足淆,用來(lái)設(shè)置<input />
標(biāo)簽的value
值巢块。
如<input th:value="username" />
渲染后就是<input value="username" />
。
六. 表達(dá)式
下面我們?cè)賮?lái)對(duì)這些th:xxx="yyy"
中"yyy"
的部分進(jìn)行講解巧号。這個(gè)yyy我們一般稱之為表達(dá)式族奢。
Thymeleaf里面表達(dá)式主要有以下幾種。
-
${yyy}
變量表達(dá)式丹鸿,用來(lái)獲取上下文對(duì)象里面的值(controller返回的model)越走。還是以上面的例子來(lái)說(shuō)明,如果我想要取到page
對(duì)象中的number
屬性靠欢,使用${page.number}
即可廊敌。
-
#{yyy}
消息表達(dá)式,根據(jù)消息的key來(lái)獲取消息內(nèi)容门怪。一般是用來(lái)做國(guó)際化用的庭敦。 -
*{yyy}
選擇表達(dá)式,跟變量表達(dá)式用法差不多薪缆,但變量表達(dá)式是獲取上下文里的對(duì)象,選擇表達(dá)式是獲取一個(gè)選擇的對(duì)象伞广。
選擇表達(dá)式一般和th:object=
標(biāo)簽配合使用拣帽,還是以上面的例子來(lái)說(shuō)明。
先用th:object="${user}"
選擇了上下文中的user
對(duì)象嚼锄,下面想使用user
對(duì)象的username
屬性時(shí)减拭,直接使用*{username}
就可以了。
你可能想要問(wèn)区丑,我直接使用${user.username}
不是一樣可以找到user
對(duì)象的username
屬性么拧粪,為什么還要再搞個(gè)選擇表達(dá)式修陡?
因?yàn)?code>${user.username}是先從下上文找到user
,對(duì)象可霎,再?gòu)?code>user對(duì)象里找到username
屬性魄鸦;而*{username}
是直接從user
對(duì)象里找到username
屬性。當(dāng)需要從一個(gè)對(duì)象里獲取很多屬性的時(shí)候癣朗,使用選擇表達(dá)式可以提高效率拾因。
-
@{yyy}
鏈接表達(dá)式 設(shè)置超鏈接時(shí)用的表達(dá)式,一般和th:action
旷余、th:href
配合使用绢记。
~{page :: fragment}
分段表達(dá)式,主要用作公共模塊的復(fù)用正卧,一般和th:insert
蠢熄、th:replace
搭配使用。以后講模塊復(fù)用的時(shí)候再細(xì)說(shuō)炉旷。yyy
文字签孔。可以為字符串砾跃、數(shù)字骏啰、布爾、null抽高。如<td th:text="user">用戶名</td>
渲染后為<td>user</td>
判耕。_
無(wú)操作。下劃線是thymeleaf表達(dá)式的特殊字符翘骂,如果表達(dá)式就一個(gè)下劃線壁熄,則什么也不做。例如<td th:text="_">用戶名</td>
渲染后依然是<td>用戶名</td>
碳竟。
七. 迭代器
我們?cè)阡秩卷?yè)面時(shí)草丧,經(jīng)常需要對(duì)一個(gè)list進(jìn)行循環(huán)處理,最典型的場(chǎng)景就是使用表格展示多條數(shù)據(jù)莹桅。這時(shí)昌执,就需要使用到thymeleaf的迭代器th:each
。
<tr th:each="user : ${users}">
<td th:text="${user.id}">id</td>
<td th:text="${user.username}">用戶名</td>
</tr>
在這個(gè)例子中诈泼,users
是一個(gè)list懂拾,通過(guò)迭代器th:each
對(duì)其進(jìn)行遍歷,每次迭代獲取到的對(duì)象為user
铐达。在th:each
屬性的對(duì)應(yīng)的標(biāo)簽之間<tr th:each="user : ${users}">...</tr>
岖赋,為user
對(duì)象的有效范圍。
有時(shí)候瓮孙,我們還想要知道迭代器的一些狀態(tài)屬性唐断,如總數(shù)选脊,當(dāng)前索引等×掣剩可以通過(guò)如下方法獲取恳啥。
<tr th:each="user,stat : ${users}">
<td th:text="${stat.index}">index</td>
<td th:text="${user.id}">id</td>
<td th:text="${user.username}">用戶名</td>
</tr>
th:each=""
的第二個(gè)變量stat
,就是迭代器的狀態(tài)變量斤程,從這個(gè)狀態(tài)變量里面可以獲取到很多我們想要的屬性角寸,主要有下面這些。
-
stat.index
當(dāng)前對(duì)象在list中的索引忿墅。從0開(kāi)始扁藕。 -
stat.count
和index
差不多,也是當(dāng)前對(duì)象在list中的索引疚脐,不過(guò)是從1開(kāi)始亿柑。 -
stat.size
迭代器中元素的總數(shù)。 -
stat.current
當(dāng)前迭代的對(duì)象棍弄。 -
stat.even
當(dāng)前迭代的索引是否是奇數(shù)望薄,索引指stat.index
-
stat.odd
當(dāng)前迭代的索引是否是偶數(shù),索引指stat.index
-
stat.first
當(dāng)前迭代的對(duì)象是否是迭代器中的第一個(gè)呼畸。 -
stat.last
當(dāng)前迭代的對(duì)象是否是迭代器中的最后一個(gè)痕支。
八. 條件語(yǔ)句
th:if="boolean"
th:if
的表達(dá)式需為boolean值。如果為true蛮原,則標(biāo)簽顯示卧须,如果為false,則標(biāo)簽不顯示儒陨。
th:unless="boolean"
th:unless
和th:if
相反花嘶,表達(dá)式也需為boolean值。如果為true蹦漠,則標(biāo)簽不顯示椭员,如果為false,則標(biāo)簽顯示笛园。
<span th:if="${stat.odd}">偶</span>
<span th:unless="${stat.odd}">奇</span>
th:swtich
一般和 th:case
結(jié)合使用 隘击。和java語(yǔ)言中的swtich case
語(yǔ)法用法類似。
<td th:switch="${user.enabled}">
<span th:case="true">可用</span><span th:case="false">不可用</span>
</td>
九. 工具類
Thymeleaf提供了一些工具類研铆,這里舉個(gè)簡(jiǎn)單的例子展示下用法埋同,其他詳細(xì)的可以查看Thymeleaf工具類官方文檔。
#lists
數(shù)組工具類
總共有<span th:text="${#lists.size(page.content)}">1</span>條記錄