從JSP快速過渡到Thymeleaf,你要掌握的Thymeleaf語法

從JSP快速過渡到Thymeleaf,你要掌握的Thymeleaf語法

背景介紹

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

Thymeleaf的主要目標是爲您的開發工作流程帶來優雅的自然模板 - HTML。可以在直接瀏覽器中正確顯示,並且可以作爲靜態原型,從而在開發團隊中實現更強大的協作。

藉助Spring Framework的模塊,可以根據自己的喜好進行自由選擇,可插拔功能組件,Thymeleaf是現代HTML5 JVM Web開發的理想選擇 - 儘管它可以做的更多。

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。代碼幾乎沒有任何區別,就是在模板語法上有區別

快速開始

使用spring腳手架搭建環境

pom.xml:

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.7.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.junsir</groupId>
    <artifactId>testthymeleaf</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>testthymeleaf</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <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>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

Thymeleaf默認會開啓頁面緩存,提高頁面併發能力。但會導致我們修改頁面不會立即被展現,因此我們關閉緩存:

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

另外,修改完畢頁面,需要使用快捷鍵:Ctrl + Shift + F9來刷新工程。

創建Controller

@Controller
public class HelloController {

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

準備html

注意:spring boot自動幫我們配置了視圖解析器Resolver

而且,還配置了模板文件(html)的位置,與jsp類似的前綴+ 視圖名 + 後綴風格:

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

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" 會有語法提示

啓動項目,訪問:

Thymeleaf的主要作用是把model中的數據渲染到html中,因此其語法主要是如何解析model中的數據

變量

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

<h1>
    歡迎您:<span th:text="${user.name}">請登錄</span>
</h1>
    model.addAttribute("user", user);
    return "show2";

動靜結合:

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

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

  • 靜態頁面中,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']}

方法

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

舉例

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

model.addAttribute("today", new Date());

在頁面中處理

<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 + 2">1902</span>.</p>
    

拼接

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

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

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

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

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

運算

需要注意:${}內部的是通過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時,就會使用後面的默認值

    注意:?:之間沒有空格

循環

循環也是非常頻繁使用的需求,我們使用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

Thymeleaf中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代碼也不會報錯,而是採用表達式後面跟着的默認值

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章