Thymeleaf

Thymeleaf是适用于Web和独立环境的现代服务器端Java模板引擎。Thymeleaf的主要目标是为您的开发工作流程带来优雅的自然模板-可以在浏览器中正确显示的HTML，也可以用作静态原型，从而在开发团队中实现更强大的协作。

快速开始

在Spring Boot中使用thymeleaf模板需要引入依赖，可以在创建项目工程时勾选Thymeleaf，也可以创建之后再手动导入，如下：

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

另外，在html页面上如果要使用thymeleaf模板，需要在页面标签中引入：

<html xmlns:th="http://www.thymeleaf.org">

因为Thymeleaf中已经有默认的配置了，我们不需要再对其做过多的配置，有一个需要注意一下，Thymeleaf默认是开启页面缓存的，所以在开发的时候，需要关闭这个页面缓存，配置如下。

spring:
  thymeleaf:
    cache: false #关闭缓存

否则会有缓存，导致页面没法及时看到更新后的效果。比如你修改了一个文件，已经update到tomcat了，但刷新页面还是之前的页面，就是因为缓存引起的。

访问静态页面

这个和Thymeleaf没啥关系，应该说是通用的，我把它一并写到这里的原因是一般我们做网站的时候，都会做一个404页面和500页面，为了出错时给用户一个友好的展示，而不至于一堆异常信息抛出来。Spring Boot中会自动识别模板目录（templates/）下的404.html和500.html文件。我们在templates/目录下新建一个error文件夹，专门放置错误的html页面，然后分别打印些信息。以404.html为例：

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>Title</title>
  </head>
  <body>
    这是404页面
  </body>
</html>

我们再写一个controller来测试一下404和500页面：

@Controller
@RequestMapping("/thymeleaf")
public class ThymeleafController {
    @RequestMapping("/test404")
    public String test404() {
        return "index";
    }
    @RequestMapping("/test500")
    public String test500() {
        int i = 1 / 0;
        return "index";
    }
}

当我们在浏览器中输入localhost:8080/thymeleaf/test400时，故意输入错误，找不到对应的方法，就会跳转到404.html显示。当我们在浏览器中输入localhost:8088/thymeleaf/test505时，会抛出异常，然后会自动跳转到500.html显示。

Thymeleaf中处理对象

我们来看一下thymeleaf模板中如何处理对象信息，假如我们在做个人博客的时候，需要给前端传博主相关信息来展示，那么我们会封装成一个博主对象，比如：


public class Blogger {
    private Long id;
    private String name;
    private String pass;
	// 省去set和get
}

然后在controller层中初始化一下：


@GetMapping("/getBlogger")
public String getBlogger(Model model) {
	Blogger blogger = new Blogger(1L, "xxx", "123456");
	model.addAttribute("blogger", blogger);
	return "blogger";
}

我们先初始化一个Blogger对象，然后将该对象放到Model中，然后返回到blogger.html页面去渲染。接下来我们再写一个blogger.html来渲染blogger信息：

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
  <html lang="en">
    <head>
      <meta charset="UTF-8" />
      <title>博主信息</title>
    </head>
    <body>
      <form action="" th:object="${blogger}">
        用户编号：<input name="id" th:value="${blogger.id}" /><br />
        用户姓名：<input
          type="text"
          name="username"
          th:value="${blogger.getName()}"
        /><br />
        登陆密码：<input type="text" name="password" th:value="*{pass}" />
      </form>
    </body>
  </html>
</html>

可以看出，在thymeleaf模板中，使用th:object="${}"来获取对象信息，然后在表单里面可以有三种方式来获取对象属性。如下：

使用 th:value="*{属性名}"
使用th:value="${对象.属性名}"，对象指的是上面使用th:object获取的对象
使用th:value="${对象.get方法}"，对象指的是上面使用th:object获取的对象

Thymeleaf中处理List

处理List的话，和处理上面介绍的对象差不多，但是需要在thymeleaf中进行遍历。我们先在Controller中模拟一个List。

@GetMapping("/getList")
public String getList(Model model) {
    Blogger blogger1 = new Blogger(1L, "xxx", "123456");
    Blogger blogger2 = new Blogger(2L, "达人课", "123456");
    List<Blogger> list = new ArrayList<>();
    list.add(blogger1);
    list.add(blogger2);
    model.addAttribute("list", list);
    return "list";
}

接下来我们写一个list.html来获取该list信息，然后在list.html中遍历这个list。如下：

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>博主信息</title>
</head>
<body>
<form action="" th:each="blogger : ${list}" >
    用户编号：<input name="id" th:value="${blogger.id}"/><br>
    用户姓名：<input type="text" name="password" th:value="${blogger.name}"/><br>
    登录密码：<input type="text" name="username" th:value="${blogger.getPass()}"/>
</form>
</body>
</html>

可以看出，其实和处理单个对象信息差不多，Thymeleaf使用 th:each 进行遍历，${} 取model中传过来的参数，然后自定义list中取出来的每个对象，这里定义为blogger。表单里面可以直接使用 ${对象.属性名} 来获取list中对象的属性值，也可以使用 ${对象.get方法} 来获取，这点和上面处理对象信息是一样的，但是不能使用 *{属性名} 来获取对象中的属性，thymeleaf模板获取不到。

最近更新于0001-01-01