1.Thymeleaf簡介
官方網站:www.thymeleaf.org/index.html
Thymeleaf是用來開發Web和獨立環境專案的現代伺服器端Java模板引擎。
Thymeleaf的主要目標是為您的開發工作流程帶來優雅的自然模板 - HTML。可以在直接瀏覽器中正確顯示,並且可以作為靜態原型,從而在開發團隊中實現更強大的協作。
藉助Spring Framework的模組,可以根據自己的喜好進行自由選擇,可插拔功能元件,Thymeleaf是現代HTML5 JVM Web開發的理想選擇 - 儘管它可以做的更多。
Spring官方支援的服務的渲染模板中,並不包含jsp。而是Thymeleaf和Freemarker等,而Thymeleaf與SpringMVC的檢視技術,及SpringBoot的自動化配置整合非常完美,幾乎沒有任何成本,你只用關注Thymeleaf的語法即可。
2.特點
特點:
- 動靜結合:Thymeleaf 在有網路和無網路的環境下皆可執行,即它可以讓美工在瀏覽器檢視頁面的靜態效果,也可以讓程式設計師在伺服器檢視帶資料的動態頁面效果。這是由於它支援 html 原型,然後在 html 標籤裡增加額外的屬性來達到模板+資料的展示方式。瀏覽器解釋 html 時會忽略未定義的標籤屬性,所以 thymeleaf 的模板可以靜態地執行;當有資料返回到頁面時,Thymeleaf 標籤會動態地替換掉靜態內容,使頁面動態顯示。
- 開箱即用:它提供標準和spring標準兩種方言,可以直接套用模板實現JSTL、 OGNL表示式效果,避免每天套模板、該jstl、改標籤的困擾。同時開發人員也可以擴充套件和建立自定義的方言。
- 多方言支援:Thymeleaf 提供spring標準方言和一個與 SpringMVC 完美整合的可選模組,可以快速的實現表單繫結、屬性編輯器、國際化等功能。
- 與SpringBoot完美整合,SpringBoot提供了Thymeleaf的預設配置,並且為Thymeleaf設定了檢視解析器,我們可以像以前操作jsp一樣來操作Thymeleaf。程式碼幾乎沒有任何區別,就是在模板語法上有區別。
3.環境準備
我們來建立一個module,為學習Thymeleaf做準備:
3.1.建立module
使用spring 腳手架建立:
勾選web和Thymeleaf的依賴:
專案結構:
pom:
<?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.demo</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.2.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</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.預設配置
不需要做任何配置,啟動器已經幫我們把Thymeleaf的檢視器配置完成:
而且,還配置了模板檔案(html)的位置,與jsp類似的字首+ 檢視名 + 字尾風格:
- 預設字首:
classpath:/templates/
- 預設字尾:
.html
所以如果我們返回檢視:users
,會指向到 classpath:/templates/users.html
Thymeleaf預設會開啟頁面快取,提高頁面併發能力。但會導致我們修改頁面不會立即被展現,因此我們關閉快取:
# 關閉Thymeleaf的快取
spring.thymeleaf.cache=false
複製程式碼
另外,修改完畢頁面,需要使用快捷鍵:Ctrl + Shift + F9
來重新整理工程。
3.3.快速開始
我們準備一個controller,控制檢視跳轉:
@Controller
public class HelloController {
@GetMapping("show1")
public String show1(Model model){
model.addAttribute("msg", "Hello, Thymeleaf!");
return "hello";
}
}
複製程式碼
新建一個html模板:
<!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>
複製程式碼
注意,把html 的名稱空間,改成:xmlns:th="http://www.thymeleaf.org"
會有語法提示
啟動專案,訪問頁面:
4.語法
Thymeleaf的主要作用是把model中的資料渲染到html中,因此其語法主要是如何解析model中的資料。從以下方面來學習:
- 變數
- 方法
- 條件判斷
- 迴圈
- 運算
- 邏輯運算
- 布林運算
- 比較運算
- 條件運算
- 其它
4.1.變數
變數案例
我們先新建一個實體類:User
public class User {
String name;
int age;
User friend;// 物件型別屬性
}
複製程式碼
然後在模型中新增資料
@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表示式,但是語法非常像。
示例:
我們在頁面獲取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環境下,
th
指令就會被識別和解析,而th:text
的含義就是替換所在標籤中的文字內容,於是user.name
的值就替代了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']}
4.2.自定義變數
場景
看下面的案例:
<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.
字首了
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中提供了一些內建物件,並且在這些物件中提供了一些方法,方便我們來呼叫。獲取這些物件,需要使用#物件名
來引用。
- 一些環境相關物件
物件 | 作用 |
---|---|
#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("show3")
public String show3(Model model){
model.addAttribute("today", new Date());
return "show3";
}
複製程式碼
在頁面中處理
<p>
今天是: <span th:text="${#dates.format(today,'yyyy-MM-dd')}">2018-04-25</span>
</p>
複製程式碼
效果:
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 拼接
我們經常會用到普通字串與表示式拼接的情況:
<span th:text="'歡迎您:' + ${user.name} + '!'"></span>
複製程式碼
字串字面值需要用''
,拼接起來非常麻煩,Thymeleaf對此進行了簡化,使用一對|
即可:
<span th:text="|歡迎您:${user.name}|"></span>
複製程式碼
與上面是完全等效的,這樣就省去了字串字面值的書寫。
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 迴圈
迴圈也是非常頻繁使用的需求,我們使用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值
4.8 邏輯判斷
有了if和else
,我們能實現一切功能^_^。
Thymeleaf中使用th:if
或者 th:unless
,兩者的意思恰好相反。
<span th:if="${user.age} < 24">小鮮肉</span>
複製程式碼
如果表示式的值為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中的進行預處理。而且為了在純靜態環境下可以執行,其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格式了,非常方便。控制檯: