冰冰的小屋

路漫漫其修远兮,吾将上下而求索

新一代 Java 模板引擎 Thymeleaf


David 发表在天码营

Thymeleaf 是一款用于渲染 XML/XHTML/HTML5 内容的模板引擎。类似 JSP,Velocity,FreeMaker 等,它也可以轻易的与 Spring MVC 等 Web 框架进行集成作为 Web 应用的模板引擎。与其它模板引擎相比,Thymeleaf 最大的特点是能够直接在浏览器中打开并正确显示模板页面,而不需要启动整个 Web 应用。

Thymeleaf 初探

相比于其他的模板引擎,Thymeleaf 最大的特点是通过 HTML 的标签属性渲染标签内容,以下是一个 Thymeleaf 模板例子:

 

这是一段标准的 HTML 代码,这也就意味着通过浏览器直接打开它是可以正确解析它的结构并看到页面的样子。相比去其他的模板引擎在指定的位置通过${}等表达式进行渲染,Thymeleaf 则是一种针对 HTML/XML 定制的模板语言(当然它可以被扩展),它通过标签中的th:text属性来填充该标签的一段内容。上例中,<p th:text="#{home.welcome}">Welcome to our grocery store!</p>意味着<p>标签中的内容会被表达式#{home.welcome}的值所替代,无论模板中它的内容是什么,之所以在模板中 “多此一举 “地填充它的内容,完全是为了它能够作为原型在浏览器中直接显示出来。

标准表达式语法

变量

Thymeleaf 模板引擎在进行模板渲染时,还会附带一个 Context 存放进行模板渲染的变量,在模板中定义的表达式本质上就是从 Context 中获取对应的变量的值:

假设today的值为2015年8月14日,那么渲染结果为:<p>Today is: 2015年8月14日.</p>。可见 Thymeleaf 的基本变量和 JSP 一样,都使用${.}表示获取变量的值。

URL

URL 在 Web 应用模板中占据着十分重要的地位,需要特别注意的是 Thymeleaf 对于 URL 的处理是通过语法@{...}来处理的。Thymeleaf 支持绝对路径 URL:

同时也能够支持相对路径 URL:

  • 当前页面相对路径 URL——user/login.html,通常不推荐这样写。
  • Context 相关 URL——/static/css/style.css

另外,如果需要 Thymeleaf 对 URL 进行渲染,那么务必使用th:hrefth:src等属性,下面是一个例子

几点说明:

  • 上例中 URL 最后的 (orderId=${o.id}) 表示将括号内的内容作为 URL 参数处理,该语法避免使用字符串拼接,大大提高了可读性
  • @{...}表达式中可以通过{orderId}访问 Context 中的orderId变量
  • @{/order}是 Context 相关的相对路径,在渲染时会自动添加上当前 Web 应用的 Context 名字,假设 context 名字为 app,那么结果应该是/app/order

如果 URLs 写在 style 的属性里,那么

替换写成 style 前面加 th: 链接的前后加上 + 号运算符,如下:

字符串替换

很多时候可能我们只需要对一大段文字中的某一处地方进行替换,可以通过字符串拼接操作完成:

一种更简洁的方式是:

当然这种形式限制比较多,|...|中只能包含变量表达式${...},不能包含其他常量、条件表达式等。

运算符

在表达式中可以使用各类算术运算符,例如 +, -, *, /, %

逻辑运算符>, <, <=,>===,!=都可以使用,唯一需要注意的是使用<,>时需要用它的 HTML 转义符:

循环

渲染列表数据是一种非常常见的场景,例如现在有 n 条记录需要渲染成一个表格<table>,该数据集合必须是可以遍历的,使用th:each标签:

可以看到,需要在被循环渲染的元素(这里是<tr>)中加入th:each标签,其中th:each="prod : ${prods}"意味着对集合变量prods进行遍历,循环变量是prod在循环体中可以通过表达式访问。

条件求值

If/Unless

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

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

Switch

Thymeleaf 同样支持多路选择 Switch 结构:

默认属性 default 可以用*表示:

Utilities

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

  • #dates
  • #calendars
  • #numbers
  • #strings
  • arrays
  • lists
  • sets
  • maps

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

#dates

#strings

页面即原型

在 Web 开发过程中一个绕不开的话题就是前端工程师与后端工程师的写作,在传统 Java Web 开发过程中,前端工程师和后端工程师一样,也需要安装一套完整的开发环境,然后各类 Java IDE 中修改模板、静态资源文件,启动 / 重启 / 重新加载应用服务器,刷新页面查看最终效果。

但实际上前端工程师的职责更多应该关注于页面本身而非后端,使用 JSP,Velocity 等传统的 Java 模板引擎很难做到这一点,因为它们必须在应用服务器中渲染完成后才能在浏览器中看到结果,而 Thymeleaf 从根本上颠覆了这一过程,通过属性进行模板渲染不会引入任何新的浏览器不能识别的标签,例如 JSP 中的<form:input>,不会在 Tag 内部写表达式。整个页面直接作为 HTML 文件用浏览器打开,几乎就可以看到最终的效果,这大大解放了前端工程师的生产力,它们的最终交付物就是纯的 HTML/CSS/JavaScript 文件。

点赞

发表评论

电子邮件地址不会被公开。 必填项已用*标注