Springboot模板引擎之 Thymeleaf使用

最新推荐文章于 2024-12-21 11:45:00 发布

S_L__

最新推荐文章于 2024-12-21 11:45:00 发布

阅读量569

点赞数

本文链接：https://blog.youkuaiyun.com/S_L__/article/details/105617609

版权

springboot 相关专栏收录该内容

15 篇文章

订阅专栏

文章详细介绍了Thymeleaf的特点，如动静结合、开箱即用和多语言支持，并展示了如何在SpringBoot项目中导入和配置Thymeleaf。通过基本使用、语法示例，包括获取对象、调用方法、内置对象的使用、字面值、拼接、运算、循环、逻辑判断以及JS模板等，全面阐述了Thymeleaf在实际开发中的应用。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Springboot模板引擎之 Thymeleaf使用

一、Thymeleaf特点

动静结合：Thymeleaf 在有网络和无网络的环境下皆可运行，即它可以让美工在浏览器查看页面的静态效果，也可以让程序员在服务器查看带数据的动态页面效果。这是由于它支持 html 原型，然后在 html 标签里增加额外的属性来达到模板+数据的展示方式。浏览器解释 html 时会忽略未定义的标签属性，所以 thymeleaf 的模板可以静态地运行；当有数据返回到页面时，Thymeleaf 标签会动态地替换掉静态内容，使页面动态显示。

开箱即用：它提供标准和spring标准两种方言，可以直接套用模板实现JSTL、 OGNL表达式效果，避免每天套模板、该jstl、改标签的困扰。同时开发人员也可以扩展和创建自定义的方言。

多方言支持：Thymeleaf 提供spring标准方言和一个与 SpringMVC 完美集成的可选模块，可以快速的实现表单绑定、属性编辑器、国际化等功能。

与SpringBoot完美整合，SpringBoot提供了Thymeleaf的默认配置，并且为Thymeleaf设置了视图解析器，我们可以像以前操作jsp一样来操作Thymeleaf。代码几乎没有任何区别，就是在模板语法上有区别。

二、导包

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

该框架的 ThymeleafProperties 类，定义的默认的访问前缀和后缀。

以上默认配置可在配置文件中修改（一般不改），如下：

# 页面默认前缀目录
#spring.mvc.view.prefix=/WEB-INF/views/
# 响应页面默认后缀
#spring.mvc.view.suffix=.jsp

三、基本使用

controller层：

前端页面位置及内容：

此处注意2点：①根据默认配置放在templates下；

② 添加 xmlns:th="http://www.thymeleaf.org" ，下面才能使用Thymeleaf模板语法

测试访问：http://localhost:8086/login/login/index

四、使用语法

1.获取对象

方式一：原始方式（写法麻烦）

<h2>
    <p>Name: <span th:text="${user.name}">Jack</span>.</p>
    <p>Age: <span th:text="${user.age}">21</span>.</p>
    <p>friend: <span th:text="${user.friend.name}">Rose</span>.</p>
</h2>

方式二：Thymeleaf方式，可省去前缀

<h2 th:object="${user}">
    <p>Name: <span th:text="*{name}">Jack</span>.</p>
    <p>Age: <span th:text="*{age}">21</span>.</p>
    <p>friend: <span th:text="*{friend.name}">Rose</span>.</p>
</h2>

2.调用方法

<h2 th:object="${user}">
    <p>FirstName: <span th:text="*{name.split(' ')[0]}">Jack</span>.</p>
    <p>LastName: <span th:text="*{name.split(' ')[1]}">Li</span>.</p>
</h2>

3.内置对象

环境对象：

对象	作用
`#ctx`	获取Thymeleaf自己的Context对象
`#requset`	如果是web程序，可以获取HttpServletRequest对象
`#response`	如果是web程序，可以获取HttpServletReponse对象
`#session`	如果是web程序，可以获取HttpSession对象
`#servletContext`	如果是web程序，可以获取HttpServletContext对象

全局对象：

对象	作用
`#dates`	处理java.util.date的工具对象
`#calendars`	处理java.util.calendar的工具对象
`#numbers`	用来对数字格式化的方法
`#strings`	用来处理字符串的方法
`#bools`	用来判断布尔值的方法
`#arrays`	用来护理数组的方法
`#lists`	用来处理List集合的方法
`#sets`	用来处理set集合的方法
`#maps`	用来处理map集合的方法

使用如下：

controller:

@GetMapping("test3")
public String show3(Model model){
    model.addAttribute("today", new Date());
    return "hello3";
}

页面处理：

<p>
  今天是: <span th:text="${#dates.format(today,'yyyy-MM-dd')}">2018-04-25</span>
</p>

4.字面值

不希望被Thymeleaf解析为变量，写什么就是什么，如：字符串、数值、布尔等。

字符串字面值

使用一对'引用的内容就是字符串字面值了：
```

 你正在观看 template 的字符串常量值.

```
th:text中的thymeleaf并不会被认为是变量，而是一个字符串
数字字面值

数字不需要任何特殊语法，写的什么就是什么，而且可以直接进行算术运算
```
今年是 1900.
两年后将会是 1902.
```
布尔字面值

布尔类型的字面值是true或false：
```
<div th:if="true">
 你填的是true
</div>
```
这里引用了一个th:if指令，跟vue中的v-if类似

5.拼接

我们经常会用到普通字符串与表达式拼接的情况：

<span th:text="'欢迎您:' + ${user.name} + '!'"></span>

字符串字面值需要用''，拼接起来非常麻烦，Thymeleaf对此进行了简化，使用一对|即可：

<span th:text="|欢迎您:${user.name}|"></span>

6.运算

算术运算 + - * / %

<span th:text="${user.age}"></span>         //21
<span th:text="${user.age}%2 == 0"></span>  //false

比较运算

支持的比较运算：>, <, >= and <= ，但是>, <不能直接使用，因为xml会解析为标签，要使用别名。

注意 == and !=不仅可以比较数值，类似于equals的功能。

可以使用的别名：gt (>), lt (<), ge (>=), le (<=), not (!). Also eq (==), neq/ne (!=).

条件运算

三元运算

<span th:text="${user.sex} ? '男':'女'"></span>

默认值

有的时候，我们取一个值可能为空，这个时候需要做非空判断，可以使用 表达式 ?: 默认值简写：

<span th:text="${user.name} ?: '二狗'"></span>

当前面的表达式值为null时，就会使用后面的默认值。

注意：?:之间没有空格。

7.循环

循环也是非常频繁使用的需求，我们使用th:each指令来完成：

假如有用户的集合：users在Context中。

<tr th:each="user : ${users}">
    <td th:text="${user.name}">Onions</td>
    <td th:text="${user.age}">2.41</td>
</tr>

${users} 是要遍历的集合，可以是以下类型：
- Iterable，实现了Iterable接口的类
- Enumeration，枚举
- Interator，迭代器
- Map，遍历得到的是Map.Entry
- Array，数组及其它一切符合数组结果的对象

在迭代的同时，我们也可以获取迭代的状态对象：

<tr th:each="user,stat : ${users}">
    <td th:text="${user.name}">Onions</td>
    <td th:text="${user.age}">2.41</td>
</tr>

stat对象包含以下属性：

index，从0开始的角标
count，元素的个数，从1开始
size，总元素个数
current，当前遍历到的元素
even/odd，返回是否为奇偶，boolean值
first/last，返回是否为第一或最后，boolean值

8.逻辑判断

有了if和else，我们能实现一切功能^_^。

Thymeleaf中使用th:if 或者 th:unless ，两者的意思恰好相反。

<span th:if="${user.age} > 24">老油条</span>

如果表达式的值为true，则标签会渲染到页面，否则不进行渲染。

以下情况被认定为true：

表达式值为true
表达式值为非0数值
表达式值为非0字符
表达式值为字符串，但不是"false","no","off"
表达式不是布尔、字符串、数字、字符中的任何一种

其它情况包括null都被认定为false

9.分支控制switch

这里要使用两个指令：th:switch 和 th:case

<div th:switch="${user.role}">
  <p th:case="'admin'">用户是管理员</p>
  <p th:case="'manager'">用户是经理</p>
  <p th:case="*">用户是别的玩意</p>
</div>

需要注意的是，一旦有一个th:case成立，其它的则不再判断。与java中的switch是一样的。

另外th:case="*"表示默认，放最后。

10.JS模板

模板引擎不仅可以渲染html，也可以对JS中的进行预处理。而且为了在纯静态环境下可以运行，其Thymeleaf代码可以被注释起来：

<script th:inline="javascript">
    const user = /*[[${user}]]*/ {};
    const age = /*[[${user.age}]]*/ 20;
    console.log(user);
    console.log(age)
</script>

在script标签中通过th:inline="javascript"来声明这是要特殊处理的js脚本
语法结构：
```
const user = /*[[Thymeleaf表达式]]*/ "静态环境下的默认值";
```
因为Thymeleaf被注释起来，因此即便是静态环境下， js代码也不会报错，而是采用表达式后面跟着的默认值。且User对象会被直接处理为json格式。