Thymeleaf基本用法

時間 2019-11-21

標籤 thymeleaf 基本用法简体版

原文原文鏈接

1.Thymeleaf簡介

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

Thymeleaf是用來開發Web和獨立環境項目的現代服務器端Java模板引擎。html

2.特色

特色：前端

動靜結合：Thymeleaf 在有網絡和無網絡的環境下皆可運行，即它可讓美工在瀏覽器查看頁面的靜態效果，也可讓程序員在服務器查看帶數據的動態頁面效果。這是因爲它支持 html 原型，而後在 html 標籤裏增長額外的屬性來達到模板+數據的展現方式。瀏覽器解釋 html 時會忽略未定義的標籤屬性，因此 thymeleaf 的模板能夠靜態地運行；當有數據返回到頁面時，Thymeleaf 標籤會動態地替換掉靜態內容，使頁面動態顯示。
開箱即用：它提供標準和spring標準兩種方言，能夠直接套用模板實現JSTL、 OGNL表達式效果，避免天天套模板、該jstl、改標籤的困擾。同時開發人員也能夠擴展和建立自定義的方言。
多方言支持：Thymeleaf 提供spring標準方言和一個與 SpringMVC 完美集成的可選模塊，能夠快速的實現表單綁定、屬性編輯器、國際化等功能。
與SpringBoot完美整合，SpringBoot提供了Thymeleaf的默認配置，而且爲Thymeleaf設置了視圖解析器，咱們能夠像之前操做jsp同樣來操做Thymeleaf。代碼幾乎沒有任何區別，就是在模板語法上有區別。

3.環境準備

3.1.建立module

pom：vue

<?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.fly.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>

</project>

3.2.默認配置

不須要作任何配置，啓動器已經幫咱們把Thymeleaf的視圖器配置完成：java

並且，還配置了模板文件（html）的位置，與jsp相似的前綴+ 視圖名 + 後綴風格：程序員

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

因此若是咱們返回視圖：users，會指向到 classpath:/templates/users.htmlweb

Thymeleaf默認會開啓頁面緩存，提升頁面併發能力。但會致使咱們修改頁面不會當即被展示，所以咱們關閉緩存：spring

# 關閉Thymeleaf的緩存
spring.thymeleaf.cache=false

另外，修改完畢頁面，須要使用快捷鍵：Ctrl + Shift + F9來刷新工程。apache

3.3.快速開始

咱們準備一個controller，控制視圖跳轉：json

@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的注入。

例如，你好將會被格式化輸出爲$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解析爲變量，這個時候稱爲字面值。

字符串字面值

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

 你正在觀看 template 的字符串常量值.

```
th:text中的thymeleaf並不會被認爲是變量，而是一個字符串
數字字面值

數字不須要任何特殊語法，寫的什麼就是什麼，並且能夠直接進行算術運算
```
今年是 1900.
兩年後將會是 1902.
```
布爾字面值

布爾類型的字面值是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 (!=).
條件運算
- 三元運算
```

```
三元運算符的三個部分：conditon ? then : else

condition：條件

then：條件成立的結果

else：不成立的結果

其中的每個部分均可以是Thymeleaf中的任意表達式。
- 默認值
 
 有的時候，咱們取一個值可能爲空，這個時候須要作非空判斷，可使用 表達式 ?: 默認值簡寫：
```

```
當前面的表達式值爲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格式了，很是方便。

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。