Spring Boot(四)：Thymeleaf 使用详解

  • 纯洁的微笑

    2019-04-12 10:31:46
  • 数据分析
  • 原创

在上篇文章Spring Boot (二)：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标签的一个属性来表示：

  

选择(星号)表达式

选择表达式很像变量表达式，不过它们用一个预先选择的对象来代替上下文变量容器(map)来执行，如下：
*{customer.name}

被指定的 object 由 th:object 属性定义：

    ...    ...    ...  

文字国际化表达式

文字国际化表达式允许我们从一个外部文件获取区域文字信息(.properties)，用 Key 索引 Value，还可以提供一组参数(可选).

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

可以在模板文件中找到这样的表达式代码：

    ...    ...    ...    ...  

URL 表达式

URL 表达式指的是把一个有用的上下文或回话信息添加到 URL，这个过程经常被叫做 URL 重写。
@{/order/list}

URL还可以设置参数：
@{/order/details(id=${orderId})}

相对路径：
@{../documents/report}

让我们看这些表达式：

  

变量表达式和星号表达有什么区别吗？

如果不考虑上下文的情况下，两者没有区别；星号语法评估在选定对象上表达，而不是整个上下文
什么是选定对象？就是父标签的值，如下：

  
Name: Sebastian.
  
Surname: Pepper.
  
Nationality: Saturn.

这是完全等价于：

  
Name: Sebastian.
  
Surname: Pepper.
  
Nationality: Saturn.

当然，美元符号和星号语法可以混合使用：

        
Name: Sebastian.
        
Surname: Pepper.
      
Nationality: Saturn.
  

表达式支持的语法

字面（Literals）

文本操作（Text operations）

算术运算（Arithmetic operations）

布尔操作（Boolean operations）

比较和等价(Comparisons and equality)

条件运算符（Conditional operators）

所有这些特征可以被组合并嵌套：

'User is of type ' + (${user.isAdmin()} ? 'Administrator' : (${user.type} ?: 'Unknown'))

常用th标签都有那些？

关键字功能介绍案例
th:id替换idth:id="'xxx' + ${collect.id}"/>
th:text文本替换th:text="${collect.description}">description

th:utext支持html的文本替换th:utext="${htmlcontent}">conten

th:object替换对象th:object="${session.user}">
th:value属性赋值th:value="${user.name}"/>
th:with变量赋值运算th:with="isEven=${prodStat.count}%2==0">
th:style设置样式th:style="'display:' + @{(${sitrue} ? 'none' : 'inline-block')} + ''"
th:onclick点击事件th:onclick="'getCollect()'"
th:each属性赋值tr th:each="user,userStat:${users}">
th:if判断条件th:if="${userId == collect.userId}">
th:unless和th:if判断相反th:href="@{/login}"th:unless=${session.user!=null}>Login
th:href链接地址th:href="@{/login}"th:unless=${session.user!=null}>Login/>
th:switch多路选择 配合th:case 使用th:switch="${user.role}">
th:caseth:switch的一个分支th:case="'admin'">User is an administrator

th:fragment布局标签，定义一个代码片段，方便其它地方引用th:fragment="alert">
th:include布局标签，替换内容到引入的文件th:include="layout :: htmlhead"th:with="title='xx'">/>
th:replace布局标签，替换整个标签到引入的文件th:replace="fragments/header :: title">
th:selectedselected选择框 选中th:selected="(${xxx.id} == ${configObj.dd})"
th:src图片类地址引入class="img-responsive"alt="App Logo"th:src="@{/img/logo.png}"/>
th:inline定义js脚本可以使用变量type="text/javascript"th:inline="javascript">
th:action表单提交的地址action="subscribe.html"th:action="@{/subscribe}">
th:remove删除某个属性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、赋值、字符串拼接

description

字符串拼接还有另外一种简洁的写法

2、条件判断 If/Unless

Thymeleaf中使用th:if和th:unless属性进行条件判断，下面的例子中， 标签只有在 th:if中条件成立时才显示：

  Login

th:unless 于 th:if 恰好相反，只有表达式中的条件不成立，才会显示其内容。

也可以使用 (if)?(then):(else)这种语法来判断显示的内容

3、for 循环

    1               Mark   Otto   @mdo   index

iterStat称作状态变量，属性有：

4、URL

URL 在 Web 应用模板中占据着十分重要的地位，需要特别注意的是 Thymeleaf 对于 URL 的处理是通过语法 @{...} 来处理的。 如果需要 Thymeleaf 对 URL 进行渲染，那么务必使用 th:href， th:src 等属性，下面是一个例子

  2.    th:href="@{/standard/{type}(type=${type})}">view

  5.  href="details.html" th:href="@{/order/{orderId}/details(orderId=${o.id})}">view

设置背景

} + ');'">

根据属性值改变背景

 

几点说明：

5、内联 js

内联文本：[[...]] 内联文本的表示方式，使用时，必须先用 th:inline="text/javascript/none"激活， th:inline可以在父级标签内使用，甚至作为 body 的标签。内联文本尽管比 th:text的代码少，不利于原型显示。

/**/

js 附加代码：

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

js 移除代码：

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

6、内嵌变量

为了模板更加易用，Thymeleaf 还提供了一系列 Utility 对象（内置于 Context 中），可以通过 # 直接访问：

下面用一段代码来举例一些常用的方法：

dates

  1. /*
  2.  * Format date with the specified pattern
  3.  * Also works with arrays, lists or sets
  4.  */
  5. ${#dates.format(date, 'dd/MMM/yyyy HH:mm')}
  6. ${#dates.arrayFormat(datesArray, 'dd/MMM/yyyy HH:mm')}
  7. ${#dates.listFormat(datesList, 'dd/MMM/yyyy HH:mm')}
  8. ${#dates.setFormat(datesSet, 'dd/MMM/yyyy HH:mm')}

  10. /*
  11.  * Create a date (java.util.Date) object for the current date and time
  12.  */
  13. ${#dates.createNow()}

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

strings

  1. /*
  2.  * Check whether a String is empty (or null). Performs a trim() operation before check
  3.  * Also works with arrays, lists or sets
  4.  */
  5. ${#strings.isEmpty(name)}
  6. ${#strings.arrayIsEmpty(nameArr)}
  7. ${#strings.listIsEmpty(nameList)}
  8. ${#strings.setIsEmpty(nameSet)}

  10. /*
  11.  * Check whether a String starts or ends with a fragment
  12.  * Also works with arrays, lists or sets
  13.  */
  14. ${#strings.startsWith(name,'Don')}                  // also array*, list* and set*
  15. ${#strings.endsWith(name,endingFragment)}           // also array*, list* and set*

  17. /*
  18.  * Compute length
  19.  * Also works with arrays, lists or sets
  20.  */
  21. ${#strings.length(str)}

  23. /*
  24.  * Null-safe comparison and concatenation
  25.  */
  26. ${#strings.equals(str)}
  27. ${#strings.equalsIgnoreCase(str)}
  28. ${#strings.concat(str)}
  29. ${#strings.concatReplaceNulls(str)}

  31. /*
  32.  * Random
  33.  */
  34. ${#strings.randomAlphanumeric(count)}

使用 Thymeleaf 布局

Spring Boot 2.0 将布局单独提取了出来，需要单独引入依赖：thymeleaf-layout-dialect。

    org.springframework.boot    spring-boot-starter-thymeleaf    nz.net.ultraq.thymeleaf    thymeleaf-layout-dialect

定义代码片段

 © 2019

在页面任何地方引入：

        

th:insert 和 th:replace 区别，insert 只是加载，replace 是替换。Thymeleaf 3.0 推荐使用 th:insert 替换 2.0 的 th:replace。

返回的 HTML 如下：

    
 © 2019 
    

下面是一个常用的后台页面布局，将整个页面分为头部，尾部、菜单栏、隐藏栏，点击菜单只改变 content 区域的页面

      Header    left    sidebar        footer  

任何页面想使用这样的布局值只需要替换中见的 content 模块即可

       ...

也可以在引用模版的时候传参

layout 是文件地址，如果有文件夹可以这样写 fileName/layout:htmlhead，htmlhead 是指定义的代码片段 如 th:fragment="copy"

文章示例项目

示例代码-https://github.com/ityouknow/spring-boot-examples/tree/master/spring-boot-thymeleaf

文章内容已经升级到 Spring Boot 2.x

请使用浏览器的分享功能分享到微信等