當前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

Thymeleaf 语法快速入门

發(fā)布時間：2024/10/8 编程问答 23 豆豆

生活随笔收集整理的這篇文章主要介紹了 Thymeleaf 语法快速入门小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

1.簡介

官方網站：https://www.thymeleaf.org

Thymeleaf是用來開發(fā)Web和獨立環(huán)境項目的現代服務器端Java模板引擎。

Thymeleaf的主要目標是為您的開發(fā)工作流程帶來優(yōu)雅的自然模板 - HTML。可以在直接瀏覽器中正確顯示，并且可以作為靜態(tài)原型，從而在開發(fā)團隊中實現更強大的協作。

借助Spring Framework的模塊，可以根據自己的喜好進行自由選擇，可插拔功能組件，Thymeleaf是現代HTML5 JAVA Web開發(fā)的理想選擇 - 盡管它可以做的更多。

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

2.特點

2.1 動靜結合

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

2.2 開箱即用

它提供標準和spring標準兩種方言，可以直接套用模板實現JSTL、 OGNL表達式效果，避免每天套模板、改jstl、改標簽的困擾。同時開發(fā)人員也可以擴展和創(chuàng)建自定義的方言。

2.3 多方言支持

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

2.4 與SpringBoot完美整合，

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

3.開發(fā)環(huán)境

3.1引入依賴坐標

<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><groupId>com.leyou</groupId><artifactId>thymeleaf-demo</artifactId><version>0.0.1-SNAPSHOT</version><packaging>jar</packaging><name>thymeleaf-demo</name><description>Demo project for Spring Boot</description><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.0.6.RELEASE</version><relativePath/> </parent><properties><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding><java.version>1.8</java.version></properties><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><scope>test</scope></dependency></dependencies><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId></plugin></plugins></build></project>

3.2 默認配置

默認前綴：classpath:/templates/
默認后綴：.html

所以如返回視圖：users，會指向到 classpath:/templates/users.html

3.3 快速開始

@Controller public class HelloController {@GetMapping("hello")public String show1(Model model){model.addAttribute("msg", "Hello, Thymeleaf!");return "hello";} }

注意，把html 的名稱空間，改成：xmlns:th="http://www.thymeleaf.org" 會有語法提示

<!DOCTYPE html> <html lang="en" xmlns:th="http://www.thymeleaf.org"> <head><meta charset="UTF-8"><title>hello</title> </head> <body><h1 th:text="${msg}">大家好</h1> </body> </html>

4.語法

Thymeleaf 的主要作用是把Model中的數據渲染到HTML，語法主要是如何解析Model中的數據。
變量
方法
條件判斷
循環(huán)
運算：邏輯、布爾、比較、條件運算

4.1變量

在模型中添加數據

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

在頁面獲取數據

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

動靜結合

Thymeleaf崇尚自然模板，意思就是模板是純正的html代碼，脫離模板引擎，在純靜態(tài)環(huán)境也可以直接運行。現在如果我們直接在html中編寫 ${}這樣的表達式，顯然在靜態(tài)環(huán)境下就會出錯，這不符合Thymeleaf的理念。
Thymeleaf中所有的表達式都需要寫在指令中，指令是HTML5中的自定義屬性，在Thymeleaf中所有指令都是以th:開頭。因為表達式${user.name}是寫在自定義屬性中，因此在靜態(tài)環(huán)境下，表達式的內容會被當做是普通字符串，瀏覽器會自動忽略這些指令，這樣就不會報錯了！
靜態(tài)頁面中，th指令不被識別，但是瀏覽器也不會報錯，把它當做一個普通屬性處理。這樣span的默認值請登錄就會展現在頁面
如果是在Thymeleaf環(huán)境下，th指令就會被識別和解析，而th:text的含義就是替換所在標簽中的文本內容，于是user.name的值就替代了 span中默認的請登錄
指令的設計，正是Thymeleaf的高明之處，也是它優(yōu)于其它模板引擎的原因。動靜結合的設計，使得無論是前端開發(fā)人員還是后端開發(fā)人員可以完美契合。

向下兼容

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

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

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

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

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

ognl表達式的語法糖

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

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

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

4.2 自定義變量

看下面的案例：

<div><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> </div>

當數據量比較多的時候，頻繁的寫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.前綴了

4.3.方法

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中提供了一些內置對象，并且在這些對象中提供了一些方法，方便我們來調用。獲取這些對象，需要使用#對象名來引用。

一些環(huán)境相關對象

對象作用

#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集合的方法

舉例

我們在環(huán)境變量中添加日期類型對象

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

在頁面中處理

4.4 字面值

有的時候，我們需要在指令中填寫基本類型如：字符串、數值、布爾等，并不希望被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類似

4.5 拼接

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

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

與上面是完全等效的，這樣就省去了字符串字面值的書寫。

4.6 運算

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

算術運算

支持的算術運算符：+ - * / %
<span th:text="${user.age}"></span> <span th:text="${user.age}%2 == 0"></span>
- 比較運算
支持的比較運算：>, <, >= and <= ，但是>, <不能直接使用，因為xml會解析為標簽，要使用別名。

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

可以使用的別名：gt (>), lt (<), ge (>=), le (<=), not (!). Also eq (==), neq/ne (!=).
條件運算
- 三元運算
<span th:text="${user.sex} ? '男':'女'"></span>
三元運算符的三個部分：conditon ? then : else

condition：條件

then：條件成立的結果

else：不成立的結果

其中的每一個部分都可以是Thymeleaf中的任意表達式。
- 默認值
  
  有的時候，我們取一個值可能為空，這個時候需要做非空判斷，可以使用表達式 ?: 默認值簡寫：
<span th:text="${user.name} ?: '二狗'"></span>
當前面的表達式值為null時，就會使用后面的默認值。

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

4.7 循環(huán)

循環(huán)也是非常頻繁使用的需求，我們使用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，數組及其它一切符合數組結果的對象

在迭代的同時，我們也可以獲取迭代的狀態(tài)對象：

<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值

4.8 邏輯判斷

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

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

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

以下情況被認定為true：

表達式值為true
表達式值為非0數值
表達式值為非0字符
表達式值為字符串，但不是"false","no","off"
表達式不是布爾、字符串、數字、字符中的任何一種

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

4.9 分支控制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="*"表示默認，放最后。

4.10.JS模板

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

在script標簽中通過th:inline="javascript"來聲明這是要特殊處理的js腳本
語法結構：
const user = /*[[Thymeleaf表達式]]*/ "靜態(tài)環(huán)境下的默認值";
因為Thymeleaf被注釋起來，因此即便是靜態(tài)環(huán)境下， js代碼也不會報錯，而是采用表達式后面跟著的默認值。

看看頁面的源碼：

看看控制臺：

總結

以上是生活随笔為你收集整理的Thymeleaf 语法快速入门的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。

上一篇：【Java开发】生成二维码
下一篇： Bootstrap的坑--千万别踩