Thymeleaf 模板引擎

迷南。 2022-12-08 15:51 205阅读 0赞

# 一、前言 #

前端交给我们的页面，是html页面。如果是我们以前开发，我们需要把他们转成jsp页面，jsp好处就是当我们查出一些数据转发到JSP页面以后，我们可以用jsp轻松实现数据的显示及交互等。

jsp支持非常强大的功能，包括能写Java代码。

**但是**

SpringBoot这个项目首先是以jar的方式，不是war，第二，**嵌入式的Tomcat，默认是不支持jsp的。**

--------------------

# **二、SpringBoot推荐你可以来使用模板引擎：** #

模板引擎，其实jsp就是一个模板引擎，还有用的比较多的freemarker，包括SpringBoot给我们推荐的Thymeleaf，模板引擎有非常多，但再多的模板引擎，他们的思想都是一样的。

模板引擎用来写一个**页面模板**，后台封装一些**动态数据**。

把这个模板和这个数据交给我们模板引擎，模板引擎按照我们这个数据帮你把这表达式解析、填充到我们指定的位置，然后把这个数据最终生成一个我们想要的内容给我们写出去，这就是我们这个模板引擎，不管是jsp还是其他模板引擎，都是这个思想。

不同模板引擎之间，语法有点不一样。

SpringBoot给我们推荐的Thymeleaf模板引擎，其是一个高级语言的模板引擎，语法更简单，功能更强大。

--------------------

# 三、引入Thymeleaf #

Thymeleaf 官网：https://www.thymeleaf.org/

Thymeleaf 在Github 的主页：https://github.com/thymeleaf/thymeleaf

Spring官方文档：找到我们对应的版本

https://docs.spring.io/spring-boot/docs/2.2.5.RELEASE/reference/htmlsingle/\#using-boot-starter

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

--------------------

# 四、SpringBoot的自动配置原理 #

Thymeleaf的自动配置类：ThymeleafProperties

@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;
    }

我们只需要把我们的html页面放在类路径下的templates下，thymeleaf就可以帮我们自动渲染了。

--------------------

# 五、测试 #

Thymeleaf 官网：https://www.thymeleaf.org/

*  1、编写一个TestController

@Controller
    public class TestController { 
        
        @RequestMapping("/t1")
        public String test1(Model model){ 
            //存入数据
            model.addAttribute("msg","Hello,Thymeleaf");
            
            //classpath:/templates/test.html
            return "test";
        }
        
    }

*  2、编写一个测试页面 test.html 放在 templates 目录下

xmlns:th="http://www.thymeleaf.org"

我们要使用thymeleaf，需要在html文件中导入命名空间的约束，方便提示。

<!DOCTYPE html>
    <html lang="en" xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        <title>Title</title>
    </head>
    <body>
        <h1>测试页面</h1>
        
        
        <div th:text="${msg}"></div>
    </body>
    </html>

*  3、启动服务

--------------------

# 六、语法举例 #

Variable Expressions: ${ ...}：获取变量值；
    Selection Variable Expressions: *{ ...}：选择表达式：和${ }在功能上是一样；
    Message Expressions: #{ ...}：获取国际化内容
    Link URL Expressions: @{ ...}：定义URL；
    Fragment Expressions: ~{ ...}：片段引用表达式