Thymeleaf語法總結
一、Thymeleaf介紹
Thymeleaf是Spring boot推薦使用的模版引擎，直接以html顯示，前后端可以很好的分離。
二、Thymeleaf語法（Thymeleaf3）
在使用Thymeleaf時頁面要引入名稱空間： xmlns:th="http://www.thymeleaf.org"
1、th屬性，常用th屬性如下：
1）th:text：文本替換；
2）th:utext：支持html的文本替換。
3）th:value：屬性賦值
4）th:each：遍歷循環元素
5）th:if：判斷條件，類似的還有th:unless，th:switch，th:case
6）th:insert：代碼塊引入，類似的還有th:replace，th:include，常用於公共代碼塊提取的場景
7）th:fragment：定義代碼塊，方便被th:insert引用
8）th:object：聲明變量，一般和*{}一起配合使用，達到偷懶的效果。
9）th:attr：設置標簽屬性，多個屬性可以用逗號分隔
例子：
<!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>
后台controller:
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"; } }
2、標准表達式語法：
${...} 變量表達式，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標簽中，
#{...} 消息表達式
消息表達式一般用於國際化的場景。
@{...} 鏈接表達式
鏈接表達式好處
不管是靜態資源的引用，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>
<p>containsValue : <span th:text="${#maps.containsValue(itdragonMap, '#maps')}"/></p>
</div>
<h3>#dates </h3>
<div>
<p>format : <span th:text="${#dates.format(itdragonDate)}"/></p>
<p>custom format : <span th:text="${#dates.format(itdragonDate, 'yyyy-MM-dd HH:mm:ss')}"/></p>
<p>day : <span th:text="${#dates.day(itdragonDate)}"/></p>
<p>month : <span th:text="${#dates.month(itdragonDate)}"/></p>
<p>monthName : <span th:text="${#dates.monthName(itdragonDate)}"/></p>
<p>year : <span th:text="${#dates.year(itdragonDate)}"/></p>
<p>dayOfWeekName : <span th:text="${#dates.dayOfWeekName(itdragonDate)}"/></p>
<p>hour : <span th:text="${#dates.hour(itdragonDate)}"/></p>
<p>minute : <span th:text="${#dates.minute(itdragonDate)}"/></p>
<p>second : <span th:text="${#dates.second(itdragonDate)}"/></p>
<p>createNow : <span th:text="${#dates.createNow()}"/></p>
</div></body></html>
@RequestMapping("varexpressions")public String varexpressions(ModelMap map) {
map.put("itdragonStr", "itdragonBlog");
map.put("itdragonBool", true);
map.put("itdragonArray", new Integer[]{1,2,3,4});
map.put("itdragonList", Arrays.asList(1,3,2,4,0));
Map itdragonMap = new HashMap();
itdragonMap.put("thName", "${#...}");
itdragonMap.put("desc", "變量表達式內置方法");
map.put("itdragonMap", itdragonMap);
map.put("itdragonDate", new Date());
map.put("itdragonNum", 888.888D); return "grammar/varexpressions";
}
參考博客：https://www.cnblogs.com/itdragon/archive/2018/04/13/8724291.html