从JSP快速过渡到Thymeleaf，你要掌握的Thymeleaf语法

背景介绍

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

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

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

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

Thymeleaf

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

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

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

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

文章目录

从JSP快速过渡到Thymeleaf，你要掌握的Thymeleaf语法

快速开始
变量
方法
Thymeleaf内置对象：
字面值
拼接
运算
循环
逻辑判断
Thymeleaf中JS的使用

快速开始

使用spring脚手架搭建环境

pom.xml:

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.7.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.junsir</groupId>
    <artifactId>testthymeleaf</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>testthymeleaf</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <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>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

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

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

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

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

创建Controller：

@Controller
public class HelloController {

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

准备html：

注意：spring boot自动帮我们配置了视图解析器Resolver

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

默认前缀：classpath:/templates/

默认后缀：.html

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" 会有语法提示

启动项目，访问：

Thymeleaf的主要作用是把model中的数据渲染到html中，因此其语法主要是如何解析model中的数据

变量

Thymeleaf通过${}来获取model中的变量，注意这不是el表达式，而是ognl表达式，但是语法非常像
<h1>
 欢迎您：请登录
</h1>
 model.addAttribute("user", user);
 return "show2";
动静结合:

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

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

静态页面中，th指令不被识别，但是浏览器也不会报错，把它当做一个普通属性处理。这样span的默认值请登录就会展现在页面

如果是在Thymeleaf环境下，th指令就会被识别和解析，而th:text的含义就是替换所在标签中的文本内容，于是user.name的值就替代了 span中默认值

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

向下兼容:

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

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

escape：

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

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

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

ognl表达式的语法糖：

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

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

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

方法

ognl表达式中的方法调用：

ognl表达式本身就支持方法调用，例如：
<h2 th:object="${user}">
 FirstName: Jack.
 LastName: Li.
</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集合的方法

举例

我们在环境变量中添加日期类型对象
model.addAttribute("today", new Date());
在页面中处理

 今天是: 2018-04-25

对象	作用
`#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集合的方法

字面值

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

字符串字面值

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

 你正在学习 template 的字符串常量值.

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

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

拼接

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

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

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

运算

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

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


比较运算

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

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

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

三元运算

三元运算符的三个部分：conditon ? then : else
condition：条件
then：条件成立的结果
else：不成立的结果
其中的每一个部分都可以是Thymeleaf中的任意表达式

默认值

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

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

注意：?:之间没有空格

循环

循环也是非常频繁使用的需求，我们使用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值

逻辑判断

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

Thymeleaf中使用th:if 或者 th:unless ，两者的意思恰好相反
小鲜肉
如果表达式的值为true，则标签会渲染到页面，否则不进行渲染。

以下情况被认定为true：

表达式值为true

表达式值为非0数值

表达式值为非0字符

表达式值为字符串，但不是"false","no","off"

表达式不是布尔、字符串、数字、字符中的任何一种

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

Thymeleaf中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代码也不会报错，而是采用表达式后面跟着的默认值

JunSIr_deCp

原创文章 208 获赞 165 访问量 14万+

关注私信

从JSP快速过渡到Thymeleaf，你要掌握的Thymeleaf语法

从JSP快速过渡到Thymeleaf，你要掌握的Thymeleaf语法

文章目录

快速开始

变量

方法

Thymeleaf内置对象：

字面值

拼接

运算

循环

逻辑判断

Thymeleaf中JS的使用

猜你喜欢