原文:https://www.cnblogs.com/itdragon/archive/2018/04/13/8724291.html
Thymeleaf3語法詳解
Thymeleaf是Spring boot推薦使用的模版引擎,除此之外常見的還有Freemarker和Jsp。Jsp應該是我們最早接觸的模版引擎。而Freemarker工作中也很常見(Freemarker教程)。今天我們從三個方面學習Thymeleaf的語法:有常見的TH屬性,四種標准表達式用法,在SpringBoot中的應用。還在等什么,一起來學吧!
技術:Thymeleaf,SpringBoot
說明:為突出Thymeleaf3的語法知識,文章只提出與Thymeleaf有關的代碼,完整代碼請異步github,喜歡的朋友可以點個star,蟹蟹!
源碼:https://github.com/ITDragonBlog/daydayup/tree/master/Thymeleaf/spring-boot-thymeleaf
好文推薦: http://www.cnblogs.com/itdragon/p/8709948.html
文章目錄結構:
一、th屬性
常用th屬性解讀
html有的屬性,Thymeleaf基本都有,而常用的屬性大概有七八個。其中th屬性執行的優先級從1~8,數字越低優先級越高。
一、th:text :設置當前元素的文本內容,相同功能的還有th:utext,兩者的區別在於前者不會轉義html標簽,后者會。優先級不高:order=7
二、th:value:設置當前元素的value值,類似修改指定屬性的還有th:src,th:href。優先級不高:order=6
三、th:each:遍歷循環元素,和th:text或th:value一起使用。注意該屬性修飾的標簽位置,詳細往后看。優先級很高:order=2
四、th:if:條件判斷,類似的還有th:unless,th:switch,th:case。優先級較高:order=3
五、th:insert:代碼塊引入,類似的還有th:replace,th:include,三者的區別較大,若使用不恰當會破壞html結構,常用於公共代碼塊提取的場景。優先級最高:order=1
六、th:fragment:定義代碼塊,方便被th:insert引用。優先級最低:order=8
七、th:object:聲明變量,一般和*{}一起配合使用,達到偷懶的效果。優先級一般:order=4
八、th:attr:修改任意屬性,實際開發中用的較少,因為有豐富的其他th屬性幫忙,類似的還有th:attrappend,th:attrprepend。優先級一般:order=5
常用th屬性使用
使用Thymeleaf屬性需要注意點以下五點:
一、若要使用Thymeleaf語法,首先要聲明名稱空間: xmlns:th="http://www.thymeleaf.org"
二、設置文本內容 th:text,設置input的值 th:value,循環輸出 th:each,條件判斷 th:if,插入代碼塊 th:insert,定義代碼塊 th:fragment,聲明變量 th:object
三、th:each 的用法需要格外注意,打個比方:如果你要循環一個div中的p標簽,則th:each屬性必須放在p標簽上。若你將th:each屬性放在div上,則循環的是將整個div。
四、變量表達式中提供了很多的內置方法,該內置方法是用#開頭,請不要與#{}消息表達式弄混。
五、th:insert,th:replace,th:include 三種插入代碼塊的效果相似,但區別很大。
六.迭代下標變量用法:
狀態變量定義在一個th:每個屬性和包含以下數據:
1.當前迭代索引,從0開始。這是索引屬性。index
2.當前迭代索引,從1開始。這是統計屬性。count
3.元素的總量迭代變量。這是大小屬性。 size
4.iter變量為每個迭代。這是目前的財產。 current
5.是否當前迭代是奇數還是偶數。這些even/odd的布爾屬性。
6.是否第一個當前迭代。這是first布爾屬性。
7.是否最后一個當前迭代。這是last布爾屬性。
<div class="col-lg-1 col-sm-2 col-md-1 col_margin" th:each="bookNav,bookNavStat: ${bookNavs}" onclick="change_nav()" > <span class="hidden" th:text="${bookNavStat.index}"></span> <p th:text="${bookNav}" /> </div>
<!DOCTYPE html> <!--名稱空間--> <html lang="en" xmlns:th="http://www.thymeleaf.org"> <head> <meta charset="UTF-8"> <title>Thymeleaf 語法</title> </head> <body> <h2>ITDragon Thymeleaf 語法</h2> <!--th:text 設置當前元素的文本內容,常用,優先級不高--> <p th:text="${thText}" /> <p th:utext="${thUText}" /> <!--th:value 設置當前元素的value值,常用,優先級僅比th:text高--> <input type="text" th:value="${thValue}" /> <!--th:each 遍歷列表,常用,優先級很高,僅此於代碼塊的插入--> <!--th:each 修飾在div上,則div層重復出現,若只想p標簽遍歷,則修飾在p標簽上--> <div th:each="message : ${thEach}"> <!-- 遍歷整個div-p,不推薦--> <p th:text="${message}" /> </div> <div> <!--只遍歷p,推薦使用--> <p th:text="${message}" th:each="message : ${thEach}" /> </div> <!--th:if 條件判斷,類似的有th:switch,th:case,優先級僅次於th:each, 其中#strings是變量表達式的內置方法--> <p th:text="${thIf}" th:if="${not #strings.isEmpty(thIf)}"></p> <!--th:insert 把代碼塊插入當前div中,優先級最高,類似的有th:replace,th:include,~{} :代碼塊表達式 --> <div th:insert="~{grammar/common::thCommon}"></div> <!--th:object 聲明變量,和*{} 一起使用--> <div th:object="${thObject}"> <p>ID: <span th:text="*{id}" /></p><!--th:text="${thObject.id}"--> <p>TH: <span th:text="*{thName}" /></p><!--${thObject.thName}--> <p>DE: <span th:text="*{desc}" /></p><!--${thObject.desc}--> </div> </body> </html>
后台給負責給變量賦值,和跳轉頁面。
import com.itdragon.entities.ThObject; import org.springframework.stereotype.Controller; import org.springframework.ui.ModelMap; import org.springframework.web.bind.annotation.RequestMapping; import java.util.ArrayList; import java.util.Arrays; import java.util.List; @Controller public class ThymeleafController { @RequestMapping("thymeleaf") public String thymeleaf(ModelMap map) { map.put("thText", "th:text 設置文本內容 <b>加粗</b>"); map.put("thUText", "th:utext 設置文本內容 <b>加粗</b>"); map.put("thValue", "thValue 設置當前元素的value值"); map.put("thEach", Arrays.asList("th:each", "遍歷列表")); map.put("thIf", "msg is not null"); map.put("thObject", new ThObject(1L, "th:object", "用來偷懶的th屬性")); return "grammar/thymeleaf"; } }
二、標准表達式語法
${...}
變量表達式,Variable Expressions
@{...}
鏈接表達式,Link URL Expressions
#{...}
消息表達式,Message Expressions
~{...}
代碼塊表達式,Fragment Expressions
*{...}
選擇變量表達式,Selection Variable Expressions
變量表達式使用頻率最高,其功能也是非常的豐富。所以我們先從簡單的代碼塊表達式開始,然后是消息表達式,再是鏈接表達式,最后是變量表達式,隨帶介紹選擇變量表達式。
~{...} 代碼塊表達式
支持兩種語法結構
推薦:~{templatename::fragmentname}
支持:~{templatename::#id}
templatename:模版名,Thymeleaf會根據模版名解析完整路徑:/resources/templates/templatename.html,要注意文件的路徑。
fragmentname:片段名,Thymeleaf通過th:fragment聲明定義代碼塊,即:th:fragment="fragmentname"
id:HTML的id選擇器,使用時要在前面加上#號,不支持class選擇器。
代碼塊表達式的使用
代碼塊表達式需要配合th屬性(th:insert,th:replace,th:include)一起使用。
th:insert:將代碼塊片段整個插入到使用了th:insert的HTML標簽中,
th:replace:將代碼塊片段整個替換使用了th:replace的HTML標簽中,
th:include:將代碼塊片段包含的內容插入到使用了th:include的HTML標簽中,
用一個官方例子來區分三者的不同,第三部分會通過實戰再次用到該知識。
<!--th:fragment定義代碼塊標識--> <footer th:fragment="copy"> © 2011 The Good Thymes Virtual Grocery </footer> <!--三種不同的引入方式--> <div th:insert="footer :: copy"></div> <div th:replace="footer :: copy"></div> <div th:include="footer :: copy"></div> <!--th:insert是在div中插入代碼塊,即多了一層div--> <div> <footer> © 2011 The Good Thymes Virtual Grocery </footer> </div> <!--th:replace是將代碼塊代替當前div,其html結構和之前一致--> <footer> © 2011 The Good Thymes Virtual Grocery </footer> <!--th:include是將代碼塊footer的內容插入到div中,即少了一層footer--> <div> © 2011 The Good Thymes Virtual Grocery </div>
#{...} 消息表達式
消息表達式一般用於國際化的場景。結構:th:text="#{msg}"
。會在第三部分的實戰詳細介紹。
@{...} 鏈接表達式
鏈接表達式好處
不管是靜態資源的引用,form表單的請求,凡是鏈接都可以用@{...}
。這樣可以動態獲取項目路徑,即便項目名變了,依然可以正常訪問
#修改項目名,鏈接表達式會自動修改路徑,避免資源文件找不到 server.context-path=/itdragon
鏈接表達式結構
無參:@{/xxx}
有參:@{/xxx(k1=v1,k2=v2)}
對應url結構:xxx?k1=v1&k2=v2
引入本地資源:@{/項目本地的資源路徑}
引入外部資源:@{/webjars/資源在jar包中的路徑}
列舉:第三部分的實戰引用會詳細使用該表達式
<link th:href="@{/webjars/bootstrap/4.0.0/css/bootstrap.css}" rel="stylesheet"> <link th:href="@{/main/css/itdragon.css}" rel="stylesheet"> <form class="form-login" th:action="@{/user/login}" th:method="post" > <a class="btn btn-sm" th:href="@{/login.html(l='zh_CN')}">中文</a> <a class="btn btn-sm" th:href="@{/login.html(l='en_US')}">English</a>
${...}變量表達式
變量表達式有豐富的內置方法,使其更強大,更方便。
變量表達式功能
一、可以獲取對象的屬性和方法
二、可以使用ctx,vars,locale,request,response,session,servletContext內置對象
三、可以使用dates,numbers,strings,objects,arrays,lists,sets,maps等內置方法(重點介紹)
常用的內置對象
一、ctx :上下文對象。
二、vars :上下文變量。
三、locale:上下文的語言環境。
四、request:(僅在web上下文)的 HttpServletRequest 對象。
五、response:(僅在web上下文)的 HttpServletResponse 對象。
六、session:(僅在web上下文)的 HttpSession 對象。
七、servletContext:(僅在web上下文)的 ServletContext 對象
這里以常用的Session舉例,用戶刊登成功后,會把用戶信息放在Session中,Thymeleaf通過內置對象將值從session中獲取。
// java 代碼將用戶名放在session中 session.setAttribute("userinfo",username); // Thymeleaf通過內置對象直接獲取 th:text="${session.userinfo}"
常用的內置方法
一、strings:字符串格式化方法,常用的Java方法它都有。比如:equals,equalsIgnoreCase,length,trim,toUpperCase,toLowerCase,indexOf,substring,replace,startsWith,endsWith,contains,containsIgnoreCase等
二、numbers:數值格式化方法,常用的方法有:formatDecimal等
三、bools:布爾方法,常用的方法有:isTrue,isFalse等
四、arrays:數組方法,常用的方法有:toArray,length,isEmpty,contains,containsAll等
五、lists,sets:集合方法,常用的方法有:toList,size,isEmpty,contains,containsAll,sort等
六、maps:對象方法,常用的方法有:size,isEmpty,containsKey,containsValue等
七、dates:日期方法,常用的方法有:format,year,month,hour,createNow等
文章底部提供了對應的官網鏈接
<!DOCTYPE html> <html lang="en" xmlns:th="http://www.thymeleaf.org"> <head> <meta charset="UTF-8"> <title>ITDragon Thymeleaf 內置方法</title> </head> <body> <h2>ITDragon Thymeleaf 內置方法</h2> <h3>#strings </h3> <div th:if="${not #strings.isEmpty(itdragonStr)}" > <p>Old Str : <span th:text="${itdragonStr}"/></p> <p>toUpperCase : <span th:text="${#strings.toUpperCase(itdragonStr)}"/></p> <p>toLowerCase : <span th:text="${#strings.toLowerCase(itdragonStr)}"/></p> <p>equals : <span th:text="${#strings.equals(itdragonStr, 'itdragonblog')}"/></p> <p>equalsIgnoreCase : <span th:text="${#strings.equalsIgnoreCase(itdragonStr, 'itdragonblog')}"/></p> <p>indexOf : <span th:text="${#strings.indexOf(itdragonStr, 'r')}"/></p> <p>substring : <span th:text="${#strings.substring(itdragonStr, 2, 8)}"/></p> <p>replace : <span th:text="${#strings.replace(itdragonStr, 'it', 'IT')}"/></p> <p>startsWith : <span th:text="${#strings.startsWith(itdragonStr, 'it')}"/></p> <p>contains : <span th:text="${#strings.contains(itdragonStr, 'IT')}"/></p> </div> <h3>#numbers </h3> <div> <p>formatDecimal 整數部分隨意,小數點后保留兩位,四舍五入: <span th:text="${#numbers.formatDecimal(itdragonNum, 0, 2)}"/></p> <p>formatDecimal 整數部分保留五位數,小數點后保留兩位,四舍五入: <span th:text="${#numbers.formatDecimal(itdragonNum, 5, 2)}"/></p> </div> <h3>#bools </h3> <div th:if="${#bools.isTrue(itdragonBool)}"> <p th:text="${itdragonBool}"></p> </div> <h3>#arrays </h3> <div th:if="${not #arrays.isEmpty(itdragonArray)}"> <p>length : <span th:text="${#arrays.length(itdragonArray)}"/></p> <p>contains : <span th:text="${#arrays.contains(itdragonArray, 5)}"/></p> <p>containsAll : <span th:text="${#arrays.containsAll(itdragonArray, itdragonArray)}"/></p> </div> <h3>#lists </h3> <div th:if="${not #lists.isEmpty(itdragonList)}"> <p>size : <span th:text="${#lists.size(itdragonList)}"/></p> <p>contains : <span th:text="${#lists.contains(itdragonList, 0)}"/></p> <p>sort : <span th:text="${#lists.sort(itdragonList)}"/></p> </div> <h3>#maps </h3> <div th:if="${not #maps.isEmpty(itdragonMap)}"> <p>size : <span th:text="${#maps.size(itdragonMap)}"/></p> <p>containsKey : <span th:text="${#maps.containsKey(itdragonMap, 'thName')}"/></p>