SpringBoot中如何使用Thymeleaf模板

发布时间：2022-04-25 13:47:31 作者：iii
来源：亿速云阅读：233

SpringBoot中如何使用Thymeleaf模板

1. 引言

在现代的Web开发中，前后端分离已经成为一种趋势，但在某些场景下，服务器端渲染（SSR）仍然有其独特的优势。Thymeleaf作为一种流行的Java模板引擎，能够与Spring Boot无缝集成，帮助开发者快速构建动态网页。本文将详细介绍如何在Spring Boot项目中使用Thymeleaf模板引擎。

2. Thymeleaf简介

Thymeleaf是一个现代化的服务器端Java模板引擎，适用于Web和独立环境。它能够处理HTML、XML、JavaScript、CSS甚至纯文本。Thymeleaf的主要目标是提供一种优雅且高度可维护的模板创建方式。

2.1 Thymeleaf的特点

自然模板：Thymeleaf模板是有效的HTML文件，可以在浏览器中直接打开和预览。
强大的表达式语言：支持Spring表达式语言（SpEL），能够轻松处理复杂的逻辑。
模块化设计：支持模板片段和布局，便于代码复用。
与Spring集成：与Spring框架深度集成，支持Spring MVC和Spring Boot。

3. Spring Boot集成Thymeleaf

3.1 创建Spring Boot项目

首先，我们需要创建一个Spring Boot项目。可以使用Spring Initializr（https://start.spring.io/）快速生成项目骨架。选择以下依赖：

Spring Web
Thymeleaf

生成项目后，导入到IDE中。

3.2 配置Thymeleaf

Spring Boot默认已经配置了Thymeleaf，因此我们无需进行额外的配置。如果需要自定义配置，可以在application.properties或application.yml中进行设置。

# application.properties
spring.thymeleaf.prefix=classpath:/templates/
spring.thymeleaf.suffix=.html
spring.thymeleaf.mode=HTML5
spring.thymeleaf.encoding=UTF-8
spring.thymeleaf.cache=false

3.3 创建Thymeleaf模板

在src/main/resources/templates目录下创建一个HTML文件，例如index.html。

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Thymeleaf Example</title>
</head>
<body>
    <h1 th:text="${message}">Default Message</h1>
</body>
</html>

在这个模板中，我们使用了Thymeleaf的th:text属性来动态设置<h1>标签的内容。

3.4 创建Controller

接下来，我们需要创建一个Spring MVC控制器来处理请求并返回模板。

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

@Controller
public class ThymeleafController {

    @GetMapping("/")
    public String index(Model model) {
        model.addAttribute("message", "Hello, Thymeleaf!");
        return "index";
    }
}

在这个控制器中，我们使用@GetMapping注解将根路径/映射到index方法。index方法将一个名为message的属性添加到Model中，并返回模板名称index。

3.5 运行项目

启动Spring Boot应用程序，访问http://localhost:8080/，你将看到页面显示“Hello, Thymeleaf!”。

4. Thymeleaf常用功能

4.1 表达式

Thymeleaf支持多种表达式，包括变量表达式、选择表达式、消息表达式等。

变量表达式：${...}，用于访问模型中的变量。
选择表达式：*{...}，用于选择当前对象的属性。
消息表达式：#{...}，用于国际化消息。
链接表达式：@{...}，用于生成URL。

4.2 条件判断

Thymeleaf支持条件判断，可以使用th:if和th:unless属性。

<div th:if="${user.isAdmin}">
    <p>Welcome, Admin!</p>
</div>
<div th:unless="${user.isAdmin}">
    <p>Welcome, User!</p>
</div>

4.3 循环

Thymeleaf支持循环，可以使用th:each属性。

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

4.4 表单处理

Thymeleaf提供了强大的表单处理功能，可以使用th:object和th:field属性。

<form th:object="${user}" th:action="@{/save}" method="post">
    <input type="text" th:field="*{name}" />
    <input type="text" th:field="*{email}" />
    <button type="submit">Save</button>
</form>

4.5 模板片段

Thymeleaf支持模板片段，可以使用th:fragment和th:replace属性。

<!-- fragments/header.html -->
<header th:fragment="header">
    <h1>My Website</h1>
</header>

<!-- index.html -->
<div th:replace="~{fragments/header :: header}"></div>

4.6 布局

Thymeleaf支持布局，可以使用th:insert和th:replace属性。

<!-- layout.html -->
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Layout</title>
</head>
<body>
    <div th:replace="~{fragments/header :: header}"></div>
    <div th:insert="~{${content}}"></div>
    <div th:replace="~{fragments/footer :: footer}"></div>
</body>
</html>

<!-- index.html -->
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Index</title>
</head>
<body>
    <div th:replace="~{layout :: layout(content=~{::content})}">
        <div th:fragment="content">
            <p>This is the content.</p>
        </div>
    </div>
</body>
</html>

5. 高级功能

5.1 国际化

Thymeleaf支持国际化，可以使用#{...}表达式和th:text属性。

<p th:text="#{welcome.message}">Welcome</p>

5.2 安全性

Thymeleaf与Spring Security集成，可以使用sec:authorize属性进行权限控制。

<div sec:authorize="hasRole('ADMIN')">
    <p>Admin only content</p>
</div>

5.3 自定义方言

Thymeleaf支持自定义方言，可以通过实现IProcessor接口来扩展Thymeleaf的功能。

6. 总结

Thymeleaf是一个功能强大且灵活的模板引擎，能够与Spring Boot无缝集成，帮助开发者快速构建动态网页。通过本文的介绍，你应该已经掌握了如何在Spring Boot项目中使用Thymeleaf模板引擎，并了解了其常用功能和高级特性。希望本文能帮助你在实际项目中更好地使用Thymeleaf。

SpringBoot中如何使用Thymeleaf模板

SpringBoot中如何使用Thymeleaf模板

1. 引言

2. Thymeleaf简介

2.1 Thymeleaf的特点

3. Spring Boot集成Thymeleaf

3.1 创建Spring Boot项目

3.2 配置Thymeleaf

3.3 创建Thymeleaf模板

3.4 创建Controller

3.5 运行项目

4. Thymeleaf常用功能

4.1 表达式

4.2 条件判断

4.3 循环

4.4 表单处理

4.5 模板片段

4.6 布局

5. 高级功能

5.1 国际化

5.2 安全性

5.3 自定义方言

6. 总结

相关阅读