javascript
SpringBoot Thymeleaf使用教程（实用版）
SpringBoot Thymeleaf使用教程（實用版）
使用Thymeleaf 三大理由：
- 簡潔漂亮 容易理解
- 完美支持HTML5 使用瀏覽器直接打開頁面
- 不新增標(biāo)簽 只需增強(qiáng)屬性
學(xué)習(xí)目標(biāo)
- 快速掌握Thymeleaf的基本使用（五大基礎(chǔ)語法+常用內(nèi)置對象）
快速查閱
專題閱讀：《SpringBoot 布道系列》
源碼下載：springboot-web-thymeleaf-enhance
— Hey Man，Don't forget to Star or Fork . —
官方指南：?Thymleaf 3.0 官方教程
相關(guān)教程：SpringBoot Thymeleaf 基本介紹?、?SpringBoot 在IDEA中實現(xiàn)熱部署(實用版)
使用教程
溫馨提示：Thymeleaf 最為顯著的特征是增強(qiáng)屬性，任何屬性都可以通過th:xx 來完成交互，例如th:value最終會覆蓋value屬性。
一、基礎(chǔ)語法
變量表達(dá)式?${}
使用方法：直接使用th:xx = "${}"?獲取對象屬性 。例如：
<form id="userForm"><input id="id" name="id" th:value="${user.id}"/><input id="username" name="username" th:value="${user.username}"/><input id="password" name="password" th:value="${user.password}"/> </form><div th:text="hello"></div><div th:text="${user.username}"></div>選擇變量表達(dá)式?*{}
使用方法：首先通過th:object?獲取對象，然后使用th:xx = "*{}"獲取對象屬性。
這種簡寫風(fēng)格極為清爽，推薦大家在實際項目中使用。 例如：
<form id="userForm" th:object="${user}"><input id="id" name="id" th:value="*{id}"/><input id="username" name="username" th:value="*{username}"/><input id="password" name="password" th:value="*{password}"/> </form>鏈接表達(dá)式?@{}
使用方法：通過鏈接表達(dá)式@{}直接拿到應(yīng)用路徑，然后拼接靜態(tài)資源路徑。例如：
<script th:src="@{/webjars/jquery/jquery.js}"></script> <link th:href="@{/webjars/bootstrap/css/bootstrap.css}" rel="stylesheet" type="text/css">片段表達(dá)式?~{}
片段表達(dá)式是Thymeleaf的特色之一，細(xì)粒度可以達(dá)到標(biāo)簽級別，這是JSP無法做到的。
片段表達(dá)式擁有三種語法：
- ~{ viewName } 表示引入完整頁面
- ~{ viewName ::selector} 表示在指定頁面尋找片段 其中selector可為片段名、jquery選擇器等
- ~{ ::selector} 表示在當(dāng)前頁尋找
使用方法：首先通過th:fragment定制片段 ，然后通過th:replace?填寫片段路徑和片段名。例如：
<!-- /views/common/head.html--> <head th:fragment="static"><script th:src="@{/webjars/jquery/3.3.1/jquery.js}"></script> </head><!-- /views/your.html --> <div th:replace="~{common/head::static}"></div>在實際使用中，我們往往使用更簡潔的表達(dá)，去掉表達(dá)式外殼直接填寫片段名。例如：
<!-- your.html --> <div th:replace="common/head::static"></div>值得注意的是，使用替換路徑th:replace?開頭請勿添加斜杠，避免部署運行的時候出現(xiàn)路徑報錯。（因為默認(rèn)拼接的路徑為spring.thymeleaf.prefix = classpath:/templates/）
消息表達(dá)式
即通常的國際化屬性：#{msg}?用于獲取國際化語言翻譯值。例如：
<title th:text="#{user.title}"></title>其它表達(dá)式
在基礎(chǔ)語法中，默認(rèn)支持字符串連接、數(shù)學(xué)運算、布爾邏輯和三目運算等。例如：
<input name="name" th:value="${'I am '+(user.name!=null?user.name:'NoBody')}"/>二、內(nèi)置對象
官方文檔：?附錄A： Thymeleaf 3.0 基礎(chǔ)對象?
官方文檔：?附錄B： Thymeleaf 3.0 工具類
七大基礎(chǔ)對象：
- ${#ctx}?上下文對象，可用于獲取其它內(nèi)置對象。
- ${#vars}: 上下文變量。
- ${#locale}：上下文區(qū)域設(shè)置。
- ${#request}: HttpServletRequest對象。
- ${#response}: HttpServletResponse對象。
- ${#session}: HttpSession對象。
- ${#servletContext}: ServletContext對象。
常用的工具類：
- #strings：字符串工具類
- #lists：List 工具類
- #arrays：數(shù)組工具類
- #sets：Set 工具類
- #maps：常用Map方法。
- #objects：一般對象類，通常用來判斷非空
- #bools：常用的布爾方法。
- #execInfo：獲取頁面模板的處理信息。
- #messages：在變量表達(dá)式中獲取外部消息的方法，與使用＃{...}語法獲取的方法相同。
- #uris：轉(zhuǎn)義部分URL / URI的方法。
- #conversions：用于執(zhí)行已配置的轉(zhuǎn)換服務(wù)的方法。
- #dates：時間操作和時間格式化等。
- #calendars：用于更復(fù)雜時間的格式化。
- #numbers：格式化數(shù)字對象的方法。
- #aggregates：在數(shù)組或集合上創(chuàng)建聚合的方法。
- #ids：處理可能重復(fù)的id屬性的方法。
三、迭代循環(huán)
想要遍歷List集合很簡單，配合th:each?即可快速完成迭代。例如遍歷用戶列表：
<div th:each="user:${userList}">賬號：<input th:value="${user.username}"/>密碼：<input th:value="${user.password}"/> </div>在集合的迭代過程還可以獲取狀態(tài)變量，只需在變量后面指定狀態(tài)變量名即可，狀態(tài)變量可用于獲取集合的下標(biāo)/序號、總數(shù)、是否為單數(shù)/偶數(shù)行、是否為第一個/最后一個。例如：
<div th:each="user,stat:${userList}" th:class="${stat.even}?'even':'odd'">下標(biāo)：<input th:value="${stat.index}"/>序號：<input th:value="${stat.count}"/>賬號：<input th:value="${user.username}"/>密碼：<input th:value="${user.password}"/> </div>如果缺省狀態(tài)變量名，則迭代器會默認(rèn)幫我們生成以變量名開頭的狀態(tài)變量?xxStat， 例如：
<div th:each="user:${userList}" th:class="${userStat.even}?'even':'odd'">下標(biāo)：<input th:value="${userStat.index}"/>序號：<input th:value="${userStat.count}"/>賬號：<input th:value="${user.username}"/>密碼：<input th:value="${user.password}"/> </div>四、條件判斷
條件判斷通常用于動態(tài)頁面的初始化，例如：
<div th:if="${userList}"><div>的確存在..</div> </div>如果想取反則使用unless 例如：
<div th:unless="${userList}"><div>不存在..</div> </div>五、日期格式化
使用默認(rèn)的日期格式(toString方法) 并不是我們預(yù)期的格式：Mon Dec 03 23:16:50 CST 2018
<input type="text" th:value="${user.createTime}"/>此時可以通過時間工具類#dates來對日期進(jìn)行格式化：2018-12-03 23:16:50
<input type="text" th:value="${#dates.format(user.createTime,'yyyy-MM-dd HH:mm:ss')}"/>六、內(nèi)聯(lián)寫法
-
（1）為什么要使用內(nèi)聯(lián)寫法？·答：因為 JS無法獲取服務(wù)端返回的變量。
-
（2）如何使用內(nèi)聯(lián)表達(dá)式？答：標(biāo)準(zhǔn)格式為：[[${xx}]]?，可以讀取服務(wù)端變量，也可以調(diào)用內(nèi)置對象的方法。例如獲取用戶變量和應(yīng)用路徑：
- （3）標(biāo)簽引入的JS里面能使用內(nèi)聯(lián)表達(dá)式嗎？答：不能！內(nèi)聯(lián)表達(dá)式僅在頁面生效，因為Thymeleaf只負(fù)責(zé)解析一級視圖，不能識別外部標(biāo)簽JS里面的表達(dá)式。
七、國際化
需要了解更多關(guān)于國際化的精彩描述請前往?SpringBoot 快速實現(xiàn)國際化i18n?。
例如在國際化文件中編寫了user.title這個鍵值，然后使用#{}讀取這個KEY即可獲取翻譯。
<title th:text="#{user.title}">用戶登陸</title>八、詳細(xì)教程
======== 有了上述基礎(chǔ)后 下面正式開始Thymeleaf 的詳細(xì)教程 ==============
首先通過Spring Initializr創(chuàng)建項目，如圖所示：
然后在POM文件引入web 、thymeleaf等依賴：
<dependencies><dependency><!--Web相關(guān)依賴--><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><!--頁面模板依賴--><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-thymeleaf</artifactId></dependency><dependency><!--熱部署依賴--><groupId>org.springframework.boot</groupId><artifactId>spring-boot-devtools</artifactId><scope>runtime</scope></dependency></dependencies>然后在src/main/resources/application.yml?配置頁面路徑：
spring:thymeleaf:cache: false #關(guān)閉緩存prefix: classpath:/views/ #調(diào)整頁面路徑接著在src/main/java/com/hehe/web/UserController?獲取用戶信息:
@RestController public class UserController {private List<User> userList = new ArrayList<>();{userList.add(new User("1", "socks", "123456", new Date()));userList.add(new User("2", "admin", "111111", new Date()));userList.add(new User("3", "jacks", "222222", null));}@GetMapping("/")public ModelAndView index() {return new ModelAndView("user/user", "userList", userList);} }public class User {private String id;private String username;private String password;private Date createTime;//省略get/set方法.. }開始編寫公共頁面：src/main/resources/views/common/head.html?，其中static為頁面片段：
<!DOCTYPE html> <html xmlns:th="http://www.thymeleaf.org"> <!--聲明static為頁面片段名稱--> <head th:fragment="static"><link th:href="@{/webjars/bootstrap/css/bootstrap.css}" rel="stylesheet" type="text/css"/><script th:src="@{/webjars/jquery/jquery.js}"></script> </head> </html>接著編寫用戶列表頁：src/main/resources/views/user/user.html?配合th:each顯示用戶列表信息。
使用說明：這里?th:replace="common/head::static"?表示將引用${spring.thymeleaf.prefix}/common/head.html的static頁面片段，值得注意的是由于替換路徑默認(rèn)會拼接前綴路徑，所以開頭切勿在添加斜杠，否則在打包成JAR部署運行時將提示報Templates not found...?。
<!DOCTYPE html> <html xmlns:th="http://www.thymeleaf.org"> <head><meta charset="UTF-8"/><title th:text="用戶信息">User</title><!--默認(rèn)拼接前綴路徑,開頭請勿再添加斜杠,防止部署運行報錯！--><script th:replace="common/head::static"></script> </head> <body><div th:each="user,userStat:${userList}" th:class="${userStat.even}?'even':'odd'">序號：<input type="text" th:value="${userStat.count}"/>賬號：<input type="text" th:value="${user.username}"/>密碼：<input type="password" th:value="${user.password}"/>時間：<input type="text" th:value="${user.createTime}"/>時間：<input type="text" th:value="${#dates.format(user.createTime,'yyyy-MM-dd HH:mm:ss')}"/> </div><script th:inline="javascript">//通過內(nèi)聯(lián)表達(dá)式獲取用戶信息var userList = [[${userList}]];console.log(userList) </script> </body> </html>然后編寫單個用戶頁面：
至此大功告成，然后快速啟動項目，如圖所示：
快速啟動項目
然后訪問用戶列表：?http://localhost:8080?，如圖所示：
然后訪問單個用戶：?http://localhost:8080/user/1?，如圖所示：
總結(jié)
以上是生活随笔為你收集整理的SpringBoot Thymeleaf使用教程（实用版）的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 微软 CTO 韦青：对微软这样已经走过4
- 下一篇： SpringBoot 快速开启事务（附常