1. Thymeleaf简介
1.1 什么是Thymeleaf
Thymeleaf是适用于web和独立环境的java模板引擎,能处理HTML、XML、JavaScript等等我们熟知的前端文件。它也是springboot官方推荐的模板引擎,在非前后端分离的项目中使用它可以提高我们的开发效率。
2. 基本使用
2.1 与SpringBoot整合
首先,pom.xml中导入thymeleaf的依赖
<!--引入thymeleaf的依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
在资源配置文件中加入相关配置
##############################################
#
# thymeleaf静态资源配置
#
##############################################
# 默认路径
spring.thymeleaf.prefix=classpath:/templates/
# 后缀
spring.thymeleaf.suffix=.html
# 模板格式
spring.thymeleaf.mode=HTML5
spring.thymeleaf.encoding=UTF-8
spring.thymeleaf.content-type=text/html
spring.thymeleaf.cache=false
2.2 创建示例页面
在resources文件夹下的templates中创建一个简单的模板页面index.html
注意:此文件夹下的文件不能直接访问,需通过控制器转发访问,类似WEB-INFO文件夹
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<title>Good Thymes Virtual Grocery</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<link rel="stylesheet" type="text/css" media="all"
href="../../css/gtvg.css" th:href="@{/css/gtvg.css}" />
</head>
<body>
<p th:text="${home.welcome}">Welcome to our grocery store!</p>
</body>
</html>
在这个模板里面,我们看见了一个头文件
<html xmlns:th="http://www.thymeleaf.org">
它可以让我们的集成开发工具完成相应的提示信息。
2.3 表达式
- ${…} 变量表达式
- @{…} 链接表达式
- #{…} 消息表达式
- ~{…} 代码块表达式
- *{…} 选择变量表达式
2.3.1 ~{…} 代码块表达式
支持的两种语法结构:
- ~{templatename::fragmentname}
- ~{templatename::#id}
- templatename为模板名称,意思就是文件名称,thymeleaf会根据模板名称解析到配置的路径/resources/templates/templatename.html
- fragmentname为片段名称,我们可以通过th:reagment = “fragmentname” 来指定片段名称
- id:HTML的id选择器,使用时要在前面加上#号,不支持class选择器。
使用:
我们需要配合th属性中的(th:insert,th:replace,th:include)一起使用。
- th:insert:将代码块片段整个插入到使用了th:insert的HTML标签中
- th:replace:将代码块片段整个替换使用了th:replace的HTML标签中
- th:include:将代码块片段包含的内容插入到使用了th:include的HTML标签中
具体代码实现
<!--th:fragment定义代码块标识-->
<footer th:fragment="copy">
© 2019 The Good Thymes Virtual Grocery
</footer>
<!--三种不同的引入方式-->
<div th:insert="~{footer :: copy}"></div>
<div th:replace="~{footer :: copy}"></div>
<div th:include="~{footer :: copy}"></div>
2.3.2 #{…} 消息表达式
通常用于国际化处理,在不同的语言环境使用不同的语言文字
2.3.3 @{…} 链接表达式
链接表达式:不管是静态资源的引用,form表单的请求,凡是链接都可以用@{…} 。这样可以动态获取项目路径,即便项目名变了,依然可以正常访问。
#修改项目名,链接表达式会自动修改路径,避免资源文件找不到
server.context-path=/itdragon
- 无参:@{/xxx}
- 有参:@{/xxx(k1=v1,k2=v2)} 对应url结构:xxx?k1=v1&k2=v2
- 引入本地资源:@{/项目本地的资源路径}
- 引入外部资源:@{/webjars/资源在jar包中的路径}
<!--引入外部资源-->
<link th:href="@{/webjars/bootstrap/4.0.0/css/bootstrap.css}" rel="stylesheet">
<!--引入本地资源-->
<link th:href="@{/main/css/itdragon.css}" rel="stylesheet">
<!--表单提交路径-->
<form class="form-login" th:action="@{/user/login}" th:method="post" >
<!--超链接跳转路径附带参数-->
<a class="btn btn-sm" th:href="@{/login.html(l='zh_CN')}">中文</a>
<a class="btn btn-sm" th:href="@{/login.html(l='en_US')}">English</a>
2.3.4 ${…}变量表达式
变量表达式有丰富的内置方法,使其更强大,更方便。
变量表达式功能:
可以获取对象的属性和方法
可以使用ctx,vars,locale,request,response,session,servletContext内置对象
常用的内置对象:
- ctx :上下文对象。
- vars :上下文变量。
- locale:上下文的语言环境。
- request:(仅在web上下文)的 HttpServletRequest 对象。
- response:(仅在web上下文)的 HttpServletResponse 对象。
- session:(仅在web上下文)的 HttpSession 对象。
- servletContext:(仅在web上下文)的 ServletContext 对象
2.4 常用属性
html有的属性,Thymeleaf基本都有,而常用的属性大概有七八个。其中th属性执行的优先级从1~8,数字越低优先级越高。
- th:text :设置当前元素的文本内容,相同功能的还有th:utext,两者的区别在于前者不会转义html标签,后者会。优先级不高:order=7
- th:value:设置当前元素的value值,通常用在表单中,类似修改指定属性的还有th:src,th:href。优先级不高:order=6
- th:each:遍历循环元素,和th:text或th:value一起使用。注意该属性修饰的标签位置,详细往后看。优先级很高:order=2
- th:if:条件判断,类似的还有th:unless,th:switch,th:case。优先级较高:order=3
- th:insert:代码块引入,类似的还有th:replace,th:include,三者的区别较大,若使用不恰当会破坏html结构,常用于公共代码块提取的场景。优先级最高:order=1
- th:fragment:定义代码块,方便被th:insert引用。优先级最低:order=8
- th:object:声明变量,一般和*{}一起配合使用,达到偷懒的效果。优先级一般:order=4
- th:attr:修改任意属性,实际开发中用的较少,因为有丰富的其他th属性帮忙,类似的还有th:attrappend,th:attrprepend。优先级一般:order=5
使用Thymeleaf属性需要注意点以下五点:
- 若要使用Thymeleaf语法,首先要声明名称空间: xmlns:th=“http://www.thymeleaf.org”
- 设置文本内容 th:text,设置input的值 th:value,循环输出 th:each,条件判断 th:if,插入代码块 th:insert,定义代码块 th:fragment,声明变量 th:object
- th:each 的用法需要格外注意,打个比方:如果你要循环一个div中的p标签,则th:each属性必须放在p标签上。若你将th:each属性放在div上,则循环的是将整个div。
- 变量表达式中提供了很多的内置方法,该内置方法是用#开头,请不要与#{}消息表达式弄混。
- th:insert,th:replace,th:include 三种插入代码块的效果相似,但区别很大。
案例
向域中添加数据
@Controller
@RequestMapping("/user2")
public class UserContoller2 {
@Autowired
private UserService service;
@RequestMapping(value = "/list",method = RequestMethod.GET)
public String getUserList(Model model){
model.addAttribute(service.findUserList());
return "userlist";
}
}
2.4.1 th:text和th:value
<body>
<h1>this is success.html</h1>
<!--th:text 设置当前元素的文本内容,常用,优先级不高-->
<p th:text="${msg}"></p>
<p th:utext="${msgUtext}"></p>
<!--th:value 设置当前元素的value值,常用,优先级仅比th:text高-->
姓名:<input type="text" th:value="${emp.name}" />
年龄:<input type="text" th:value="${emp.age}" />
</body>
2.4.2 th:each
<body>
<h1>this is success.html</h1>
<!--th:each 遍历列表,常用,优先级很高,仅此于代码块的插入,遍历被修饰的元素-->
<table border="1px" th:width="200px">
<thead>
<tr>
<th>编号</th>
<th>姓名</th>
<th>年龄</th>
<th>操作</th>
</tr>
</thead>
<tbody>
<tr th:each="e:${emps}">
<td>编号</td>
<td th:text="${e.name}"></td>
<td th:text="${e.age}"></td>
<td>删除/修改</td>
</tr>
</tbody>
<tbody>
<tr th:each="e,eState:${emps}">
<td th:text="${eState.index+1}"></td>
<td th:text="${e.name}"></td>
<td th:text="${e.age}"></td>
<td>删除/修改</td>
</tr>
</tbody>
</table>
说明:
th:each=“e,eState : ${emps}”
其中e为循环的每一项,eState是下标属性(可省略),eState属性包括:
index:列表状态的序号,从0开始;
count:列表状态的序号,从1开始;
size:列表状态,列表数据条数;
current:列表状态,当前数据对象
even:列表状态,是否为奇数,boolean类型
odd:列表状态,是否为偶数,boolean类型
first:列表状态,是否为第一条,boolean类型
last:列表状态,是否为最后一条,boolean类型
2.4.3 th:if
<!--th:if 条件判断,类似的有th:switch,th:case,优先级仅次于th:each,-->
<p th:text="${map.Boss.name}" th:if="${map.Boss.age gt 20}"></p>
其中关系运算:
gt:great than(大于)
ge:great equal(大于等于)
eq:equal(等于)
lt:less than(小于)
le:less equal(小于等于)
ne:not equal(不等于)