springboot(四)：thymeleaf使用詳解

ityouknow發表於2017-07-05
Spring Boot

在上篇文章springboot(二)：web綜合開發中簡單介紹了一下thymeleaf，這篇文章將更加全面詳細的介紹thymeleaf的使用。thymeleaf 是新一代的模板引擎，在spring4.0中推薦使用thymeleaf來做前端模版引擎。

thymeleaf介紹

簡單說， Thymeleaf 是一個跟 Velocity、FreeMarker 類似的模板引擎，它可以完全替代 JSP 。相較與其他的模板引擎，它有如下三個極吸引人的特點：

  • 1.Thymeleaf 在有網路和無網路的環境下皆可執行，即它可以讓美工在瀏覽器檢視頁面的靜態效果，也可以讓程式設計師在伺服器檢視帶資料的動態頁面效果。這是由於它支援 html 原型，然後在 html 標籤裡增加額外的屬性來達到模板+資料的展示方式。瀏覽器解釋 html 時會忽略未定義的標籤屬性，所以 thymeleaf 的模板可以靜態地執行；當有資料返回到頁面時，Thymeleaf 標籤會動態地替換掉靜態內容，使頁面動態顯示。

  • 2.Thymeleaf 開箱即用的特性。它提供標準和spring標準兩種方言，可以直接套用模板實現JSTL、 OGNL表示式效果，避免每天套模板、該jstl、改標籤的困擾。同時開發人員也可以擴充套件和建立自定義的方言。

  • 3.Thymeleaf 提供spring標準方言和一個與 SpringMVC 完美整合的可選模組，可以快速的實現表單繫結、屬性編輯器、國際化等功能。

標準表示式語法

它們分為四類：

  • 1.變數表示式
  • 2.選擇或星號表示式
  • 3.文字國際化表示式
  • 4.URL表示式

變數表示式

變數表示式即OGNL表示式或Spring EL表示式(在Spring術語中也叫model attributes)。如下所示：
${session.user.name}

它們將以HTML標籤的一個屬性來表示： 

<span th:text="${book.author.name}">  
<li th:each="book : ${books}">複製程式碼

選擇(星號)表示式

選擇表示式很像變數表示式，不過它們用一個預先選擇的物件來代替上下文變數容器(map)來執行，如下：
*{customer.name}

被指定的object由th:object屬性定義：

    <div th:object="${book}">  
      ...  
      <span th:text="*{title}">...</span>  
      ...  
    </div>複製程式碼

文字國際化表示式

文字國際化表示式允許我們從一個外部檔案獲取區域文字資訊(.properties)，用Key索引Value，還可以提供一組引數(可選).

    #{main.title}  
    #{message.entrycreated(${entryId})}複製程式碼

可以在模板檔案中找到這樣的表示式程式碼：

    <table>  
      ...  
      <th th:text="#{header.address.city}">...</th>  
      <th th:text="#{header.address.country}">...</th>  
      ...  
    </table>複製程式碼

URL表示式

URL表示式指的是把一個有用的上下文或回話資訊新增到URL，這個過程經常被叫做URL重寫。
@{/order/list}
URL還可以設定引數：
@{/order/details(id=${orderId})}
相對路徑：
@{../documents/report}

讓我們看這些表示式：

    <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>複製程式碼

表示式支援的語法

字面（Literals）

  • 文字文字（Text literals）: 'one text', 'Another one!',…
  • 數字文字（Number literals）: 0, 34, 3.0, 12.3,…
  • 布林文字（Boolean literals）: true, false
  • 空（Null literal）: null
  • 文字標記（Literal tokens）: one, sometext, main,…

文字操作（Text operations）

  • 字串連線(String concatenation): +
  • 文字替換（Literal substitutions）: |The name is ${name}|

算術運算（Arithmetic operations）

  • 二元運算子（Binary operators）: +, -, *, /, %
  • 減號（單目運算子）Minus sign (unary operator): -

布林操作（Boolean operations）

  • 二元運算子（Binary operators）:and, or
  • 布林否定（一元運算子）Boolean negation (unary operator):!, not

比較和等價(Comparisons and equality)

  • 比較（Comparators）: >, <, >=, <= (gt, lt, ge, le)
  • 等值運算子（Equality operators）:==, != (eq, ne)

條件運算子（Conditional operators）

  • If-then: (if) ? (then)
  • If-then-else: (if) ? (then) : (else)
  • Default: (value) ?: (defaultvalue)

所有這些特徵可以被組合並巢狀：

'User is of type ' + (${user.isAdmin()} ? 'Administrator' : (${user.type} ?: 'Unknown'))複製程式碼

常用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}">conten</p>
th:object 替換物件 <div th:object="${session.user}">
th:value 屬性賦值 <input th:value="${user.name}" />
th:with 變數賦值運算 <div th:with="isEven=${prodStat.count}%2==0"></div>
th:style 設定樣式 th:style="'display:' + @{(${sitrue} ? 'none' : 'inline-block')} + ''"
th:onclick 點選事件 th:onclick="'getCollect()'"
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:case th:switch的一個分支 <p th:case="'admin'">User is an administrator</p>
th:fragment 佈局標籤，定義一個程式碼片段，方便其它地方引用 <div th:fragment="alert">
th:include 佈局標籤，替換內容到引入的檔案 <head th:include="layout :: htmlhead" th:with="title='xx'"></head> />
th:replace 佈局標籤，替換整個標籤到引入的檔案 <div th:replace="fragments/header :: title"></div>
th:selected 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}"，此標籤不太優雅，一般用的比較少。

還有非常多的標籤，這裡只列出最常用的幾個,由於一個標籤內可以包含多個th:x屬性，其生效的優先順序順序為:
include,each,if/unless/switch/case,with,attr/attrprepend/attrappend,value/href,src ,etc,text/utext,fragment,remove。

幾種常用的使用方法

1、賦值、字串拼接

 <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}!|">複製程式碼

2、條件判斷 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) 這種語法來判斷顯示的內容

3、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:布林值，當前迴圈是否是最後一個

4、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

5、內聯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';
/* -]*/複製程式碼

6、內嵌變數

為了模板更加易用，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"> 
&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> &copy; 2016 </div> 
  <footer>&copy; 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"

原始碼案例

這裡有一個開源專案幾乎使用了這裡介紹的所有標籤和佈局，大家可以參考：
cloudfavorites

參考

thymeleaf官方指南
新一代Java模板引擎Thymeleaf
Thymeleaf基本知識
thymeleaf總結文章
Thymeleaf 模板的使用
thymeleaf 學習筆記

喜歡我的文章，請關注我的公眾號

相關文章