Thymeleaf入門到吃灰

Thymeleaf

　　

官網部分翻譯：反正就是各種好

• Thymeleaf是用來開發Web和獨立環境項目的服務器端的Java模版引擎

• Spring官方支持的服務的渲染模板中，並不包含jsp。而是Thymeleaf和Freemarker等，而Thymeleaf與SpringMVC的視圖技術，及SpringBoot的自動化配置集成非常完美，幾乎沒有任何成本，你只用關注Thymeleaf的語法即可。

Thymeleaf的特點

• 動靜結合：Thymeleaf 在有網絡和無網絡的環境下皆可運行，即它可以讓美工在瀏覽器查看頁面的靜態效果，也可以讓程序員在服務器查看帶數據的動態頁面效果。這是由於它支持 html 原型，然后在 html 標簽里增加額外的屬性來達到模板+數據的展示方式。瀏覽器解釋 html 時會忽略未定義的標簽屬性，所以 thymeleaf 的模板可以靜態地運行；當有數據返回到頁面時，Thymeleaf 標簽會動態地替換掉靜態內容，使頁面動態顯示。

• 開箱即用：它提供標准和spring標准兩種方言，可以直接套用模板實現JSTL、 OGNL表達式效果，避免每天套模板、該jstl、改標簽的困擾。同時開發人員也可以擴展和創建自定義的方言。

• 多方言支持：Thymeleaf 提供spring標准方言和一個與 SpringMVC 完美集成的可選模塊，可以快速的實現表單綁定、屬性編輯器、國際化等功能。

• 與SpringBoot完美整合，SpringBoot提供了Thymeleaf的默認配置，並且為Thymeleaf設置了視圖解析器，我們可以像以前操作jsp一樣來操作Thymeleaf。代碼幾乎沒有任何區別，就是在模板語法上有區別。

SpringBoot與之整合

我們創建一個SpringBoot項目，添加相關依賴，下面我們就可以入門吧

pom.xml

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
    </dependencies>

自動配置

自動給我們默認分配了模版的前綴和后綴，我們只需要按部就班的將模版丟進去即可

我們寫一個Controller：

將返回的對應的模版添加到默認的位置下：

編寫配置文件application.yml：

然后編寫一個springBoot的啟動類，這里不多說了，直接啟動項目訪問測試即可：

Thymeleaf常用語法

Thymeleaf的主要作用是把model中的數據渲染到html中，因此其語法主要是如何解析model中的數據。從以下方面來學習：

• 變量、方法、條件判斷、循環、運算 [ 邏輯運算、布爾運算、比較運算、條件運算 ]

• 其它

變量_變量案列

我們先新建一個實體類：User

public class User { String name; int age; User friend;// 對象類型屬性
}

然后在模型中添加數據

@GetMapping("test2") public String test2(Model model){ User user = new User(); user.setAge(21); user.setName("Jackson"); user.setFriend(new User("李小龍", 30)); ​ model.addAttribute("user", user); return "hello2"; }

語法說明：

Thymeleaf通過${}來獲取model中的變量，注意這不是el表達式，而是ognl表達式，但是語法非常像。

示例：

我們在頁面獲取user數據：

<h1> 你好：<span th:text="${user.name}">請跟我來</span>
</h1>

感覺跟el表達式差不多的。區別在於，我們的表達式寫在一個名為：th:text的標簽屬性中，這個叫做指令

變量_動靜結合

指令：

Thymeleaf崇尚模板是純正的html代碼，脫離模板引擎，在純靜態環境也可以直接運行。現在如果我們直接在html中編寫 ${}這樣的表達式，顯然在靜態環境下就會出錯，這不符合Thymeleaf的理念。

Thymeleaf中所有的表達式都需要寫在"指令"中，指令是HTML5中的自定義屬性，在Thymeleaf中所有指令都是以th:開頭。因為表達式${user.name}是寫在自定義屬性中，因此在靜態環境下，表達式的內容會被當做是普通字符串，瀏覽器會自動忽略這些指令，這樣就不會報錯了。

如果我們不經過SpringMVC，而是直接用瀏覽器打開編寫的頁面：在靜態環境下,th指令不會被識別，但是也不會報錯，而是顯示<span>標簽的缺省默認值："請跟我來"

指令的設計，正是Thymeleaf的高明之處，也是它優於其它模板引擎的原因。動靜結合的設計，使得無論是前端開發人員還是后端開發人員可以完美契合。

向下兼容

但是要注意，如果瀏覽器不支持Html5怎么辦？

如果不支持這種th:的命名空間寫法，那么可以把th:text換成 data-th-text，Thymeleaf也可以兼容。

escape

另外，th:text指令出於安全考慮，會把表達式讀取到的值進行處理，防止html的注入。

例如，<p>你好</p>將會被格式化輸出為$lt;p$gt;你好$lt;/p$lt;。

如果想要不進行格式化輸出，而是要輸出原始內容，則使用th:utext來代替.

變量_ognl表達式的語法糖

剛才獲取變量值，我們使用的是經典的對象.屬性名方式。但有些情況下，我們的屬性名可能本身也是變量，怎么辦？

ognl提供了類似js的語法方式：

例如：${user.name} 可以寫作${user['name']}

變量_自定義變量

場景

看下面的案例：

<h2>
    <p>Name: <span th:text="${user.name}">Jack</span>.</p>
    <p>Age: <span th:text="${user.age}">21</span>.</p>
    <p>friend: <span th:text="${user.friend.name}">Rose</span>.</p>
</h2>

我們獲取用戶的所有信息，分別展示。

當數據量比較多的時候，頻繁的寫user.就會非常麻煩。

因此，Thymeleaf提供了自定義變量來解決：

示例：

<h2 th:object="${user}">
    <p>Name: <span th:text="*{name}">Jack</span>.</p>
    <p>Age: <span th:text="*{age}">21</span>.</p>
    <p>friend: <span th:text="*{friend.name}">Rose</span>.</p>
</h2>

• 首先在 h2上 用 th:object="${user}"獲取user的值，並且保存

• 然后，在h2內部的任意元素上，可以通過 *{屬性名}的方式，來獲取user中的屬性，這樣就省去了大量的user.前綴了

方法

ognl表達式中的方法調用

ognl表達式本身就支持方法調用，例如：

<h2 th:object="${user}">
    <p>FirstName: <span th:text="*{name.split(' ')[0]}">Jack</span>.</p>
    <p>LastName: <span th:text="*{name.split(' ')[1]}">Li</span>.</p>
</h2>

• 這里我們調用了name（是一個字符串）的split方法。

Thymeleaf內置對象

Thymeleaf中提供了一些內置對象，並且在這些對象中提供了一些方法，方便我們來調用。獲取這些對象，需要使用#對象名來引用。

• 一些環境相關對象

對象	作用
#ctx	獲取Thymeleaf自己的Context對象
#requset	如果是web程序，可以獲取HttpServletRequest對象
#response	如果是web程序，可以獲取HttpServletReponse對象
#session	如果是web程序，可以獲取HttpSession對象
#servletContext	如果是web程序，可以獲取HttpServletContext對象

• Thymeleaf提供的全局對象：

對象	作用
#dates	處理java.util.date的工具對象
#calendars	處理java.util.calendar的工具對象
#numbers	用來對數字格式化的方法
#strings	用來處理字符串的方法
#bools	用來判斷布爾值的方法
#arrays	用來護理數組的方法
#lists	用來處理List集合的方法
#sets	用來處理set集合的方法
#maps	用來處理map集合的方法

• 舉例

我們在環境變量中添加日期類型對象

@GetMapping("test3") public String show3(Model model){ model.addAttribute("today", new Date()); return "hello3"; }

在頁面中處理

<p> 今天是: <span th:text="${#dates.format(today,'yyyy-MM-dd')}">2018-04-25</span>
</p>

方法_字面值

有的時候，我們需要在指令中填寫基本類型如：字符串、數值、布爾等，並不希望被Thymeleaf解析為變量，這個時候稱為字面值。

• 字符串字面值

  使用一對'引用的內容就是字符串字面值了：

  <p> 你正在觀看 <span th:text="'thymeleaf'">template</span> 的字符串常量值. </p>

  th:text中的thymeleaf並不會被認為是變量，而是一個字符串

• 數字字面值

  數字不需要任何特殊語法， 寫的什么就是什么，而且可以直接進行算術運算

  <p>今年是 <span th:text="2018">1900</span>.</p>
  <p>兩年后將會是 <span th:text="2018 + 2">1902</span>.</p>

• 布爾字面值

  布爾類型的字面值是true或false：

  <div th:if="true"> 你填的是true </div>

  這里引用了一個th:if指令，跟vue中的v-if類似

方法_拼接

我們經常會用到普通字符串與表達式拼接的情況：

<span th:text="'歡迎您:' + ${user.name} + '!'"></span>

字符串字面值需要用''，拼接起來非常麻煩，Thymeleaf對此進行了簡化，使用一對|即可：

<span th:text="|歡迎您:${user.name}|"></span>

運算

需要注意：${}內部的是通過OGNL表達式引擎解析的，外部的才是通過Thymeleaf的引擎解析，因此運算符盡量放在${}外進行。

• 算術運算

  支持的算術運算符：+ - * / %

  <span th:text="${user.age}"></span> //21 <span th:text="${user.age}%2 == 0"></span>  //false

• 比較運算

  支持的比較運算：>, <, >= and <= ，但是>, <不能直接使用，因為xml會解析為標簽，要使用別名。

  注意 == and !=不僅可以比較數值，類似於equals的功能。

  可以使用的別名：gt (>), lt (<), ge (>=), le (<=), not (!). Also eq (==), neq/ne (!=).

• 條件運算

  • 三元運算

  <span th:text="${user.sex} ? '男':'女'"></span>

  • 默認值

    有的時候，我們取一個值可能為空，這個時候需要做非空判斷，可以使用 表達式 ?: 默認值簡寫：

  <span th:text="${user.name} ?: '二狗'"></span>

  當前面的表達式值為null時，就會使用后面的默認值。

  注意：?:之間沒有空格。

循環

循環也是非常頻繁使用的需求，我們使用th:each指令來完成：

假如有用戶的集合：users在Context中。

<tr th:each="user : ${users}">
    <td th:text="${user.name}">Onions</td>
    <td th:text="${user.age}">2.41</td>
</tr>

• ${users} 是要遍歷的集合，可以是以下類型：

  • Iterable，實現了Iterable接口的類

  • Enumeration，枚舉

  • Interator，迭代器

  • Map，遍歷得到的是Map.Entry

  • Array，數組及其它一切符合數組結果的對象

在迭代的同時，我們也可以獲取迭代的狀態對象：

<tr th:each="user,stat : ${users}">
    <td th:text="${user.name}">Onions</td>
    <td th:text="${user.age}">2.41</td>
</tr>

stat對象包含以下屬性：

• index，從0開始的角標

• count，元素的個數，從1開始

• size，總元素個數

• current，當前遍歷到的元素

• even/odd，返回是否為奇偶，boolean值

• first/last，返回是否為第一或最后，boolean值

邏輯判斷

有了if和else，我們能實現一切功能^_^。

Thymeleaf中使用th:if 或者 th:unless ，兩者的意思恰好相反。

<span th:if="${user.age} > 24">老油條</span>

如果表達式的值為true，則標簽會渲染到頁面，否則不進行渲染。

以下情況被認定為true：

• 表達式值為true

• 表達式值為非0數值

• 表達式值為非0字符

• 表達式值為字符串，但不是"false","no","off"

• 表達式不是布爾、字符串、數字、字符中的任何一種

其它情況包括null都被認定為false

分支控制switch

這里要使用兩個指令：th:switch 和 th:case

<div th:switch="${user.role}">
  <p th:case="'admin'">用戶是管理員</p>
  <p th:case="'manager'">用戶是經理</p>
  <p th:case="*">用戶是別的玩意</p>
</div>

需要注意的是，一旦有一個th:case成立，其它的則不再判斷。與java中的switch是一樣的。

另外th:case="*"表示默認，放最后。

JS模板

模板引擎不僅可以渲染html，也可以對JS中的進行預處理。而且為了在純靜態環境下可以運行，其Thymeleaf代碼可以被注釋起來：

<script th:inline="javascript"> const user = /*[[${user}]]*/ {}; const age = /*[[${user.age}]]*/ 20; console.log(user); console.log(age) </script>

• 在script標簽中通過th:inline="javascript"來聲明這是要特殊處理的js腳本

• 語法結構：

  const user = /*[[Thymeleaf表達式]]*/ "靜態環境下的默認值";

  因為Thymeleaf被注釋起來，因此即便是靜態環境下， js代碼也不會報錯，而是采用表達式后面跟着的默認值。且User對象會被直接處理為json格式。