Thymeleaf語法總結

Thymeleaf是Spring boot推薦使用的模板引擎。

 

 

1、th屬性

html有的屬性，Thymeleaf基本都有，而經常使用的屬性大概有七八個。其中th屬性執行的優先級從1~8，數字越低優先級越高。

一、th:insert：代碼塊引入，相似的還有th:replace，th:include，三者的區別較大，若使用不恰當會破壞html結構，經常使用於公共代碼塊提取的場景。優先級最高：order=1。

二、th:each：遍歷循環元素，和th:text或th:value一塊兒使用。注意該屬性修飾的標籤位置，詳細日後看。優先級很高：order=2。

三、th:if：條件判斷，相似的還有th:unless，th:switch，th:case。優先級較高：order=3。

四、th:object：聲明變量，通常和*{}一塊兒配合使用，達到偷懶的效果。優先級通常：order=4。

五、th:attr：修改任意屬性，實際開發中用的較少，由於有豐富的其餘th屬性幫忙，相似的還有th:attrappend，th:attrprepend。優先級通常：order=5。

六、th:value：設置當前元素的value值，相似修改指定屬性的還有th:src，th:href。優先級不高：order=6。

七、th:text ：設置當前元素的文本內容，相同功能的還有th:utext，二者的區別在於前者不會轉義html標籤，後者會。優先級不高：order=7。

八、th:fragment：定義代碼塊，方便被th:insert引用。優先級最低：order=8。

2、注意

一、若要使用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 三種插入代碼塊的效果類似，但區別很大。

3、標準表達式語法

${...} 變量表達式，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:text="#{msg}" 。

@{...} 連接表達式

連接表達式好處

不論是靜態資源的引用，form表單的請求，凡是連接均可以用@{...} 。這樣能夠動態獲取項目路徑，即使項目名變了，依然能夠正常訪問

#修改項目名，連接表達式會自動修改路徑，避免資源文件找不到 server.context-path=/itdragon

連接表達式結構

無參：@{/xxx}

有參：@{/xxx(k1=v1,k2=v2)} 對應url結構：xxx?k1=v1&k2=v2

引入本地資源：@{/項目本地的資源路徑}

引入外部資源：@{/webjars/資源在jar包中的路徑}

${...}變量表達式

變量表達式有豐富的內置方法，使其更強大，更方便。

變量表達式功能

1、能夠獲取對象的屬性和方法

2、可使用ctx，vars，locale，request，response，session，servletContext內置對象

3、可使用dates，numbers，strings，objects，arrays，lists，sets，maps等內置方法（重點介紹）

經常使用的內置對象

1、ctx ：上下文對象。

2、vars ：上下文變量。

3、locale：上下文的語言環境。

4、request：（僅在web上下文）的 HttpServletRequest 對象。

5、response：（僅在web上下文）的 HttpServletResponse 對象。

6、session：（僅在web上下文）的 HttpSession 對象。

7、servletContext：（僅在web上下文）的 ServletContext 對象

 

經常使用的內置方法

1、strings：字符串格式化方法，經常使用的Java方法它都有。好比：equals，equalsIgnoreCase，length，trim，toUpperCase，toLowerCase，indexOf，substring，replace，startsWith，endsWith，contains，containsIgnoreCase等

2、numbers：數值格式化方法，經常使用的方法有：formatDecimal等

3、bools：布爾方法，經常使用的方法有：isTrue，isFalse等

4、arrays：數組方法，經常使用的方法有：toArray，length，isEmpty，contains，containsAll等

5、lists，sets：集合方法，經常使用的方法有：toList，size，isEmpty，contains，containsAll，sort等

6、maps：對象方法，經常使用的方法有：size，isEmpty，containsKey，containsValue等

7、dates：日期方法，經常使用的方法有：format，year，month，hour，createNow等

4、總結

1、Thymeleaf 是Spring Boot 官方推薦的Java模版引擎框架，其文件擴展名爲.html

2、Thymeleaf 幾乎支持全部的html屬性，用於賦值的th:text和th:value，用於循環遍歷的th:each，用於條件判斷的th:if

3、Thymeleaf 提供四種標準的表達式，有豐富內置方法的${}，用於國際化的#{}，用於代碼插入的~{}，用於處理連接的@{}

4、必定要注意循環遍歷的th:each和代碼插入的th:insert用法，儘可能避免破壞html結構的細節問題