springboot(四)：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)。如下所示：

<code>${session.user.name}</code>

它们将以html标签的一个属性来表示：

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

<code>*{customer.name}</code>

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

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

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

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

<code>@{/order/list}</code>

url还可以设置参数：

<code>@{/order/details(id=${orderid})}</code>

相对路径：

<code>@{../documents/report}</code>

让我们看这些表达式：

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

什么是选定对象？就是父标签的值，如下：

这是完全等价于：

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

文本文字（text literals）: <code>'one text', 'another one!',…</code>

数字文本（number literals）: <code>0, 34, 3.0, 12.3,…</code>

布尔文本（boolean literals）: <code>true, false</code>

空（null literal）: <code>null</code>

文字标记（literal tokens）: <code>one, sometext, main,…</code>

字符串连接(string concatenation): <code>+</code>

文本替换（literal substitutions）: <code>|the name is ${name}|</code>

二元运算符（binary operators）: <code>+, -, *, /, %</code>

减号（单目运算符）minus sign (unary operator): <code>-</code>

二元运算符（binary operators）:<code>and, or</code>

布尔否定（一元运算符）boolean negation (unary operator):<code>!, not</code>

比较（comparators）: <code>&gt;, &lt;, &gt;=, &lt;= (gt, lt, ge, le)</code>

等值运算符（equality operators）:<code>==, != (eq, ne)</code>

if-then: <code>(if) ? (then)</code>

if-then-else: <code>(if) ? (then) : (else)</code>

default: (value) ?: <code>(defaultvalue)</code>

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

关键字

功能介绍

案例

th:id

替换id

<code>&lt;input th:id="'xxx' + ${collect.id}"/&gt;</code>

th:text

文本替换

<code>&lt;p th:text="${collect.description}"&gt;description&lt;/p&gt;</code>

th:utext

支持html的文本替换

<code>&lt;p th:utext="${htmlcontent}"&gt;conten&lt;/p&gt;</code>

th:object

替换对象

<code>&lt;div th:object="${session.user}"&gt;</code>

th:value

属性赋值

<code>&lt;input th:value="${user.name}" /&gt;</code>

th:with

变量赋值运算

<code>&lt;div th:with="iseven=${prodstat.count}%2==0"&gt;&lt;/div&gt;</code>

th:style

设置样式

<code>th:style="'display:' + @{(${sitrue} ? 'none' : 'inline-block')} + ''"</code>

th:onclick

点击事件

<code>th:onclick="'getcollect()'"</code>

th:each

<code>tr th:each="user,userstat:${users}"&gt;</code>

th:if

判断条件

<code>&lt;a th:if="${userid == collect.userid}" &gt;</code>

th:unless

和th:if判断相反

<code>&lt;a th:href="@{/login}" th:unless=${session.user != null}&gt;login&lt;/a&gt;</code>

th:href

链接地址

<code>&lt;a th:href="@{/login}" th:unless=${session.user != null}&gt;login&lt;/a&gt; /&gt;</code>

th:switch

多路选择 配合th:case 使用

<code>&lt;div th:switch="${user.role}"&gt;</code>

th:case

th:switch的一个分支

<code>&lt;p th:case="'admin'"&gt;user is an administrator&lt;/p&gt;</code>

th:fragment

布局标签，定义一个代码片段，方便其它地方引用

<code>&lt;div th:fragment="alert"&gt;</code>

th:include

布局标签，替换内容到引入的文件

<code>&lt;head th:include="layout :: htmlhead" th:with="title='xx'"&gt;&lt;/head&gt; /&gt;</code>

th:replace

布局标签，替换整个标签到引入的文件

<code>&lt;div th:replace="fragments/header :: title"&gt;&lt;/div&gt;</code>

th:selected

selected选择框 选中

<code>th:selected="(${xxx.id} == ${configobj.dd})"</code>

th:src

图片类地址引入

<code>&lt;img class="img-responsive" alt="app logo" th:src="@{/img/logo.png}" /&gt;</code>

th:inline

定义js脚本可以使用变量

<code>&lt;script type="text/javascript" th:inline="javascript"&gt;</code>

th:action

表单提交的地址

<code>&lt;form action="subscribe.html" th:action="@{/subscribe}"&gt;</code>

th:remove

删除某个属性

<code>&lt;tr th:remove="all"&gt; 1.all:删除包含标签和所有的孩子。2.body:不包含标记删除,但删除其所有的孩子。3.tag:包含标记的删除,但不删除它的孩子。4.all-but-first:删除所有包含标签的孩子,除了第一个。5.none:什么也不做。这个值是有用的动态评估。</code>

th:attr

设置标签属性，多个属性可以用逗号分隔

比如 <code>th:attr="src=@{/image/aa.jpg},title=#{logo}"</code>，此标签不太优雅，一般用的比较少。

还有非常多的标签，这里只列出最常用的几个,由于一个标签内可以包含多个th:x属性，其生效的优先级顺序为:

<code>include,each,if/unless/switch/case,with,attr/attrprepend/attrappend,value/href,src ,etc,text/utext,fragment,remove。</code>

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

thymeleaf中使用th:if和th:unless属性进行条件判断，下面的例子中，<code>&lt;a&gt;</code>标签只有在<code>th:if</code>中条件成立时才显示：

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

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

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

index:当前迭代对象的index（从0开始计算）

count: 当前迭代对象的index(从1开始计算)

size:被迭代对象的大小

current:当前迭代变量

even/odd:布尔值，当前循环是否是偶数/奇数（从0开始计算）

first:布尔值，当前循环是否是第一个

last:布尔值，当前循环是否是最后一个

url在web应用模板中占据着十分重要的地位，需要特别注意的是thymeleaf对于url的处理是通过语法@{…}来处理的。

如果需要thymeleaf对url进行渲染，那么务必使用th:href，th:src等属性，下面是一个例子

设置背景

根据属性值改变背景

几点说明：

上例中url最后的<code>(orderid=${o.id})</code> 表示将括号内的内容作为url参数处理，该语法避免使用字符串拼接，大大提高了可读性

<code>@{...}</code>表达式中可以通过<code>{orderid}</code>访问context中的orderid变量

<code>@{/order}</code>是context相关的相对路径，在渲染时会自动添加上当前web应用的context名字，假设context名字为app，那么结果应该是/app/order

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

js附加代码：

js移除代码：

为了模板更加易用，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

…

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

使用thymeleaf布局非常的方便

定义代码片段

在页面任何地方引入：

th:include 和 th:replace区别，include只是加载，replace是替换

返回的html如下：

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

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

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

layout 是文件地址，如果有文件夹可以这样写 filename/layout:htmlhead

htmlhead 是指定义的代码片段 如 <code>th:fragment="copy"</code>

这里有一个开源项目几乎使用了这里介绍的所有标签和布局，大家可以参考：

<a href="https://github.com/cloudfavorites/favorites-web">cloudfavorites</a>

<a href="http://www.thymeleaf.org/doc/tutorials/2.1/thymeleafspring.html#integrating-thymeleaf-with-spring">thymeleaf官方指南</a>

<a href="http://www.tianmaying.com/tutorial/using-thymeleaf">新一代java模板引擎thymeleaf</a>

<a href="http://www.webinno.cn/blog/article/view/131">thymeleaf基本知识</a>

<a href="http://v8en.com/news/list/47/0">thymeleaf总结文章</a>

<a href="http://www.cnblogs.com/lazio10000/p/5603955.html">thymeleaf 模板的使用</a>

<a href="http://www.blogjava.net/bjwulin/archive/2013/02/07/395234.html">thymeleaf 学习笔记</a>

作者：纯洁的微笑

版权所有，欢迎保留原文链接进行转载：)