17Spring Boot整合Thymeleaf

爱吃面的猫

已于 2023-09-08 17:39:10 修改

阅读量336

点赞数

分类专栏： springboot

于 2022-09-29 15:36:00 首次发布

本文链接：https://blog.csdn.net/qq_41946216/article/details/127107957

版权

SpringBoot Thymeleaf 模板引擎自动配置 ThymeleafProperties

关键词由CSDN通过智能技术生成

springboot 专栏收录该内容

25 篇文章 14 订阅

订阅专栏

Spring Boot 推荐使用 Thymeleaf 作为其模板引擎。SpringBoot 为 Thymeleaf 提供了一系列默认配置，项目中一但导入了 Thymeleaf 的依赖，相对应的自动配置（ThymeleafAutoConfiguration）就会自动生效，因此 Thymeleaf 可以与 Spring Boot 完美整合。

Thymeleaf的详细介绍参考：

Spring Boot 整合 Thymeleaf 模板引擎，需要以下步骤：

引入 Starter 依赖
创建模板文件，并放在在指定目录下

引入依赖

Spring Boot 整合 Thymeleaf 的第一步，就是在项目的 pom.xml 中添加 Thymeleaf 的 Starter 依赖，或者创建项目时候选择 Thymeleaf 代码如下。

<!--Thymeleaf 启动器-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

创建模板文件

1. 创建一个名为 login.html 的页面，并将该页面放在项目类路径（resources）下的 templates 目录中，login.html 代码如下。

注意：如果使用 Thymeleaf ，则必须引入 xmlns:th="http://www.thymeleaf.org"

<!DOCTYPE html>
<!--导入thymeleaf的名称空间-->
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<!--th:text 为 Thymeleaf 属性，用于获取指定属性的值-->
<h1 th:text="'欢迎来到'+${name}"></h1>
</body>
</html>

2.新建一个控制类 HelloController，并通过参数 map 传递数据到前台页面中，代码如下。

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import java.util.Map;
@Controller
public class HelloController {
    @RequestMapping("/login")
    public String login(Map<String, Object> map) {
        //通过 map 向前台页面传递数据
        map.put("name", "人人爱编程网站");
        return "login";
    }
}

3. 启动 Spring Boot，使用浏览器访问“http://localhost:8080/login”，结果如下图。

Spring Boot 自动配置Thymeleaf原理

SpringBoot通过 ThymeleafAutoConfiguration 自动配置类，为对 Thymeleaf 提供了一整套的自动化配置方案，该自动配置类的部分源码如下。

@Configuration(
    proxyBeanMethods = false
)
@EnableConfigurationProperties({ThymeleafProperties.class})
@ConditionalOnClass({TemplateMode.class, SpringTemplateEngine.class})
@AutoConfigureAfter({WebMvcAutoConfiguration.class, WebFluxAutoConfiguration.class})
public class ThymeleafAutoConfiguration {
}

ThymeleafAutoConfiguration 使用 @EnableConfigurationProperties 注解导入了 ThymeleafProperties 类，该类包含了与 Thymeleaf 相关的自动配置属性，其部分源码如下。

@ConfigurationProperties(
    prefix = "spring.thymeleaf"
)
public class ThymeleafProperties {
    private static final Charset DEFAULT_ENCODING;
    public static final String DEFAULT_PREFIX = "classpath:/templates/";
    public static final String DEFAULT_SUFFIX = ".html";
    private boolean checkTemplate = true;
    private boolean checkTemplateLocation = true;
    private String prefix = "classpath:/templates/";
    private String suffix = ".html";
    private String mode = "HTML";
    private Charset encoding;
    private boolean cache;
...
}

ThymeleafProperties 通过 @ConfigurationProperties 注解将配置文件（application.properties/yml）中前缀为 spring.thymeleaf 的配置和这个类中的属性绑定。

在 ThymeleafProperties 中还提供了以下静态变量：