④SpringBoot之thymeleaf使用

時間 2019-11-19

原文原文鏈接

本文介紹SpringBoot使用的模板技術thymeleaf以及經過webJar進行前端資源的引入以及使用
thymeleaf介紹
簡單說， Thymeleaf 是一個跟 Velocity、FreeMarker 相似的模板引擎，它能夠徹底替代 JSP 。相較與其餘的模板引擎，它有以下三個極吸引人的特色：
1.Thymeleaf 在有網絡和無網絡的環境下皆可運行，即它可讓美工在瀏覽器查看頁面的靜態效果，也可讓程序員在服務器查看帶數據的動態頁面效果。這是因爲它支持 html 原型，而後在 html 標籤裏增長額外的屬性來達到模板+數據的展現方式。瀏覽器解釋 html 時會忽略未定義的標籤屬性，因此 thymeleaf 的模板能夠靜態地運行；當有數據返回到頁面時，Thymeleaf 標籤會動態地替換掉靜態內容，使頁面動態顯示。
2.Thymeleaf 開箱即用的特性。它提供標準和spring標準兩種方言，能夠直接套用模板實現JSTL、 OGNL表達式效果，避免天天套模板、該jstl、改標籤的困擾。同時開發人員也能夠擴展和建立自定義的方言。
3.Thymeleaf 提供spring標準方言和一個與 SpringMVC 完美集成的可選模塊，能夠快速的實現表單綁定、屬性編輯器、國際化等功能。javascript

標準表達式語法
它們分爲四類：
1.變量表達式
2.選擇或星號表達式
3.文字國際化表達式
4.URL表達式css

變量表達式
變量表達式即OGNL表達式或Spring EL表達式(在Spring術語中也叫model attributes)。以下所示： ${session.user.name}
它們將以HTML標籤的一個屬性來表示：html

<span th:text="${book.author.name}"> 
<li th:each="book : ${books}">

選擇(星號)表達式前端

選擇表達式很像變量表達式，不過它們用一個預先選擇的對象來代替上下文變量容器(map)來執行，以下： *{customer.name}
被指定的object由th:object屬性定義：java

<div th:object="${book}"> 
  ...  
  <span th:text="*{title}">...</span>  
  ...  
</div>

文字國際化表達式jquery

文字國際化表達式容許咱們從一個外部文件獲取區域文字信息(.properties)，用Key索引Value，還能夠提供一組參數(可選).程序員

#{main.title}  
#{message.entrycreated(${entryId})}

能夠在模板文件中找到這樣的表達式代碼：web

<table>  
  ...  
  <th th:text="#{header.address.city}">...</th>  
  <th th:text="#{header.address.country}">...</th>  
  ...  
</table>

URL表達式spring

URL表達式指的是把一個有用的上下文或回話信息添加到URL，這個過程常常被叫作URL重寫。 @{/order/list}
URL還能夠設置參數： @{/order/details(id=${orderId})}
相對路徑： @{../documents/report}bootstrap

例如：

<form th:action="@{/createOrder}">  
<a href="main.html" th:href="@{/main}">

變量表達式和星號表達有什麼區別嗎？

若是不考慮上下文的狀況下，二者沒有區別；星號語法評估在選定對象上表達，而不是整個上下文。
什麼是選定對象？就是父標籤的值，以下：

<div th:object="${session.user}">
  <p>Name: <span th:text="*{firstName}">Sebastian</span>.</p>
  <p>Surname: <span th:text="*{lastName}">Pepper</span>.</p>
  <p>Nationality: <span th:text="*{nationality}">Saturn</span>.</p>
</div>

這是徹底等價於：

<div th:object="${session.user}">
    <p>Name: <span th:text="${session.user.firstName}">Sebastian</span>.</p>
    <p>Surname: <span th:text="${session.user.lastName}">Pepper</span>.</p>
    <p>Nationality: <span th:text="${session.user.nationality}">Saturn</span>.</p>
</div>

固然，美圓符號和星號語法能夠混合使用：

<div th:object="${session.user}">
    <p>Name: <span th:text="*{firstName}">Sebastian</span>.</p>
    <p>Surname: <span th:text="${session.user.lastName}">Pepper</span>.</p>
    <p>Nationality: <span th:text="*{nationality}">Saturn</span>.</p>
</div>

經常使用th標籤都有那些？

關鍵字	功能介紹	案例
th:id	替換id	<input th:id="'xxx' + ${collect.id}"/>
th:text	文本替換	<p th:text="${collect.description}">description</p>
th:utext	支持html的文本替換	<p th:utext="${htmlcontent}">content</p>
th:object	替換對象	<div th:object="${session.user}">
th:value	屬性賦值	<input th:value = "${user.name}" />
th:with	變量賦值運算	<div th:with="isEvens = ${prodStat.count}%2 == 0"></div>
th:style	設置樣式	<div th:style="'display:' + @{(${sitrue} ? 'none' : 'inline-block')} + ''"></div>
th:onclick	點擊事件	<td th:onclick = "'getCollect()'"></td>
th:each	屬性賦值	<tr th:each = "user,userStat:${users}">
th:if	判斷條件	<a th:if = "${userId == collect.userId}">
th:unless	和th:if判斷相反	<a th:href="@{/login} th:unless=${session.user != null}">Login</a>
th:href	連接地址	<a th:href="@{/login}" th:unless=${session.user != null}>Login</a>
th:switch	多路選擇配合th:case使用	<div th:switch="${user.role}">
th:fragment	th:switch的一個分支	<p th:case = "'admin'">User is an administrator</p>
th:includ	佈局標籤，替換內容到引入的文件	<head th:include="layout :: htmlhead" th:with="title='xx'"></head>
th:replace	佈局標籤，替換整個標籤到引入的文件	<div th:replace="fragments/header :: title"></div>
th:selectd	selected選擇框選中	th:selected="(${xxx.id} == ${configObj.dd})"
th:src	圖片類地址引入	<img class="img-responsive" alt="App Logo" th:src="@{/img/logo.png}" />
th:inline	定義js腳本可使用變量	<script type="text/javascript" th:inline="javascript">
th:action	表單提交的地址	<form action="subscribe.html" th:action="@{/subscribe}">
th:remove	刪除某個屬性	<tr th:remove="all"> 1.all:刪除包含標籤和全部的孩子。2.body:不包含標記刪除,但刪除其全部的孩子。3.tag:包含標記的刪除,但不刪除它的孩子。4.all-but-first:刪除全部包含標籤的孩子,除了第一個。5.none:什麼也不作。這個值是有用的動態評估。
th:attr	設置標籤屬性，多個屬性能夠用逗號分隔	好比 th:attr="src=@{/image/aa.jpg},title=#{logo}"，此標籤不太優雅，通常用的比較少。

使用示例：

pom文件引入：

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
        <dependency>
            <groupId>org.webjars.bower</groupId>
            <artifactId>jquery</artifactId>
            <version>2.0.3</version>
        </dependency> 
        <dependency>
            <groupId>org.webjars.bower</groupId>
            <artifactId>bootstrap</artifactId>
            <version>3.0.3</version>
        </dependency>

resources文件夾建static、images、tmplates文件夾

starter.css

body {
  padding-top: 50px;
}

.starter-template {
  padding: 40px 15px;
  text-align: center;
}

hello.html


<html xmlns:th="http://www.thymeleaf.org">
  <head th:include="layout :: htmlhead" th:with="title='Hello'"></head>

  <body>
    <div th:replace="layout :: navbar">(navbar)</div>

    <div class="container">
      <div class="starter-template">
        <h1>Spring MVC / Thymeleaf / Bootstrap</h1>
        <p class="lead" th:text="${greeting}">(greeting)</p>
        <p>The current time is <span th:text="${currentTime}">(time)</span></p>
      </div>
    </div>

    <div th:include="layout :: footer" id="footer">(footer)</div>

  </body>
</html>

layout.html

<html xmlns:th="http://www.thymeleaf.org">
  <head th:fragment="htmlhead">
    <meta charset="utf-8"></meta>
    <meta http-equiv="X-UA-Compatible" content="IE=edge"></meta>
    <meta name="viewport" content="width=device-width, initial-scale=1.0"></meta>
    <meta name="description" content=""></meta>
    <meta name="author" content=""></meta>
    <link rel="shortcut icon" type="image/png" th:href="@{/images/favicon.png}"></link>

       <title th:text="${title}">(title)</title>

      <link th:href="@{/webjars/bootstrap/3.0.3/dist/css/bootstrap.css}" rel="stylesheet"></link>
      <link th:href="@{/css/starter.css}" rel="stylesheet"></link>
  </head>

  <body>
    <div th:fragment="navbar" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
      <div class="container">
        <div class="navbar-header">
          <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
            <span class="sr-only">Toggle navigation</span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>
          <a class="navbar-brand" href="#">Project name</a>
        </div>
        <div class="collapse navbar-collapse">
          <ul class="nav navbar-nav">
            <li class="active"><a href="#">Home</a></li>
            <li><a href="#about">About</a></li>
            <li><a href="#contact">Contact</a></li>
          </ul>
        </div>
      </div>
    </div>

    <div class="container">
      <div class="starter-template">
        <h1>Spring MVC/Thymeleaf/Bootstrap</h1>
        <p class="lead" th:text="${greeting}">(greeting)</p>
      </div>
    </div>

    <div th:fragment="footer" id="footer">
      <div class="container">
        <p class="muted credit">Spring MVC/Thymeleaf/Bootstrap Project Template</p>
      </div>
      <script th:src="@{/webjars/jquery/2.0.3/jquery.min.js}"></script>
      <script th:src="@{/webjars/bootstrap/3.0.3/js/bootstrap.min.js}"></script>
    </div>

  </body>
</html>

ThyemleafController

import java.text.DateFormat;
import java.util.Date;
import java.util.Locale;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class ThymeleafController {
    
    @RequestMapping("/hi")
    public String hello(Locale locale, Model model) {
        model.addAttribute("greeting", "Hello!");

        Date date = new Date();
        DateFormat dateFormat = DateFormat.getDateTimeInstance(DateFormat.LONG, DateFormat.LONG, locale);        
        String formattedDate = dateFormat.format(date);
        model.addAttribute("currentTime", formattedDate);

        return "hello";
    }

}

啓動項目，瀏覽器輸入：http://127.0.0.1:8080/hi

幾種經常使用的方法：

一、賦值、字符串拼接

<p th:text="${collect.description}">description</p>
<span th:text="'Welcome to our application, ' + ${user.name} + '!'">

字符串拼接還有另一種簡潔的寫法

<span th:text="|Welcome to our application, ${user.name}!|">

二、條件判斷 If/Unless

Thymeleaf中使用th:if和th:unless屬性進行條件判斷，下面的例子中，<a>標籤只有在th:if中條件成立時才顯示：

<a th:if="${myself=='yes'}" > </i> </a>
<a th:unless=${session.user != null} th:href="@{/login}" >Login</a>

th:unless於th:if剛好相反，只有表達式中的條件不成立，纔會顯示其內容。也可使用 (if) ? (then) : (else) 這種語法來判斷顯示的內容

三、for 循環

<tr th:each="collect,iterStat : ${collects}"> 
    <th scope="row" th:text="${collect.id}">1</th>
    <td >
       <img th:src="${collect.webLogo}"/>
    </td>
    <td th:text="${collect.url}">Mark</td>
    <td th:text="${collect.title}">Otto</td>
    <td th:text="${collect.description}">@mdo</td>
    <td th:text="${terStat.index}">index</td>
</tr>

iterStat稱做狀態變量，屬性有：
index:當前迭代對象的index（從0開始計算）
count: 當前迭代對象的index(從1開始計算)
size:被迭代對象的大小
current:當前迭代變量
even/odd:布爾值，當前循環是不是偶數/奇數（從0開始計算）
first:布爾值，當前循環是不是第一個
last:布爾值，當前循環是不是最後一個

四、URL

URL在Web應用模板中佔據着十分重要的地位，須要特別注意的是Thymeleaf對於URL的處理是經過語法@{…}來處理的。

若是須要Thymeleaf對URL進行渲染，那麼務必使用th:href，th:src等屬性，下面是一個例子

<!-- Will produce 'http://localhost:8080/standard/unread' (plus rewriting) -->
 <a  th:href="@{/standard/{type}(type=${type})}">view</a> 
<!-- Will produce '/gtvg/order/3/details' (plus rewriting) -->
<a href="details.html" th:href="@{/order/{orderId}/details(orderId=${o.id})}">view</a>

設置背景

<div th:style="'background:url(' + @{/<path-to-image>} + ');'"></div>

根據屬性值改變背景

<div class="media-object resource-card-image" th:style="'background:url(' + @{(${collect.webLogo}=='' ? 'img/favicon.png' : ${collect.webLogo})} + ')'" ></div>

幾點說明：
上例中URL最後的(orderId=${o.id}) 表示將括號內的內容做爲URL參數處理，該語法避免使用字符串拼接，大大提升了可讀性
@{…}表達式中能夠經過{orderId}訪問Context中的orderId變量
@{/order}是Context相關的相對路徑，在渲染時會自動添加上當前Web應用的Context名字，假設context名字爲app，那麼結果應該是/app/order

五、內聯js

內聯文本：[[…]]內聯文本的表示方式，使用時，必須先用th:inline=」text/javascript/none」激活，th:inline能夠在父級標籤內使用，甚至做爲body的標籤。內聯文本儘管比th:text的代碼少，不利於原型顯示。

<script th:inline="javascript">
/*<![CDATA[*/

...
var username = /*[[${sesion.user.name}]]*/ 'Sebastian';
var size = /*[[${size}]]*/ 0;
...

/*]]>*/
</script>

js附加代碼：

/*[+
var msg = 'This is a working application';
+]*/

js移除代碼：

/*[- */
var msg = 'This is a non-working template';
/* -]*/

六、內嵌變量

爲了模板更加易用，Thymeleaf還提供了一系列Utility對象（內置於Context中），能夠經過#直接訪問：
dates ： java.util.Date的功能方法類。
calendars : 相似#dates，面向java.util.Calendar
numbers : 格式化數字的功能方法類
strings : 字符串對象的功能類，contains,startWiths,prepending/appending等等。
objects: 對objects的功能類操做。
bools: 對布爾值求值的功能方法。
arrays：對數組的功能類方法。
lists: 對lists功能類方法
sets
maps…

下面用一段代碼來舉例一些經常使用的方法：
dates

/*
 * Format date with the specified pattern
 * Also works with arrays, lists or sets
 */

${#dates.format(date, 'dd/MMM/yyyy HH:mm')}
${#dates.arrayFormat(datesArray, 'dd/MMM/yyyy HH:mm')}
${#dates.listFormat(datesList, 'dd/MMM/yyyy HH:mm')}
${#dates.setFormat(datesSet, 'dd/MMM/yyyy HH:mm')} 

/*
 * Create a date (java.util.Date) object for the current date and time
 */
${#dates.createNow()}
/*
 * Create a date (java.util.Date) object for the current date (time set to 00:00)
 */
${#dates.createToday()}

strings

/*
 * Check whether a String is empty (or null). Performs a trim() operation before check
 * Also works with arrays, lists or sets
 */
${#strings.isEmpty(name)}
${#strings.arrayIsEmpty(nameArr)}
${#strings.listIsEmpty(nameList)}
${#strings.setIsEmpty(nameSet)}
/*
 * Check whether a String starts or ends with a fragment
 * Also works with arrays, lists or sets
 */
${#strings.startsWith(name,'Don')}                  // also array*, list* and set*
${#strings.endsWith(name,endingFragment)}           // also array*, list* and set*
/*
 * Compute length
 * Also works with arrays, lists or sets
 */
${#strings.length(str)}
/*
 * Null-safe comparison and concatenation
 */
${#strings.equals(str)}
${#strings.equalsIgnoreCase(str)}
${#strings.concat(str)}
${#strings.concatReplaceNulls(str)}
/*
 * Random
 */
${#strings.randomAlphanumeric(count)}

使用thymeleaf佈局

使用thymeleaf佈局很是的方便

定義代碼片斷

<footer th:fragment="copy">
© 2016
</footer>

在頁面任何地方引入：

<body>
<div th:include="footer :: copy"></div>
<div th:replace="footer :: copy"></div>
</body>

th:include 和 th:replace區別，include只是加載，replace是替換

返回的HTML以下：

<body>
<div> © 2016 </div>
<footer>© 2016 </footer>
</body>

下面是一個經常使用的後臺頁面佈局，將整個頁面分爲頭部，尾部、菜單欄、隱藏欄，點擊菜單隻改變content區域的頁面

<body class="layout-fixed">
<div th:fragment="navbar" class="wrapper" role="navigation">
<div th:replace="fragments/header :: header">Header</div>
<div th:replace="fragments/left :: left">left</div>
<div th:replace="fragments/sidebar :: sidebar">sidebar</div>
<div layout:fragment="content" id="content" ></div>
<div th:replace="fragments/footer :: footer">footer</div>
</div>
</body>

任何頁面想使用這樣的佈局值只須要替換中見的 content模塊便可

<html xmlns:th="http://www.thymeleaf.org" layout:decorator="layout">
<body>
<section layout:fragment="content">
...

也能夠在引用模版的時候傳參

<head th:include="layout :: htmlhead" th:with="title='Hello'"></head>

layout 是文件地址，若是有文件夾能夠這樣寫 fileName/layout:htmlhead

htmlhead 是指定義的代碼片斷如 th:fragment=」copy」

相關標籤/搜索

springboot+mybatis+mysql+thymeleaf

springboot+shiro+mybatis+thymeleaf

springboot+thymeleaf+mybatis

springboot+mybatis+thymeleaf+vue

springboot+thymeleaf+security+vue

thymeleaf+springboot+mybatis

每日一句

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