thymeleaf语法入门

最新推荐文章于 2022-03-07 13:28:25 发布
最新推荐文章于 2022-03-07 13:28:25 发布
阅读量284 收藏
点赞数
分类专栏： thymeleaf 文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Marion158/article/details/105620540
版权

1.Thymeleaf简介

官方网站：https://www.thymeleaf.org/index.html

Thymeleaf是用来开发Web和独立环境项目的现代服务器端Java模板引擎。

Thymeleaf的主要目标是为您的开发工作流程带来优雅的自然模板 - HTML。可以在直接浏览器中正确显示，并且可以作为静态原型，从而在开发团队中实现更强大的协作。

借助Spring Framework的模块，可以根据自己的喜好进行自由选择，可插拔功能组件，Thymeleaf是现代HTML5 JVM Web开发的理想选择 - 尽管它可以做的更多。

Spring官方支持的服务的渲染模板中，并不包含jsp。而是Thymeleaf和Freemarker等，而Thymeleaf与SpringMVC的视图技术，及SpringBoot的自动化配置集成非常完美，几乎没有任何成本，你只用关注Thymeleaf的语法即可。

2.特点

特点：

  • 动静结合：Thymeleaf 在有网络和无网络的环境下皆可运行，即它可以让美工在浏览器查看页面的静态效果，也可以让程序员在服务器查看带数据的动态页面效果。这是由于它支持 html 原型，然后在 html 标签里增加额外的属性来达到模板+数据的展示方式。浏览器解释 html 时会忽略未定义的标签属性，所以 thymeleaf 的模板可以静态地运行；当有数据返回到页面时，Thymeleaf 标签会动态地替换掉静态内容，使页面动态显示。
  • 开箱即用：它提供标准和spring标准两种方言，可以直接套用模板实现JSTL、 OGNL表达式效果，避免每天套模板、该jstl、改标签的困扰。同时开发人员也可以扩展和创建自定义的方言。
  • 多方言支持：Thymeleaf 提供spring标准方言和一个与 SpringMVC 完美集成的可选模块，可以快速的实现表单绑定、属性编辑器、国际化等功能。
  • 与SpringBoot完美整合，SpringBoot提供了Thymeleaf的默认配置，并且为Thymeleaf设置了视图解析器，我们可以像以前操作jsp一样来操作Thymeleaf。代码几乎没有任何区别，就是在模板语法上有区别。

3.环境准备

我们来创建一个module，为学习Thymeleaf做准备：

3.1.创建module

使用spring 脚手架创建：

在这里插入图片描述

在这里插入图片描述

勾选web和Thymeleaf的依赖：

在这里插入图片描述

项目结构：
在这里插入图片描述

pom：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.leyou.demo</groupId>
    <artifactId>thymeleaf-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>thymeleaf-demo</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.2.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

3.2.默认配置

不需要做任何配置，启动器已经帮我们把Thymeleaf的视图器配置完成：

在这里插入图片描述

而且，还配置了模板文件（html）的位置，与jsp类似的前缀+ 视图名 + 后缀风格：

在这里插入图片描述

  • 默认前缀：classpath:/templates/
  • 默认后缀：.html

所以如果我们返回视图：users，会指向到 classpath:/templates/users.html

Thymeleaf默认会开启页面缓存，提高页面并发能力。但会导致我们修改页面不会立即被展现，因此我们关闭缓存：

# 关闭Thymeleaf的缓存
spring.thymeleaf.cache=false

另外，修改完毕页面，需要使用快捷键：Ctrl + Shift + F9来刷新工程。

3.3.快速开始

我们准备一个controller，控制视图跳转：

@Controller
public class HelloController {

    @GetMapping("show1")
    public String show1(Model model){
        model.addAttribute("msg", "Hello, Thymeleaf!");
        return "hello";
    }
}

新建一个html模板：

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>hello</title>
</head>
<body>
    <h1 th:text="${msg}">大家好</h1>
</body>
</html>

注意，把html 的名称空间，改成：xmlns:th="http://www.thymeleaf.org" 会有语法提示

启动项目，访问页面：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-rankJ7hw-1587295756454)(assets/1526436248528.png)]

4.语法

Thymeleaf的主要作用是把model中的数据渲染到html中，因此其语法主要是如何解析model中的数据。从以下方面来学习：

  • 变量
  • 方法
  • 条件判断
  • 循环
  • 运算
    • 逻辑运算
    • 布尔运算
    • 比较运算
    • 条件运算
  • 其它

4.1.变量

变量案例

我们先新建一个实体类：User

package com.example.demo.pojo;

public class User {
    String name;
    int age;
    boolean sex;
    // 对象类型属性
    User friend;
    String role;

    public String getRole() {
        return role;
    }

    public void setRole(String role) {
        this.role = role;
    }

    public boolean isSex() {
        return sex;
    }

    public void setSex(boolean sex) {
        this.sex = sex;
    }
    public User(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public User() {

    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public User getFriend() {
        return friend;
    }

    public void setFriend(User friend) {
        this.friend = friend;
    }
}

然后在模型中添加数据

@GetMapping("show2")
public String show2(Model model){
    User user = new User();
    user.setAge(21);
    user.setName("Jack Chen");
    user.setFriend(new User("李小龙", 30));

    model.addAttribute("user", user);
    return "show2";
}

语法说明：

Thymeleaf通过${}来获取model中的变量，注意这不是el表达式，而是ognl表达式，但是语法非常像。

示例：

我们在页面获取user数据：

<h1>
    欢迎您：<span th:text="${user.name}">请登录</span>
</h1>

效果：

在这里插入图片描述

感觉跟el表达式几乎是一样的。不过区别在于，我们的表达式写在一个名为：th:text的标签属性中，这个叫做指令

动静结合

指令：

Thymeleaf崇尚自然模板，意思就是模板是纯正的html代码，脱离模板引擎，在纯静态环境也可以直接运行。现在如果我们直接在html中编写 ${}这样的表达式，显然在静态环境下就会出错，这不符合Thymeleaf的理念。

Thymeleaf中所有的表达式都需要写在指令中，指令是HTML5中的自定义属性，在Thymeleaf中所有指令都是以th:开头。因为表达式${user.name}是写在自定义属性中，因此在静态环境下，表达式的内容会被当做是普通字符串，浏览器会自动忽略这些指令，这样就不会报错了！

现在，我们不经过SpringMVC，而是直接用浏览器打开页面看看：

在这里插入图片描述如果有弹出这个，需要手动修改一下idea设置
进入 File > setting > Build > Debugger 的 Allow unsigned requests 打钩就可以解决这个问题
在这里插入图片描述
设置完成后重新打开http://localhost:63342/thymeleafDemo/templates/show2.html

在这里插入图片描述

  • 静态页面中，th指令不被识别，但是浏览器也不会报错，把它当做一个普通属性处理（显示标签默认值）。这样span的默认值请登录就会展现在页面
  • 如果是在Thymeleaf环境下，th指令就会被识别和解析，而th:text的含义就是替换所在标签中的文本内容，于是user.name的值就替代了 span中默认的请登录

指令的设计，正是Thymeleaf的高明之处，也是它优于其它模板引擎的原因。动静结合的设计，使得无论是前端开发人员还是后端开发人员可以完美契合。

向下兼容

但是要注意，如果浏览器不支持Html5怎么办？

如果不支持这种th:的命名空间写法，那么可以把th:text换成 data-th-text，Thymeleaf也可以兼容。

escape

另外，th:text指令出于安全考虑，会把表达式读取到的值进行处理，防止html的注入。

例如，<p>你好</p>将会被格式化输出为$lt;p$gt;你好$lt;/p$lt;。

如果想要不进行格式化输出，而是要输出原始内容，则使用th:utext来代替.

ognl表达式的语法糖

刚才获取变量值，我们使用的是经典的对象.属性名方式。但有些情况下，我们的属性名可能本身也是变量，怎么办？

ognl提供了类似js的语法方式：

例如：${user.name} 可以写作${user['name']}

4.2.自定义变量

场景

看下面的案例：

<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>

我们获取用户的所有信息，分别展示。

当数据量比较多的时候，频繁的写user.就会非常麻烦。

因此，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>
  • 首先在 h2上 用 th:object="${user}"获取user的值，并且保存
  • 然后，在h2内部的任意元素上，可以通过 *{属性名}的方式，来获取user中的属性，这样就省去了大量的user.前缀了

4.3.方法

ognl表达式中的方法调用

ognl表达式本身就支持方法调用，例如：

<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>
  • 这里我们调用了name（是一个字符串）的split方法。

Thymeleaf内置对象

Thymeleaf中提供了一些内置对象，并且在这些对象中提供了一些方法，方便我们来调用。获取这些对象，需要使用#对象名来引用。

  • 一些环境相关对象
对象作用
#ctx获取Thymeleaf自己的Context对象
#requset如果是web程序，可以获取HttpServletRequest对象
#response如果是web程序，可以获取HttpServletReponse对象
#session如果是web程序，可以获取HttpSession对象
#servletContext如果是web程序，可以获取HttpServletContext对象
  • Thymeleaf提供的全局对象：
对象作用
#dates处理java.util.date的工具对象
#calendars处理java.util.calendar的工具对象
#numbers用来对数字格式化的方法
#strings用来处理字符串的方法
#bools用来判断布尔值的方法
#arrays用来护理数组的方法
#lists用来处理List集合的方法
#sets用来处理set集合的方法
#maps用来处理map集合的方法
  • 举例

我们在环境变量中添加日期类型对象

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

在页面中处理

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

效果：

在这里插入图片描述

4.4 字面值

有的时候，我们需要在指令中填写基本类型如：字符串、数值、布尔等，并不希望被Thymeleaf解析为变量，这个时候称为字面值。

  • 字符串字面值

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

    <p>
  你正在观看 <span th:text="'thymeleaf'">template</span> 的字符串常量值.
</p>

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

在这里插入图片描述

  • 数字字面值

    数字不需要任何特殊语法， 写的什么就是什么，而且可以直接进行算术运算

    <p>今年是 <span th:text="2020">1900</span>.</p>
<p>两年后将会是 <span th:text="2020 + 2">1902</span>.</p>

在这里插入图片描述

  • 布尔字面值

    布尔类型的字面值是true或false：

    <div th:if="true">
    你填的是true
</div>

    这里引用了一个th:if指令，跟vue中的v-if类似

4.5 拼接

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

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

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

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

与上面是完全等效的，这样就省去了字符串字面值的书写。

在这里插入图片描述

4.6 运算

需要注意：${}内部的是通过OGNL表达式引擎解析的，外部的才是通过Thymeleaf的引擎解析，因此运算符尽量放在${}外进行。

  • 算术运算

    支持的算术运算符：+ - * / %

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

在这里插入图片描述

  • 比较运算

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

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

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

  • 条件运算

    • 三元运算
    <span th:text="${user.sex} ? '男':'女'"></span>

    三元运算符的三个部分：conditon ? then : else

    ​ condition：条件

    ​ then：条件成立的结果

    ​ else：不成立的结果

    其中的每一个部分都可以是Thymeleaf中的任意表达式。

在这里插入图片描述

  • 默认值

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

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

在控制层把user.setName给注释掉

// user.setName("Jack Chen");

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

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

在这里插入图片描述

4.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值

4.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

在这里插入图片描述

4.9 分支控制switch

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

    @GetMapping("show4")
    public String show4(Model model){
        User user = new User();
        user.setAge(21);
        user.setRole("admin");
        user.setFriend(new User("李小龙", 30));
        model.addAttribute("user", user);
        return "show4";
    }

<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="*"表示默认，放最后。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-N4PE2LVl-1587295756469)(assets/1526960621714.png)]

页面：

在这里插入图片描述

4.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格式了，非常方便。

控制台：

在这里插入图片描述

最后附上项目地址方便大家测试
https://gitee.com/marion1060/Thymeleaf

Marion158
关注
专栏目录
thymeleaf语法入门.md
03-08
thymeleaf语法入门，有兴趣的可以看一看
pycharm使用webdriver访问浏览器页面时，提示requested without authorization，不允许访问未认证的页面
qq_31931797的博客
10-06 530
pycharm使用webdriver访问浏览器页面时，提示requested without authorization，不允许访问未认证的页面 file-settings中勾选allow unsigned requests就可以解决了
Thymeleaf-如何获取model中的值
热门推荐
孟孟的博客
07-17 2万+
后台的实现： @RequestMapping("/adds") public String ProtaskAdd(Model model){ model.addAttribute("name","测试用例" ); return "protask/adds"; }    前端值的获取： 1、将model中的值赋给hidden，然后Js获取隐藏域的值。 /...
tomcat解决乱码问题
刘豪豪的博客
03-07 1239
出现的问题 07-Mar-2022 13:24:48.739 淇℃伅 [main] org.apache.catalina.core.AprLifecycleListener.lifecycleEvent 鍦╦ava.library.path:[E:\java\jdk1.8.0_152\bin;C:\WINDOWS\Sun\Java\bin;C:\WINDOWS\system32;C:\WINDOWS;D:\ProgramFile\VMware\VMware Workstation\bin\;C:\Prog
webstorm打开的页面如何通过手机访问？
wyz_666888的博客
11-22 5914
问 webstorm打开的页面如何通过手机访问？ 静态页面想用手机测试： 1勾选允许外部访问， Can accept external connections  （ 能接受外部连接） 2勾选 Allow unsigned  requests   （允许未签名的请求） 3你用手机连接你电脑wifi 然后在访问的时候把localhost改成你电脑ip然后访问这个页
thymeleaf语法入门.pdf
12-16
"Thymeleaf语法入门" Thymeleaf是现代服务器端Java模板引擎，主要目标是为开发工作流程带来优雅的自然模板 - HTML。Thymeleaf可以在直接浏览器中正确显示，并且可以作为静态原型，从而在开发团队中实现更强大的协作...
Thymeleaf案例入门和基本语法讲解
最新发布
09-16
三、基本语法 1. 变量表达式：`[[${expression}]]` 或 `{{expression}}` 这种表达式会将Java对象的属性值插入到HTML中，例如 `${user.name}` 获取用户对象的name属性。 2. 三元条件表达式：`[[${condition ? expr1...
Thymeleaf入门
09-11
创建模板文件，例如`templates/greeting.html`，并使用Thymeleaf语法： ```html <!DOCTYPE html> <html xmlns:th="http://www.thymeleaf.org"> , Thymeleaf!"> ${greeting}"> ``` 在你的控制器类中，注入`...
springboot项目访问html页面，发现端口不一致的解决方案
Clingcccc的博客
12-14 1万+
springboot项目前后端端口不一致，html页面端口是63342 在IDEA中用谷歌浏览器单独打开html页面后，发现页面的端口号为63342，与接口所写的8080端口不一致，因此无法连接网页,会报404异常。这个问题实际上并不是需要重新设置idea端口的问题，而是因为tomcat访问接口的时候默认端口号为8080，而idea运行页面的时候默认为63342。即在默认的静态资源过滤策略不能满足...
浏览器页面及后端页面都没报错，但是不显示内容？
长不大的大灰狼
08-16 5167
在做项目进行订单查询时时出现异常情况： （1）订单页面显示为空： （2）后台查找不出错误信息： Connected to server [2020-08-16 04:00:10,972] Artifact myCashier:war exploded: Artifact is being deployed, please wait... 16-Aug-2020 16:00:11.427 璀﹀憡 [RMI TCP Connection(2)-127.0.0.1] org.apache.tomcat.util
Thymeleaf
weixin_30690833的博客
04-08 125
1.Thymeleaf简介 官方网站：https://www.thymeleaf.org/index.html Thymeleaf是用来开发Web和独立环境项目的现代服务器端Java模板引擎。 Thymeleaf的主要目标是为您的开发工作流程带来优雅的自然模板 - HTML。可以在直接浏览器中正确显示，并且可以作为静态原型，从而在开发团队中实现更强大的协作。 借助Spring Framew...
thymeleaf一个奇葩的错误
lero524的博客
06-02 1042
之前项目遇到一个错误，记载一下，免得下次再出来。。。。 [2020-06-01 11:43:39 566] [DEBUG] org.springframework.web.servlet.DispatcherServlet(line/:910) -Could not complete request org.thymeleaf.exceptions.TemplateInputException: An error happened during template parsing (template: "Se
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值