Spring Boot与Thymeleaf集成教程

在现代Web开发中，模板引擎是将动态数据与HTML模板结合的重要工具。Spring Boot作为一个流行的Java框架，提供了对多种模板引擎的支持，其中Thymeleaf是最受欢迎的选择之一。本文将详细介绍如何在Spring Boot项目中集成Thymeleaf，并提供丰富的示例代码，帮助你深入理解其用法。

1. 什么是Thymeleaf？

Thymeleaf是一个现代的服务器端Java模板引擎，旨在为Web和独立环境提供优雅的模板。它的主要特点包括：

自然模板：Thymeleaf模板可以在浏览器中直接打开并呈现，便于前端开发人员进行设计。
表达式语言：Thymeleaf使用OGNL（Object-Graph Navigation Language）来访问对象属性，支持复杂的表达式。
国际化支持：内置国际化功能，方便多语言支持。
扩展性：可以通过自定义方言扩展Thymeleaf的功能。

优点

易于使用：Thymeleaf的语法简单直观，易于学习。
与Spring集成良好：Thymeleaf与Spring MVC的集成非常顺畅，支持Spring的各种特性。
支持多种视图：除了HTML，Thymeleaf还支持XML、JavaScript、CSS等多种格式。

缺点

性能问题：在高并发场景下，Thymeleaf的性能可能不如一些其他模板引擎。
学习曲线：虽然语法简单，但对于复杂的应用，可能需要深入学习其高级特性。

2. 创建Spring Boot项目

首先，我们需要创建一个Spring Boot项目。可以使用Spring Initializr（https://start.spring.io/）来快速生成项目。

2.1 选择依赖

在创建项目时，选择以下依赖：

Spring Web
Thymeleaf

2.2 项目结构

生成的项目结构大致如下：

src
└── main
    ├── java
    │   └── com
    │       └── example
    │           └── demo
    │               ├── DemoApplication.java
    │               └── controller
    │                   └── HomeController.java
    └── resources
        ├── static
        ├── templates
        │   └── home.html
        └── application.properties

3. 配置Thymeleaf

在application.properties文件中，通常不需要进行额外的配置，Thymeleaf会自动配置。你可以根据需要自定义一些属性，例如：

spring.thymeleaf.cache=false

将cache设置为false可以在开发过程中方便地查看模板的更改。

4. 创建控制器

在controller包中创建一个控制器类HomeController，用于处理请求并返回视图。

package com.example.demo.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class HomeController {

    @GetMapping("/")
    public String home(Model model) {
        model.addAttribute("message", "Hello, Thymeleaf!");
        return "home"; // 返回home.html视图
    }
}

4.1 代码解析

@Controller注解标识该类为控制器。
@GetMapping("/")注解映射根路径的GET请求。
Model对象用于传递数据到视图。
model.addAttribute("message", "Hello, Thymeleaf!")将数据添加到模型中。

5. 创建Thymeleaf模板

在templates目录下创建home.html文件，内容如下：

<!DOCTYPE html>
<html xmlns:th="http://www.w3.org/1999/xhtml">
<head>
    <title>Thymeleaf Example</title>
</head>
<body>
    <h1 th:text="${message}">Default Message</h1>
</body>
</html>

5.1 代码解析

xmlns:th声明了Thymeleaf的命名空间。
th:text="${message}"用于动态显示模型中的message属性。

6. 运行应用

在IDE中运行DemoApplication类，访问http://localhost:8080/，你应该能看到页面上显示“Hello, Thymeleaf!”。

7. 进阶用法

7.1 表单处理

Thymeleaf支持表单的创建和处理。以下是一个简单的表单示例。

7.1.1 创建表单模板

在templates目录下创建form.html文件：

<!DOCTYPE html>
<html xmlns:th="http://www.w3.org/1999/xhtml">
<head>
    <title>Thymeleaf Form Example</title>
</head>
<body>
    <form action="#" th:action="@{/submit}" th:object="${user}" method="post">
        <label for="name">Name:</label>
        <input type="text" id="name" th:field="*{name}" />
        <button type="submit">Submit</button>
    </form>
</body>
</html>

7.1.2 创建用户模型

创建一个简单的用户模型类：

package com.example.demo.model;

public class User {
    private String name;

    // Getter and Setter
    public String getName() {
        return name;
    }

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

7.1.3 更新控制器

在HomeController中添加处理表单的逻辑：

import com.example.demo.model.User;
import org.springframework.web.bind.annotation.PostMapping;

@Controller
public class HomeController {

    // ... existing code ...

    @GetMapping("/form")
    public String form(Model model) {
        model.addAttribute("user", new User());
        return "form"; // 返回form.html视图
    }

    @PostMapping("/submit")
    public String submit(@ModelAttribute User user, Model model) {
        model.addAttribute("message", "Hello, " + user.getName() + "!");
        return "home"; // 返回home.html视图
    }
}

7.1.4 访问表单

访问http://localhost:8080/form，填写表单并提交，你将看到根据输入的名称生成的欢迎消息。

7.2 条件渲染

Thymeleaf支持条件渲染，可以根据条件显示不同的内容。例如：

<p th:if="${user.name != null}" th:text="'Welcome, ' + ${user.name} + '!'"></p>
<p th:unless="${user.name != null}">Please enter your name.</p>

7.3 循环渲染

Thymeleaf还支持循环渲染，可以通过th:each实现。例如：

<ul>
    <li th:each="item : ${items}" th:text="${item}"></li>
</ul>

8. 注意事项

模板缓存：在开发过程中，建议将spring.thymeleaf.cache设置为false，以便实时查看更改。在生产环境中，建议开启缓存以提高性能。
安全性：在处理用户输入时，务必注意安全性，避免XSS等攻击。Thymeleaf会自动对输出进行HTML转义，但在使用th:utext时需谨慎。
国际化：Thymeleaf支持国际化，使用th:text="#{key}"来获取国际化消息。

9. 总结

通过本教程，你已经学习了如何在Spring Boot项目中集成Thymeleaf，并掌握了基本的用法和一些进阶特性。Thymeleaf作为一个强大的模板引擎，能够帮助你快速构建动态Web应用。希望你能在实际项目中灵活运用所学知识，提升开发效率。