從.Net到Java學習第九篇——SpringBoot下Thymeleaf

weixin_34321977發表於2018-06-25

Thymeleaf概述

　　Thymeleaf 是一個流行的模板引擎，該模板引擎採用java語言開發。模板引擎是一個技術名稱，是跨領域平臺的概念，在java語言體系下有模板引擎，在C#、PHP語言體系下也有模板引擎，甚至在JavaScript中也會用到模板引擎技術。
Java生態下的模板引擎有Thymeleaf 、Freemaker、Velocity、Beetl（國產）等。Thymeleaf模板既能用於web環境下，也能用於非web環境下，在非web環境下，它能直接顯示模板上的靜態資料，在web環境下，它能像JSP一樣從後臺接收資料並替換掉模板上的靜態資料。.net下面的razor也是一個模板引擎。

Thymeleaf它是基於HTML的，以HTML標籤為載體，Thymeleaf要寄託在HTML的標籤下實現對資料的展示。
Thymeleaf的官方網站：http://www.thymeleaf.org
Spring boot整合了Thymeleaf模板技術，並且Spring boot官方也推薦使用
Thymeleaf來替代JSP技術。
Thymeleaf是另外的一種模板技術，它本身並不屬於spring boot，
srpingboot只是很好的整合了這種模板技術，作為前端頁面的資料展示。

Spring Boot整合Thymeleaf配置

（1）修改pom.xml，在Maven中引入Thymeleaf的依賴：

        <!--thymeleaf-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>

（2）在Spring boot的核心配置檔案application.yml中對Thymeleaf進行配置：

spring:
  profiles:
    active: test
  thymeleaf:
    cache: false #開發階段，建議關閉Thymeleaf的快取
    mode: LEGACYHTML5 #使用遺留的html5以去掉對html標籤的校驗

在使用Spring boot的過程中，如果使用thymeleaf作為模板檔案，則要求HTML格式必須為嚴格的html5格式，所有標籤必須有結束標籤，否則會報錯。如果不想對標籤進行嚴格的驗證，使用spring.thymeleaf.model=LEGACYHTML5去掉驗證，去掉該驗證還需要引入許下的依賴，否則會報錯。

        <dependency>
            <groupId>net.sourceforge.nekohtml</groupId>
            <artifactId>nekohtml</artifactId>
            <version>1.9.22</version>
        </dependency>

（3）新建一個控制器ThymeleafController去對映到模板頁

@Controller
public class ThymeleafController {
    @GetMapping("/index")
    public String index(Model model){
        model.addAttribute("msg","Spring boot整合Thymeleaf");
        return "index"; //返回的是一個頁面，可以省略字尾.html
    }
}

（4）在src/main/resources的templates下面新建一個index.html頁面用於資料展示，HTML頁面的<html>元素中藥記得加入以下屬性：

<html xmlns:th="http://www.thymeleaf.org">

index.html原始碼如下：

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org"><!--引入thymeleaf-->
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<p th:text="${msg}">你好</p>
</body>
</html>

Springboot使用thymeleaf作為檢視展示，約定將模板檔案放置在src/main/resources/templates目錄下，靜態資源放置在src/main/resources/static目錄下

執行IDEA專案

如果不啟動spring boot直接在瀏覽器中瀏覽這個頁面

Thymeleaf標準變數表示式

語法：${...}

變數表示式用於訪問容器（tomcat）上下文環境中的變數，功能和JSTL中的${}相同。Thymeleaf中的變數表示式使用${變數名}的方式獲取其中的資料。

新建實體類User：

package com.yujie.entity;

public class User {
    private String name;
    private String sex;
    private Integer age;
    private String email;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getSex() {
        return sex;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }
}

在Spring mvc的Controller中使用向前端傳輸資料，ThymeleafController程式碼如下：

    @GetMapping("/user")
    public String user(Model model){
        User user=new User();
        user.setAge(21);
        user.setEmail("zouyujie@126.com");
        user.setName("玉傑");
        model.addAttribute("user",user);
        return "user";
    }

templates目錄下面，新建一個user.html頁面，前端接收程式碼：

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org"><!--引入thymeleaf-->
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<p>使用者資訊如下：</p>
<div th:text="${user.name}"></div>
<div th:text="${user.age}"></div>
<div th:text="${user.email}"></div>
</body>
</html>

瀏覽

選擇變數表示式

選擇變數表示式，也叫星號變數表示式，使用th:object屬性來繫結物件，比如：

<p>分割線——選擇變數表示式</p>
<div th:object="${user}">
    <div th:text="*{name}"></div>
    <div th:text="*{age}"></div>
    <div th:text="*{email}"></div>
</div>

繼續

選擇變數表示式首先使用th:object來繫結後臺傳來的user物件，然後使用*來代表這個物件，後面{}中的值是此物件中的屬性。
選擇變數表示式*{...}是另一種類似於變數表示式${...}表示變數的方法。
選擇變數表示式在執行時是在選擇的物件上求解，而${...}是在上下文的變數Model上求解。
通過th:object屬性指明選擇變數表示式的求解物件。
標準變數表示式和選擇變數表示式可以混合在一起使用，比如：

<div th:object="${user}">
    <div th:text="*{name}"></div>
    <div th:text="*{age}"></div>
    <div th:text="${user.email}"></div>
</div>

也可以不使用th:object進行物件的選擇，而直接使用*{...}獲取資料，比如：

<p>不使用th:object</p>
<div>
    <div th:text="*{user.name}"></div>
    <div th:text="*{user.age}"></div>
    <div th:text="*{user.email}"></div>
</div>

Thymeleaf的URL表示式

語法：@{...}

URL表示式可用於<script src="...">、<link href="...">、<a href="...">等
1.絕對URL，比如：

<a href="index.html" th:href="@{'http://localhost:8080/user?name='+${user.name}}">index</a>

2.相對URL，相對於頁面，比如：

<a href="index.html" th:href="@{'user?name='+${user.name}}">index</a>

3.相對URL，相對於專案上下文，比如：

<a href="index.html" th:href="@{'/user?name='+${user.name}}">index</a>

專案的上下文名會自動新增，我們可以看下html執行的原始碼。

thymeleaf的常用屬性

thymeleaf的常用屬性：
th:action
th:each
th:href
th:id
th:if
th:unless
th:switch/th:case
th:object
th:src
th:text
th:value
th:attr
th:onclick
th:style
th:method
th:name
th:inline
這些標記大多數和html的標記名稱是一樣的。

thymeleaf表示式基本物件

模板引擎提供了一組內建的物件，這些內建的物件可以直接在模板中使用，這些物件由#號開始引用。

#request

相當於HttpServletRequest物件，這是3.x版本，若是2.x版本使用#httpServletRequest
${#request.getContextPath()}
${#request.getAttribute("name")}

#session

相當於HttpSession
物件，這是3.x版本，若是2.x版本使用#httpSession，需要在後頭controller中設定session，
${#session.getAttribute("phone")}
${#session.id}

thymeleaf表示式功能物件

1.模板引擎提供的一組功能性內建物件，可以在模板中直接使用這些物件提供的功能方法。
2.工作中常使用的資料型別，如集合、時間、數值，可以使用thymeleaf提供的功能性物件來處理它們。
3.內建功能物件前都需要加#號，內建物件一般都以s結尾。

#dates：java.util.Date物件的實用方法，<span th:text="${#dates.format(curDate,'yyyy-MM-dd HH:mm:ss')}"></span>
#calendars：和dates類似，但是是java.util.Calendar物件。
#numbers：格式化資料物件的實用方法。
#strings：字串物件的實用方法。contains,startsWith,prepending/appending等。
#objects：對objects操作的實用方法。
#bools：對布林值求值的實用方法。
#arrays：陣列的實用方法。
#lists：list的實用方法.
#sets：set的實用方法.
#maps：map的實用方法
#aggregates：對陣列或集合建立聚合的實用方法。

還有條件表示式等等，更多內容可以參考thymeleaf的官網：http://www.thymeleaf.org

thymeleaf th:text 不顯示標籤

解決辦法，通過追加th:remove屬性，演示如下：

<span th:text="${title}" th:remove="tag"></span>

thymeleaf佈局

thymeleaf既然和razor一樣，那麼肯定也有佈局頁，也就是母版頁。thymeleaf的layout常用的有兩種方式用法：

第一種 th:include||th:replace||th:insert

將頁面裡的每個部分都分成塊 -> fragment 使用 th:include 和 th:replace 來引入頁面
這種用法沒有layout的概念, 因為每個部分都是 fragment

th:insert 3.0+版本新加的
th:replace 2.0+ 3.0+都可用
th:include 這個在3.0版本已經不建議使用

它們的區別，

<footer th:fragment="copy"> 
  © 2011 The Good Thymes Virtual Grocery
</footer>

呼叫方式：

<!-- 引用html段 --> 
<body> 
<div th:insert="footer :: copy"></div> 
<div th:replace="footer :: copy"></div> 
<div th:include="footer :: copy"></div>
</body>

最終結果如下：

<!-- 最終結果 --> 
<body> 
<!-- th:insert，div tag內部插入html段 --> 
<div> <footer> © 2011 The Good Thymes Virtual Grocery </footer> </div> 
<!-- th:replace，使用html段直接替換 div tag --> 
<footer> © 2011 The Good Thymes Virtual Grocery </footer>
 <!-- th:include，div tag內部插入html段（僅保留段子元素的內容） --> 
<!-- 仔細對比 th:insert 與 th:include的結果 --> 
<div> © 2011 The Good Thymes Virtual Grocery </div> 
</body>

第二種佈局頁

寫一個layout.html頁面,當作頁面的基礎頁面

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8"/>
    <title>Title</title>
</head>
<body>
<header>這是頭部</header>
<div layout:fragment="content"></div>
<footer>這是底部</footer>
</body>
</html>

新建一個子頁面layoutTest.html，在子頁面裡使用 layout:decorator 來將子頁面裡的內容加入到 layout.html裡去

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org" layout:decorator="common/layout">
<head>
    <meta charset="UTF-8"/>
    <title>Title</title>
</head>
<body>
<div layout:fragment="content">
    <h2>我是文字內容</h2>
</div>
</body>
</html>

控制器中新增一個測試方法

    @RequestMapping("/layout")
    public String layout(Model model) {
        return "layoutTest";
    }

執行結果如下：

這樣在layout.html裡引入的css,js,imgs都可以在子頁面裡用了,而且在子頁面裡還可以引入子頁面需要用到的css,js,imgs, 就很方便了，所以這也是推薦的方式。
模板傳值,假如要往header.html裡傳入一個tab來區別應該高亮哪個選單,可以使用下面的寫法實現, 建立header.html，然後在佈局頁layout.html定一個css樣式。

header.html程式碼如下：

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8"/>
    <title>Title</title>
</head>
<body>
<header th:fragment="header (tab)">
    <ul>
        <li>
            <span th:class="${tab eq 'news'} ? active">news</span>
        </li>
        <li>
            <span th:class="${tab eq 'blog'} ? active">blog</span>
        </li>
        <li>
            <span th:class="${tab eq 'post'} ? active">post</span>
        </li>
    </ul>
</header>
</body>
</html>

修改layout.html

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8"/>
    <title>Title</title>
    <style type="text/css">
        .active {background-color: green;}
    </style>
</head>
<body>
<div th:include="common/header :: header(tab='blog')"></div>
<div layout:fragment="content"></div>
<footer>這是底部</footer>
</body>
</html>