简单说, Thymeleaf 是一个跟 Velocity、FreeMarker 类似的模板引擎,它可以完全替代 JSP 。相较与其他的模板引擎,它有如下三个极吸引人的特点:
1.Thymeleaf 在有网络和无网络的环境下皆可运行,即它可以让美工在浏览器查看页面的静态效果,也可以让程序员在服务器查看带数据的动态页面效果。这是由于它支持 html 原型,然后在 html 标签里增加额外的属性来达到模板+数据的展示方式。浏览器解释 html 时会忽略未定义的标签属性,所以 thymeleaf 的模板可以静态地运行;当有数据返回到页面时,Thymeleaf 标签会动态地替换掉静态内容,使页面动态显示。
2.Thymeleaf 开箱即用的特性。它提供标准和spring标准两种方言,可以直接套用模板实现JSTL、 OGNL表达式效果,避免每天套模板、该jstl、改标签的困扰。同时开发人员也可以扩展和创建自定义的方言。
3.Thymeleaf 提供spring标准方言和一个与 SpringMVC 完美集成的可选模块,可以快速的实现表单绑定、属性编辑器、国际化等功能。
它们分为四类:
变量表达式即OGNL表达式或Spring EL表达式(在Spring术语中也叫model attributes)。如下所示:${session.user.name}
它们将以HTML标签的一个属性来表示:
th:text="${book.author.name}">
th:each="book : ${books}">
选择表达式很像变量表达式,不过它们用一个预先选择的对象来代替上下文变量容器(map)来执行,如下: *{customer.name}
被指定的object由th:object属性定义:
th:object="${book}">
...
th:text="*{title}">...
...
文字国际化表达式允许我们从一个外部文件获取区域文字信息(.properties),用Key索引Value,还可以提供一组参数(可选).
#{main.title}
#{message.entrycreated(${entryId})}
可以在模板文件中找到这样的表达式代码:
...
th:text="#{header.address.city}">...
th:text="#{header.address.country}">...
...
URL表达式指的是把一个有用的上下文或回话信息添加到URL,这个过程经常被叫做URL重写。 @{/order/list}
URL还可以设置参数: @{/order/details(id=${orderId})}
相对路径: @{../documents/report}
让我们看这些表达式:
如果不考虑上下文的情况下,两者没有区别;星号语法评估在选定对象上表达,而不是整个上下文
什么是选定对象?就是父标签的值,如下:
th:object="${session.user}">
Name: th:text="*{firstName}">Sebastian.
Surname: th:text="*{lastName}">Pepper.
Nationality: th:text="*{nationality}">Saturn.
这是完全等价于:
th:object="${session.user}">
Name: th:text="${session.user.firstName}">Sebastian.
Surname: th:text="${session.user.lastName}">Pepper.
Nationality: th:text="${session.user.nationality}">Saturn.
当然,美元符号和星号语法可以混合使用:
th:object="${session.user}">
Name: th:text="*{firstName}">Sebastian.
Surname: th:text="${session.user.lastName}">Pepper.
Nationality: th:text="*{nationality}">Saturn.
'one text', 'Another one!',…
0, 34, 3.0, 12.3,…
true, false
null
one, sometext, main,…
+
|The name is ${name}|
+, -, *, /, %
-
and, or
!, not
>, <, >=, <= (gt, lt, ge, le)
==, != (eq, ne)
(if) ? (then)
(if) ? (then) : (else)
(defaultvalue)
所有这些特征可以被组合并嵌套:
'User is of type ' + (${user.isAdmin()} ? 'Administrator' : (${user.type} ?: 'Unknown'))
关键字 | 功能介绍 | 案例 | |||
---|---|---|---|---|---|
th:id | 替换id | |
|||
th:text | 文本替换 |
|
|||
th:utext | 支持html的文本替换 |
|
|||
th:object | 替换对象 |
|
|||
th:value | 属性赋值 | |
|||
th:with | 变量赋值运算 | |
|||
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:unless | 和th:if判断相反 | Login |
|||
th:href | 链接地址 | Login /> |
|||
th:switch | 多路选择 配合th:case 使用 |
|
|||
th:case | th:switch的一个分支 | |
|||
th:fragment | 布局标签,定义一个代码片段,方便其它地方引用 |
|
|||
th:include | 布局标签,替换内容到引入的文件 | /> |
|||
th:replace | 布局标签,替换整个标签到引入的文件 | |
|||
th:selected | selected选择框 选中 | th:selected="(${xxx.id} == ${configObj.dd})" |
|||
th:src | 图片类地址引入 | |
|||
th:inline | 定义js脚本可以使用变量 |
|
|||
th:action | 表单提交的地址 |
|
|||
th:remove | 删除某个属性 |
|
还有非常多的标签,这里只列出最常用的几个,由于一个标签内可以包含多个th:x属性,其生效的优先级顺序为:include,each,if/unless/switch/case,with,attr/attrprepend/attrappend,value/href,src ,etc,text/utext,fragment,remove。
th:text="${collect.description}">description
th:text="'Welcome to our application, ' + ${user.name} + '!'">
字符串拼接还有另外一种简洁的写法
th:text="|Welcome to our application, ${user.name}!|">
Thymeleaf中使用th:if和th:unless属性进行条件判断,下面的例子中,标签只有在
th:if
中条件成立时才显示:
th:unless于th:if恰好相反,只有表达式中的条件不成立,才会显示其内容。
也可以使用 (if) ? (then) : (else)
这种语法来判断显示的内容
th:each="collect,iterStat : ${collects}">
scope="row" th:text="${collect.id}">1
>
th:src="${collect.webLogo}"/>
th:text="${collect.url}">Mark
th:text="${collect.title}">Otto
th:text="${collect.description}">@mdo
th:text="${terStat.index}">index
iterStat称作状态变量,属性有:
URL在Web应用模板中占据着十分重要的地位,需要特别注意的是Thymeleaf对于URL的处理是通过语法@{…}来处理的。 如果需要Thymeleaf对URL进行渲染,那么务必使用th:href,th:src等属性,下面是一个例子
th:href="@{/standard/{type}(type=${type})}">view
href="details.html" th:href="@{/order/{orderId}/details(orderId=${o.id})}">view
设置背景
th:style="'background:url(' + @{/} + ');'" >
根据属性值改变背景
class="media-object resource-card-image" th:style="'background:url(' + @{(${collect.webLogo}=='' ? 'img/favicon.png' : ${collect.webLogo})} + ')'" >
几点说明:
(orderId=${o.id})
表示将括号内的内容作为URL参数处理,该语法避免使用字符串拼接,大大提高了可读性@{...}
表达式中可以通过{orderId}
访问Context中的orderId变量@{/order}
是Context相关的相对路径,在渲染时会自动添加上当前Web应用的Context名字,假设context名字为app,那么结果应该是/app/order内联文本:[[…]]内联文本的表示方式,使用时,必须先用th:inline=”text/javascript/none”激活,th:inline可以在父级标签内使用,甚至作为body的标签。内联文本尽管比th:text的代码少,不利于原型显示。
<script th:inline="javascript">
/*
...
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中),可以通过#直接访问:
下面用一段代码来举例一些常用的方法:
/*
* 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()}
/*
* 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布局非常的方便
定义代码片段
在页面任何地方引入:
th:include="footer :: copy">
th:replace="footer :: copy">
th:include 和 th:replace区别,include只是加载,replace是替换
返回的HTML如下:
© 2016
© 2016
下面是一个常用的后台页面布局,将整个页面分为头部,尾部、菜单栏、隐藏栏,点击菜单只改变content区域的页面
class="layout-fixed">
th:fragment="navbar" class="wrapper" role="navigation">
th:replace="fragments/header :: header">Header
th:replace="fragments/left :: left">left
th:replace="fragments/sidebar :: sidebar">sidebar
layout:fragment="content" id="content" >
th:replace="fragments/footer :: footer">footer
任何页面想使用这样的布局值只需要替换中见的 content模块即可
xmlns:th="http://www.thymeleaf.org" layout:decorator="layout">
layout:fragment="content">
...
也可以在引用模版的时候传参
th:include="layout :: htmlhead" th:with="title='Hello'">
layout 是文件地址,如果有文件夹可以这样写 fileName/layout:htmlhead
htmlhead 是指定义的代码片段 如 th:fragment="copy"
这里有一个开源项目几乎使用了这里介绍的所有标签和布局,大家可以参考: cloudfavorites