`

springboot-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标签的一个属性来表示:

<span th:text="${book.author.name}"> 
<li th:each="book : ${books}">

选择(星号)表达式

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

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

    <div th:object="${book}">  
      ...  
      <span th:text="*{title}">...</span>  
      ...  
    </div>

文字国际化表达式

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

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

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

    <table>  
      ...  
      <th th:text="#{header.address.city}">...</th>  
      <th th:text="#{header.address.country}">...</th>  
      ...  
    </table>

URL表达式

URL表达式指的是把一个有用的上下文或回话信息添加到URL,这个过程经常被叫做URL重写。
@{/order/list}
URL还可以设置参数:
@{/order/details(id=${orderId})}
相对路径:
@{../documents/report}  

让我们看这些表达式:

    <form th:action="@{/createOrder}">  
    <a href="main.html" th:href="@{/main}">

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

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

  <div th:object="${session.user}">
    <p>Name: <span th:text="*{firstName}">Sebastian</span>.</p>
    <p>Surname: <span th:text="*{lastName}">Pepper</span>.</p>
    <p>Nationality: <span th:text="*{nationality}">Saturn</span>.</p>
  </div>

这是完全等价于:

  <div th:object="${session.user}">
      <p>Name: <span th:text="${session.user.firstName}">Sebastian</span>.</p>
      <p>Surname: <span th:text="${session.user.lastName}">Pepper</span>.</p>
      <p>Nationality: <span th:text="${session.user.nationality}">Saturn</span>.</p>
  </div>

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

  <div th:object="${session.user}">
      <p>Name: <span th:text="*{firstName}">Sebastian</span>.</p>
      <p>Surname: <span th:text="${session.user.lastName}">Pepper</span>.</p>
      <p>Nationality: <span th:text="*{nationality}">Saturn</span>.</p>
  </div>

表达式支持的语法

字面(Literals)

  • 文本文字(Text literals): 'one text', 'Another one!',…

  • 数字文本(Number literals): 0, 34, 3.0, 12.3,…

  • 布尔文本(Boolean literals): true, false

  • 空(Null literal): null

  • 文字标记(Literal tokens): one, sometext, main,…

文本操作(Text operations)

  • 字符串连接(String concatenation): +

  • 文本替换(Literal substitutions): |The name is ${name}|

算术运算(Arithmetic operations)

  • 二元运算符(Binary operators): +, -, *, /, %

  • 减号(单目运算符)Minus sign (unary operator): -

布尔操作(Boolean operations)

  • 二元运算符(Binary operators):and, or

  • 布尔否定(一元运算符)Boolean negation (unary operator):!, not

比较和等价(Comparisons and equality)

  • 比较(Comparators): >, <, >=, <= (gt, lt, ge, le)

  • 等值运算符(Equality operators):==, != (eq, ne)

条件运算符(Conditional operators)

  • If-then: (if) ? (then)

  • If-then-else: (if) ? (then) : (else)

  • Default: (value) ?: (defaultvalue)

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

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

常用th标签都有那些?

关键字 功能介绍 案例
th:id 替换id <input th:id="'xxx' + ${collect.id}"/>  
th:text 文本替换 <p  th:text="${collect.description}">description</p>
th:utext 支持html的文本替换 <p  th:utext="${htmlcontent}">conten</p>
th:object 替换对象 <div th:object="${session.user}">
th:value 属性赋值 <input th:value="${user.name}" />
th:with 变量赋值运算 <div th:with="isEven=${prodStat.count}%2==0"></div>
th:style 设置样式 th:style="'display:' + @{(${sitrue} ? 'none' : 'inline-block')} + ''"
th:onclick 点击事件 th:onclick="'getCollect()'"
th:each 属性赋值 tr th:each="user,userStat:${users}">
th:if 判断条件 <a th:if="${userId == collect.userId}" >
th:unless 和th:if判断相反 <a th:href="@{/login}" th:unless=${session.user != null}>Login</a>
th:href 链接地址 <a th:href="@{/login}" th:unless=${session.user != null}>Login</a> />
th:switch 多路选择 配合th:case 使用 <div th:switch="${user.role}">
th:case th:switch的一个分支 <p th:case="'admin'">User is an administrator</p>
th:fragment 布局标签,定义一个代码片段,方便其它地方引用 <div th:fragment="alert">
th:include 布局标签,替换内容到引入的文件 <head th:include="layout :: htmlhead" th:with="title='xx'"></head> />
th:replace 布局标签,替换整个标签到引入的文件 <div th:replace="fragments/header :: title"></div>
th:selected selected选择框 选中 th:selected="(${xxx.id} == ${configObj.dd})"
th:src 图片类地址引入 <img class="img-responsive" alt="App Logo" th:src="@{/img/logo.png}"  />
th:inline 定义js脚本可以使用变量 <script type="text/javascript" th:inline="javascript">
th:action 表单提交的地址 <form action="subscribe.html" th:action="@{/subscribe}">
th:remove 删除某个属性 <tr 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、赋值、字符串拼接

 <p  th:text="${collect.description}">description</p>
 <span th:text="'Welcome to our application, ' + ${user.name} + '!'">

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

<span th:text="|Welcome to our application, ${user.name}!|">

2、条件判断 If/Unless

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

<a th:if="${myself=='yes'}" > </i> </a>
<a th:unless=${session.user != null} th:href="@{/login}" >Login</a>

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

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

3、for 循环

  <tr  th:each="collect,iterStat : ${collects}"> 
     <th scope="row" th:text="${collect.id}">1</th>
     <td >
        <img th:src="${collect.webLogo}"/>
     </td>
     <td th:text="${collect.url}">Mark</td>
     <td th:text="${collect.title}">Otto</td>
     <td th:text="${collect.description}">@mdo</td>
     <td th:text="${terStat.index}">index</td>
 </tr>

iterStat称作状态变量,属性有:

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

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

  • size:被迭代对象的大小

  • current:当前迭代变量

  • even/odd:布尔值,当前循环是否是偶数/奇数(从0开始计算)

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

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

4、URL

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

<!-- Will produce 'http://localhost:8080/standard/unread' (plus rewriting) -->
 <a  th:href="@{/standard/{type}(type=${type})}">view</a>

<!-- Will produce '/gtvg/order/3/details' (plus rewriting) -->
<a href="details.html" th:href="@{/order/{orderId}/details(orderId=${o.id})}">view</a>

设置背景

<div th:style="'background:url(' + @{/<path-to-image>} + ');'"></div>

根据属性值改变背景

 <div class="media-object resource-card-image"  th:style="'background:url(' + @{(${collect.webLogo}=='' ? 'img/favicon.png' : ${collect.webLogo})} + ')'" ></div>

几点说明:

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

  • @{...}表达式中可以通过{orderId}访问Context中的orderId变量

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

5、内联js

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

<script th:inline="javascript">
/*<![CDATA[*/
...
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';
/* -]*/

6、内嵌变量

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

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

dates

/*
 * 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()}

strings

/*
 * 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布局

使用thymeleaf布局非常的方便

定义代码片段

<footer th:fragment="copy">
&copy; 2016
</footer>

在页面任何地方引入:

<body> 
  <div th:include="footer :: copy"></div>
  <div th:replace="footer :: copy"></div>
 </body>

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

返回的HTML如下:

<body> 
   <div> &copy; 2016 </div> 
  <footer>&copy; 2016 </footer>
</body>

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

<body class="layout-fixed">
  <div th:fragment="navbar"  class="wrapper"  role="navigation">
    <div th:replace="fragments/header :: header">Header</div>
    <div th:replace="fragments/left :: left">left</div>
    <div th:replace="fragments/sidebar :: sidebar">sidebar</div>
    <div layout:fragment="content" id="content" ></div>
    <div th:replace="fragments/footer :: footer">footer</div>
  </div>
</body>

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

 <html xmlns:th="http://www.thymeleaf.org" layout:decorator="layout">
   <body>
      <section layout:fragment="content">
    ...

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

<head th:include="layout :: htmlhead" th:with="title='Hello'"></head>

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

源码案例

这里有一个开源项目几乎使用了这里介绍的所有标签和布局,大家可以参考:
https://github.com/cloudfavorites/favorites-web

 

 

转载

      http://mp.weixin.qq.com/s/1xMi2UxfLHsWCxMmPRJlNA

  

分享到:
评论

相关推荐

    springboot- thymeleaf-tiles-demo

    《SpringBoot、Thymeleaf与Tiles整合实战详解》 在现代Web开发中,SpringBoot以其简洁、快速的特性受到了广大开发者的喜爱。而Thymeleaf和Tiles作为两个强大的视图层技术,能帮助我们构建更加优雅和可维护的前端...

    一个基于SpringBoot+Thymeleaf渲染的图书管理系统

    《SpringBoot+Thymeleaf实现的图书管理系统详解》 在现代软件开发中,SpringBoot以其简化Spring应用的初始搭建以及开发过程而受到广大开发者喜爱。结合Thymeleaf模板引擎,可以快速构建出功能丰富的Web应用,如本...

    springboot2.0-thymeleaf.rar

    《SpringBoot 2.0与Thymeleaf模板引擎实战详解》 在现代Web开发中,SpringBoot以其简洁、高效的特点成为了许多开发者的首选框架。而Thymeleaf作为一个强大的服务器端模板引擎,能与SpringBoot完美融合,提供动态...

    springboot-thymeleaf.rar

    《SpringBoot与Thymeleaf整合详解》 在现代Java Web开发中,Spring Boot以其便捷的配置、快速的启动和强大的功能集成为开发者们青睐的框架。而在模板引擎的选择上,Thymeleaf以其语法清晰、支持离线开发以及与...

    SpringBoot-Vue-OnlineExam.zip

    《基于SpringBoot与Vue的在线考试系统详解》 在当今数字化时代,教育领域的技术应用日益广泛,其中在线考试系统作为一种高效、便捷的教学辅助工具,深受广大师生喜爱。本项目"SpringBoot-Vue-OnlineExam.zip"就是...

    基于springboot-blogs个人技术博客管理系统

    《基于SpringBoot-Blogs的个人技术博客管理系统详解》 在当今信息化时代,个人技术博客已经成为技术爱好者、开发者和研究人员分享知识、交流经验的重要平台。本文将深入探讨一款名为"SpringBoot-Blogs"的个人技术...

    Java学习资料-SpringBoot自带模板引擎Thymeleaf使用详解

    Thymeleaf 是一个强大的模板引擎,尤其在与 Spring Boot 结合使用时,可以简化 Web 应用程序的视图层开发。以下是关于 Thymeleaf 在 Spring Boot 中的使用和一些关键知识点的详细说明: 1. **Thymeleaf 依赖**: ...

    springboot-example01

    《SpringBoot学习示例——springboot-example01详解》 SpringBoot是Java开发中的一个热门框架,它由Pivotal团队提供,旨在简化Spring应用的初始搭建以及开发过程。在这个名为"springboot-example01"的学习示例中,...

    springboot-learning-example-master.zip

    《SpringBoot学习示例详解》 SpringBoot是Java开发领域中的一个热门框架,它由Pivotal团队维护,旨在简化Spring应用的初始搭建以及开发过程。SpringBoot的核心理念是“约定优于配置”,使得开发者能够快速地创建...

    springboot+thymeleaf实验室招聘计划系统.rar,#资源达人分享计划#

    《SpringBoot + Thymeleaf 实验室招聘计划系统详解》 在现代信息技术领域,SpringBoot 和 Thymeleaf 的组合已经成为开发高效、简洁的Web应用的热门选择。本资源——"springboot+thymeleaf实验室招聘计划系统",正是...

    SpringBoot-Shiro-Vue_2.7z

    《SpringBoot-Shiro-Vue整合实战详解》 在IT领域,SpringBoot、Shiro和Vue.js是三个非常重要的技术组件,它们分别代表了后端开发的便捷性、权限管理的高效性和前端展示的灵活性。本项目"SpringBoot-Shiro-Vue"结合...

    springboot-page-master.zip

    3. **Thymeleaf或JSP视图解析**:SpringBoot通常推荐使用Thymeleaf作为模板引擎,因为它易于理解和使用,且与Spring集成良好。如果项目使用的是JSP,那么SpringBoot也可以支持,但JSP在现代Web开发中逐渐被更现代的...

    基于springboot +thymeleaf 的小米商城管理系统.zip

    《基于SpringBoot + Thymeleaf的小米商城管理系统详解》 SpringBoot与Thymeleaf的结合在现代Java Web开发中被广泛应用,尤其适合构建快速、简洁且具有自配置特性的应用程序。本项目"基于SpringBoot + Thymeleaf的...

    基于springboot+thymeleaf的理财管理系统源码.zip

    《基于SpringBoot+Thymeleaf的理财管理系统详解》 理财管理系统是现代企业与个人管理财务的重要工具,而采用SpringBoot和Thymeleaf技术构建的系统则具有高效、便捷和灵活的优势。本文将深入探讨这个基于SpringBoot+...

    springboot-shiro

    在前端页面,我们可以使用Thymeleaf等模板引擎,结合Shiro的标签库,动态展示用户权限控制的界面。例如,根据用户的角色和权限,决定按钮是否显示、链接是否可点击等。 总之,结合SpringBoot的便捷性和Shiro的强大...

    基于SpringBoot+Thymeleaf的招聘系统.zip

    《基于SpringBoot+Thymeleaf的招聘系统详解》 在现代互联网开发中,SpringBoot以其简洁、高效和快速启动的特点,已经成为Java后端开发的首选框架。而Thymeleaf作为一款强大的模板引擎,与SpringBoot的集成使得前端...

    详解SpringBoot+Thymeleaf 基于HTML5的现代模板引擎

    在 SpringBoot 中使用 Thymeleaf 非常简单,只需引入依赖项: ```xml &lt;groupId&gt;org.springframework.boot &lt;artifactId&gt;spring-boot-starter-thymeleaf ``` 配置 Thymeleaf 在 application.yml 文件中,添加 ...

    activiti-demo6-springboot-master.zip

    《SpringBoot整合Activiti实战详解》 在现代企业级应用开发中,流程管理扮演着至关重要的角色,而Activiti作为一款强大的工作流引擎,被广泛应用于业务流程自动化。本示例"activiti-demo6-springboot-master.zip"是...

    spring boot 实践学习案例,与其它组件整合

    - Spring Boot 基础知识,包括SpringBoot起步、配置详解、aop、filter、拦截器、监听、启动器、全局异常处理、外部Tomcat启动、HTTPS、监控 等。 - springboot-data - Spring Boot 数据库操作,包括SpringJDBC、...

    springboot-activitiDemo-master.zip

    《SpringBoot集成Activiti实战详解》 在当前的IT领域,SpringBoot因其便捷的开发特性,已经成为企业级应用开发的首选框架。而Activiti作为一款流程自动化引擎,它能够帮助企业实现工作流管理,提高业务效率。本文将...

Global site tag (gtag.js) - Google Analytics