如何使用 Spring Boot 实现模板

在现代 web 开发中,使用模板引擎能够帮助我们快速实现动态网页。Spring Boot 提供了与多种模板引擎的无缝集成,其中最常用的是 Thymeleaf。本文将带领你从零开始,实现一个简单的 Spring Boot 项目来使用模板引擎渲染网页。

流程概述

在实现过程中,我们将按以下步骤进行:

步骤 描述
步骤 1 创建 Spring Boot 项目
步骤 2 添加 Thymeleaf 依赖
步骤 3 创建控制器和视图模板
步骤 4 运行项目并测试

状态图

stateDiagram
    [*] --> 创建项目
    创建项目 --> 添加依赖
    添加依赖 --> 创建控制器
    创建控制器 --> 创建模板
    创建模板 --> 运行项目
    运行项目 --> [*]

步骤详细说明

步骤 1: 创建 Spring Boot 项目

使用 [Spring Initializr]( 创建一个新的 Spring Boot 项目。选择适当的项目元数据,并在项目依赖中选择 "Spring Web" 和 "Thymeleaf"。

步骤 2: 添加 Thymeleaf 依赖

如果你使用的是 Maven,确保 pom.xml 中包含以下依赖:

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

此依赖使我们能够使用 Thymeleaf 模板引擎,提供在 Spring Boot 中渲染 HTML 的功能。

步骤 3: 创建控制器和视图模板

接下来,我们将创建一个简单的控制器。在 src/main/java/com/example/demo/controller 目录下创建一个 HelloController.java 文件:

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 HelloController {

    @GetMapping("/hello")
    public String sayHello(Model model) {
        model.addAttribute("message", "Hello, Spring Boot with Thymeleaf!");
        return "hello"; // 返回视图名
    }
}

在此控制器中,我们定义了一个处理 /hello 路径的 GET 请求的方法。我们向模型添加了一个属性,然后返回一个视图名。

接下来,在 src/main/resources/templates 目录中创建一个 hello.html 文件,并写入以下内容:

<!DOCTYPE html>
<html xmlns:th="
<head>
    <meta charset="UTF-8">
    <title>Hello Page</title>
</head>
<body>
    Default Message
</body>
</html>

在这个 HTML 模板中,使用 Thymeleaf 的 th:text 属性替换 <h1> 标签中的内容。

步骤 4: 运行项目并测试

现在,你可以运行 Spring Boot 项目。进入项目根目录,使用以下命令启动:

mvn spring-boot:run

通过这个命令,我们启动了 Spring Boot 应用,使其监听在默认的 8080 端口。

在浏览器中访问 http://localhost:8080/hello。你应该可以看到页面上显示的消息:“Hello, Spring Boot with Thymeleaf!”

旅行图

journey
    title 使用 Spring Boot 和 Thymeleaf 的旅程
    section 创建项目
      打开 Spring Initializr: 5: 客户端
      选择依赖: 5: 客户端
    section 添加依赖
      添加 Thymeleaf 依赖: 4: 开发者
    section 编写控制器
      创建 HelloController: 5: 开发者
      编写方法: 5: 开发者
    section 编写模板
      创建 hello.html: 5: 开发者
    section 运行项目
      启动应用: 5: 开发者
      访问页面: 5: 客户端

结尾

通过本文,我们逐步完成了一个 Spring Boot 项目的创建,添加了模板引擎依赖,设置了控制器和视图模板,并成功运行了项目。模板引擎如 Thymeleaf 为我们提供了将动态数据渲染到网页中的简便方法,为未来的 web 开发奠定了基础。希望你能从中学习并在实际项目中灵活应用。