SpringBoot thymeleaf模板

學習參考資料:https://www.cnblogs.com/itdragon/archive/2018/04/13/8724291.html

一、th屬性

常用th屬性解讀

html有的屬性,Thymeleaf基本都有,而常用的屬性大概有七八個。其中th屬性執行的優先級從1~8,數字越低優先級越高。

1、th:text :設置當前元素的文本內容,相同功能的還有th:utext,兩者的區別在于前者不會轉義html標簽,后者會。優先級不高:order=7

2、th:value:設置當前元素的value值,類似修改指定屬性的還有th:src,th:href。優先級不高:order=6

3、th:each:遍歷循環元素,和th:text或th:value一起使用。注意該屬性修飾的標簽位置,詳細往后看。優先級很高:order=2

4、th:if:條件判斷,類似的還有th:unless,th:switch,th:case。優先級較高:order=3

5、th:insert:代碼塊引入,類似的還有th:replace,th:include,三者的區別較大,若使用不恰當會破壞html結構,常用于公共代碼塊提取的場景。優先級最高:order=1

6、th:fragment:定義代碼塊,方便被th:insert引用。優先級最低:order=8

7、th:object:聲明變量,一般和*{}一起配合使用,達到偷懶的效果。優先級一般:order=4

8、th:attr:修改任意屬性,實際開發中用的較少,因為有豐富的其他th屬性幫忙,類似的還有th:attrappend,th:attrprepend。優先級一般:order=5

常用th屬性使用

使用Thymeleaf屬性需要注意點以下五點:

1、若要使用Thymeleaf語法,首先要聲明名稱空間: xmlns:th="http://www.thymeleaf.org"

2、設置文本內容 th:text,設置input的值 th:value,循環輸出 th:each,條件判斷 th:if,插入代碼塊 th:insert,定義代碼塊 th:fragment,聲明變量 th:object

3、th:each 的用法需要格外注意,打個比方:如果你要循環一個div中的p標簽,則th:each屬性必須放在p標簽上。若你將th:each屬性放在div上,則循環的是將整個div。

4、變量表達式中提供了很多的內置方法,該內置方法是用#開頭,請不要與#{}消息表達式弄混。

5、th:insert,th:replace,th:include 三種插入代碼塊的效果相似,但區別很大。
示例:
1)后臺給負責給變量賦值,和跳轉頁面。

    @RequestMapping("thymeleaf")
    public String thymeleaf(ModelMap map) {
        map.put("thText", "th:text 設置文本內容 <b>加粗</b>");
        map.put("thUText", "th:utext 設置文本內容 <b>加粗</b>");
        map.put("thValue", "thValue 設置當前元素的value值");
        map.put("thEach", Arrays.asList("th:each", "遍歷列表"));
        map.put("thIf", "msg is not null");
        map.put("thObject", new ThObject(1L, "th:object", "用來偷懶的th屬性"));
        return "thymeleafStu";
    }

2)前臺thymeleaf展示

<!DOCTYPE html>
<!--名稱空間-->
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Thymeleaf 語法</title>
</head>
<body>
    <h2>Study Thymeleaf 語法</h2>
    <!--th:text 設置當前元素的文本內容,常用,優先級不高-->
    <p th:text="${thText}"></p> <!--輸出值為純字符串-->
    <p th:utext="${thUText}"></p> <!--輸出值會讓特殊字符轉義-->

    <!--th:value 設置當前元素的value值,常用,優先級僅比th:text高-->
    <input type="text" th:value="${thValue}"/>

    <!--th:each 遍歷列表,常用,優先級很高,僅此于代碼塊的插入-->
    <!--th:each 修飾在div上,則div層重復出現,若只想p標簽遍歷,則修飾在p標簽上-->
    <div th:each="message:${thEach}"><!-- 遍歷整個div-p,不推薦-->
        <p th:text="${message}"></p>
    </div>
    <div><!--只遍歷p,推薦使用-->
        <p th:each="message:${thEach}" th:text="${message}"></p>
    </div>

    <!--th:if 條件判斷,類似的有th:switch,th:case,優先級僅次于th:each, 其中#strings是變量表達式的內置方法-->
    <p th:if="${not #strings.isEmpty(thIf)}" th:text="${thIf}"></p>

    <!--th:object 聲明變量,和*{} 一起使用-->
    <div th:object="${thObject}">
        <p>ID:<span th:text="*{id}"></span></p>
        <p>NAME: <span th:text="*{name}"></span></p>
        <p>BODY: <span th:text="*{body}"></span></p>
        <hr><!--分界線上下兩種展示方式都可以-->
        <p>ID:<span th:text="${thObject.id}"></span></p>
        <p>NAME: <span th:text="${thObject.name}"></span></p>
        <p>BODY: <span th:text="${thObject.body}"></span></p>
    </div>

</body>
</html>

二、標準表達式語法

${...} 變量表達式,Variable Expressions

@{...}鏈接表達式,Link URL Expressions

#{...}消息表達式,Message Expressions

~{...}代碼塊表達式,Fragment Expressions

*{...} 選擇變量表達式,Selection Variable Expressions
變量表達式使用頻率最高,其功能也是非常的豐富。所以我們先從簡單的代碼塊表達式開始,然后是消息表達式,再是鏈接表達式,最后是變量表達式,隨帶介紹選擇變量表達式。

1、~{...}代碼塊表達式

支持兩種語法結構
推薦:~{templatename::fragmentname}
支持:~{templatename::#id}
templatename:模版名,Thymeleaf會根據模版名解析完整路徑:/resources/templates/templatename.html,要注意文件的路徑。
fragmentname:片段名,Thymeleaf通過th:fragment聲明定義代碼塊,即:th:fragment="fragmentname"
id:HTML的id選擇器,使用時要在前面加上#號,不支持class選擇器。
代碼塊表達式的使用
代碼塊表達式需要配合th屬性(th:insert,th:replace,th:include)一起使用。
th:insert:將代碼塊片段整個插入到使用了th:insert的HTML標簽中,
th:replace:將代碼塊片段整個替換使用了th:replace的HTML標簽中,
th:include:將代碼塊片段包含的內容插入到使用了th:include的HTML標簽中

<!--th:fragment定義代碼塊標識-->
<footer th:fragment="copy">
&copy; 2011 The Good Thymes Virtual Grocery
</footer>

<!--三種不同的引入方式-->
<div th:insert="footer :: copy"></div>
<div th:replace="footer :: copy"></div>
<div th:include="footer :: copy"></div>

<!--th:insert是在div中插入代碼塊,即多了一層div-->
<div>
    <footer>
    &copy; 2011 The Good Thymes Virtual Grocery
    </footer>
</div>
<!--th:replace是將代碼塊代替當前div,其html結構和之前一致-->
<footer>
&copy; 2011 The Good Thymes Virtual Grocery
</footer>
<!--th:include是將代碼塊footer的內容插入到div中,即少了一層footer-->
<div>
&copy; 2011 The Good Thymes Virtual Grocery
</div>

補充:導入模板時,可以省略~{...},并且可以附加屬性值

<li class="nav-item" >
    <!--class選擇器值,當activeUri為xxx時,值為多少-->
    <a class="nav-link active" th:class="${activeUri=='main.html'?'nav-link active':'nav-link'}"
       href="#" th:href="@{/main.html}">
        <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-home">
            <path d="M3 9l9-7 9 7v11a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2z"></path>
            <polyline points="9 22 9 12 15 12 15 22"></polyline>
        </svg>
        Dashboard <span class="sr-only">(current)</span>
    </a>
</li>
<!--*****************************導入模板格式****************************-->
<div th:replace="~{common/bar::#commonSidebar(activeUri='empManage')}"></div>

<div th:replace="common/bar::#commonSidebar(activeUri='main.html')"></div>

寫法:{common/bar::#commonSidebar(activeUri='empManage')}"

2、#{...} 消息表達式

消息表達式一般用于國際化的場景。結構:th:text="#{msg}"。

3、@{...} 鏈接表達式

1)鏈接表達式好處
不管是靜態資源的引用,form表單的請求,凡是鏈接都可以用@{...},這樣可以動態獲取項目路徑,即便項目名變了,依然可以正常訪問
2)鏈接表達式結構
無參:@{/xxx}
有參:@{/xxx(k1=v1,k2=v2)} 對應url結構:xxx?k1=v1&k2=v2
引入本地資源:@{/項目本地的資源路徑}
引入外部資源:@{/webjars/資源在jar包中的路徑}
舉例:

<link th:href="@{/webjars/bootstrap/4.0.0/css/bootstrap.css}" rel="stylesheet">
<link th:href="@{/main/css/itdragon.css}" rel="stylesheet">
<form class="form-login" th:action="@{/user/login}" th:method="post" >
<a class="btn btn-sm" th:href="@{/login.html(l='zh_CN')}">中文</a>
<a class="btn btn-sm" th:href="@{/login.html(l='en_US')}">English</a>

4、${...}變量表達式

變量表達式有豐富的內置方法,使其更強大,更方便。

1)變量表達式功能

  • 可以獲取對象的屬性和方法
  • 可以使用ctx,vars,locale,request,response,session,servletContext內置對象
  • 可以使用dates,numbers,strings,objects,arrays,lists,sets,maps等內置方法(重點介紹)

2)常用的內置對象

  • ctx :上下文對象。

  • vars :上下文變量。

  • locale:上下文的語言環境。

  • request:(僅在web上下文)的 HttpServletRequest 對象。

  • response:(僅在web上下文)的 HttpServletResponse 對象。

  • session:(僅在web上下文)的 HttpSession 對象。

  • servletContext:(僅在web上下文)的 ServletContext 對象

這里以常用的Session舉例,用戶刊登成功后,會把用戶信息放在Session中,Thymeleaf通過內置對象將值從session中獲取。

// java 代碼將用戶名放在session中
session.setAttribute("userinfo",username);
// Thymeleaf通過內置對象直接獲取
th:text="${session.userinfo}"

3)常用的內置方法

  • strings:字符串格式化方法,常用的Java方法它都有。比如:equals,equalsIgnoreCase,length,trim,toUpperCase,toLowerCase,indexOf,substring,replace,startsWith,endsWith,contains,containsIgnoreCase等

  • numbers:數值格式化方法,常用的方法有:formatDecimal等

  • bools:布爾方法,常用的方法有:isTrue,isFalse等

  • arrays:數組方法,常用的方法有:toArray,length,isEmpty,contains,containsAll等

  • lists,sets:集合方法,常用的方法有:toList,size,isEmpty,contains,containsAll,sort等

  • maps:對象方法,常用的方法有:size,isEmpty,containsKey,containsValue等

  • dates:日期方法,常用的方法有:format,year,month,hour,createNow等
    示例:
    1)后臺給負責給變量賦值,和跳轉頁面。

  @RequestMapping("/varexpressions")
    public String varexpressions(ModelMap map) {
        map.put("itdragonStr", "itdragonBlog");
        map.put("itdragonBool", true);
        map.put("itdragonArray", new Integer[]{1,2,3,4});
        map.put("itdragonList", Arrays.asList(1,3,2,4,0));
        Map itdragonMap = new HashMap();
        itdragonMap.put("thName", "${#...}");
        itdragonMap.put("desc", "變量表達式內置方法");
        map.put("itdragonMap", itdragonMap);
        map.put("itdragonDate", new Date());
        map.put("itdragonNum", 888.888D);
        return "varexpressions";
    }

2)前臺thymeleaf展示

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>ITDragon Thymeleaf 內置方法</title>
</head>
<body>
<h2>ITDragon Thymeleaf 內置方法</h2>
<h3>#strings </h3>
<div th:if="${not #strings.isEmpty(itdragonStr)}" >
    <p>Old Str : <span th:text="${itdragonStr}"/></p>
    <p>toUpperCase : <span th:text="${#strings.toUpperCase(itdragonStr)}"/></p>
    <p>toLowerCase : <span th:text="${#strings.toLowerCase(itdragonStr)}"/></p>
    <p>equals : <span th:text="${#strings.equals(itdragonStr, 'itdragonblog')}"/></p>
    <p>equalsIgnoreCase : <span th:text="${#strings.equalsIgnoreCase(itdragonStr, 'itdragonblog')}"/></p>
    <p>indexOf : <span th:text="${#strings.indexOf(itdragonStr, 'r')}"/></p>
    <p>substring : <span th:text="${#strings.substring(itdragonStr, 2, 8)}"/></p>
    <p>replace : <span th:text="${#strings.replace(itdragonStr, 'it', 'IT')}"/></p>
    <p>startsWith : <span th:text="${#strings.startsWith(itdragonStr, 'it')}"/></p>
    <p>contains : <span th:text="${#strings.contains(itdragonStr, 'IT')}"/></p>
</div>

<h3>#numbers </h3>
<div>
    <p>formatDecimal 整數部分隨意,小數點后保留兩位,四舍五入: <span th:text="${#numbers.formatDecimal(itdragonNum, 0, 2)}"/></p>
    <p>formatDecimal 整數部分保留五位數,小數點后保留兩位,四舍五入: <span th:text="${#numbers.formatDecimal(itdragonNum, 5, 2)}"/></p>
</div>

<h3>#bools </h3>
<div th:if="${#bools.isTrue(itdragonBool)}">
    <p th:text="${itdragonBool}"></p>
</div>

<h3>#arrays </h3>
<div th:if="${not #arrays.isEmpty(itdragonArray)}">
    <p>length : <span th:text="${#arrays.length(itdragonArray)}"/></p>
    <p>contains : <span th:text="${#arrays.contains(itdragonArray, 5)}"/></p>
    <p>containsAll : <span th:text="${#arrays.containsAll(itdragonArray, itdragonArray)}"/></p>
</div>
<h3>#lists </h3>
<div th:if="${not #lists.isEmpty(itdragonList)}">
    <p>size : <span th:text="${#lists.size(itdragonList)}"/></p>
    <p>contains : <span th:text="${#lists.contains(itdragonList, 0)}"/></p>
    <p>sort : <span th:text="${#lists.sort(itdragonList)}"/></p>
</div>
<h3>#maps </h3>
<div th:if="${not #maps.isEmpty(itdragonMap)}">
    <p>size : <span th:text="${#maps.size(itdragonMap)}"/></p>
    <p>containsKey : <span th:text="${#maps.containsKey(itdragonMap, 'thName')}"/></p>
    <p>containsValue : <span th:text="${#maps.containsValue(itdragonMap, '#maps')}"/></p>
</div>
<h3>#dates </h3>
<div>
    <p>format : <span th:text="${#dates.format(itdragonDate)}"/></p>
    <p>custom format : <span th:text="${#dates.format(itdragonDate, 'yyyy-MM-dd HH:mm:ss')}"/></p>
    <p>day : <span th:text="${#dates.day(itdragonDate)}"/></p>
    <p>month : <span th:text="${#dates.month(itdragonDate)}"/></p>
    <p>monthName : <span th:text="${#dates.monthName(itdragonDate)}"/></p>
    <p>year : <span th:text="${#dates.year(itdragonDate)}"/></p>
    <p>dayOfWeekName : <span th:text="${#dates.dayOfWeekName(itdragonDate)}"/></p>
    <p>hour : <span th:text="${#dates.hour(itdragonDate)}"/></p>
    <p>minute : <span th:text="${#dates.minute(itdragonDate)}"/></p>
    <p>second : <span th:text="${#dates.second(itdragonDate)}"/></p>
    <p>createNow : <span th:text="${#dates.createNow()}"/></p>
</div>
</body>
</html>

三、Thymeleaf在SpringBoot應用

Thymeleaf是Spring Boot 官方推薦使用的模版引擎,這也意味著用Thymeleaf比其他模版引擎更簡單。

開發步驟:
第一步:引入Thymeleaf依賴。
第二步: 提取公共頁面,提高代碼的重用性,統一頁面風格。
第三步:頁面顯示和國際化功能

一、引入Thymeleaf

pom.xml 引入Thymeleaf的依賴,并確定其版本

<properties>
  <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  <java.version>1.8</java.version>
  <thymeleaf.version>3.0.9.RELEASE</thymeleaf.version>
  <thymeleaf-layout-dialect.version>2.2.2</thymeleaf-layout-dialect.version>
</properties>
<dependencies>
  <dependency> <!--引入模版引擎thymeleaf-->
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
  </dependency>
</dependencies>

二、提取公共頁面

為了統一頁面風格,提高頁面的復用率,我們一般都會提取公共頁面。之前在文章中介紹了SiteMesh的使用,今天用Thymeleaf來實現。

統一規范引入的資源文件

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
    <head th:fragment="common-head">
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
        <meta name="viewport" content="initial-scale=1.0, width=device-width, user-scalable=no" />
        <title>myspringboot系統</title>
        <link type="image/x-icon" href="images/favicon.ico" rel="shortcut icon">
        <link th:href="@{/sb-admin-1.0.4/css/bootstrap.min.css}" rel="stylesheet">
        <link th:href="@{/sb-admin-1.0.4/css/sb-admin.css}" rel="stylesheet">
        <link th:href="@{/sb-admin-1.0.4/css/plugins/morris.css}" rel="stylesheet">
        <link th:href="@{/sb-admin-1.0.4/font-awesome/css/font-awesome.min.css}" rel="stylesheet">
        <script th:src="@{/sb-admin-1.0.4/js/jquery.js}"></script>
        <script th:src="@{/sb-admin-1.0.4/js/bootstrap.min.js}"></script>
        <script th:src="@{/sb-admin-1.0.4/js/plugins/morris/raphael.min.js}"></script>
        <script th:src="@{/sb-admin-1.0.4/js/plugins/morris/morris.min.js}"></script>
        <script th:src="@{/sb-admin-1.0.4/js/plugins/morris/morris-data.js}"></script>
    </head>
</html>

三、頁面顯示和國際化

Spring Boot 實現國際化步驟:

1、準備好國際化文件,至少三分(系統默認,中文,英文)

2、在Spring Boot全局配置文件中,指定國際化文件路徑,

3、自定義Locale Resolver

4、在頁面上使用消息表達式輸出國際化內容

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容