快捷導(dǎo)航

SpringBoot3集成Thymeleaf的過程詳解

更新時(shí)間：2024年01月05日 08:21:15 作者：修己xj

在現(xiàn)代的Web開發(fā)中,構(gòu)建靈活、動(dòng)態(tài)的用戶界面是至關(guān)重要的,Spring Boot和Thymeleaf的結(jié)合為開發(fā)者提供了一種簡單而強(qiáng)大的方式來創(chuàng)建動(dòng)態(tài)的Web應(yīng)用,本文將介紹如何在Spring Boot項(xiàng)目中集成Thymeleaf,并展示一些基本的使用方法,需要的朋友可以參考下

什么是Thymeleaf？

Thymeleaf是一款用于Web和獨(dú)立環(huán)境的現(xiàn)代化服務(wù)器端Java模板引擎。它能夠處理HTML、XML、JavaScript、CSS甚至純文本。Thymeleaf的語法簡單易懂，它允許開發(fā)者在模板中嵌入表達(dá)式，以便動(dòng)態(tài)地渲染數(shù)據(jù)。

官網(wǎng)地址：www.thymeleaf.org/

官方文檔：https://www.thymeleaf.org/doc/tutorials/3.1/usingthymeleaf.html

github地址：https://github.com/thymeleaf

開始集成Thymeleaf

首先，確保你的Spring Boot項(xiàng)目已經(jīng)建立。接下來，我們將添加Thymeleaf的依賴。在pom.xml文件中，添加以下依賴：

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

這將引入Spring Boot Thymeleaf Starter，它包含了Thymeleaf的所有必要依賴。

配置Thymeleaf

在Spring Boot應(yīng)用中，Thymeleaf的默認(rèn)配置通常已經(jīng)足夠滿足大多數(shù)需求。然而，你也可以通過在application.properties或application.yml文件中進(jìn)行配置來修改默認(rèn)設(shè)置。以下是一個(gè)基本的Thymeleaf配置示例：

spring:
  # 配置thymeleaf的相關(guān)信息
  thymeleaf:
    # 開啟視圖解析
    enabled: true
    #編碼格式
    encoding: UTF-8
    #前綴配置
    prefix: classpath:/templates/
    # 后綴配置
    suffix: .html
    #是否使用緩存 開發(fā)環(huán)境時(shí)不設(shè)置緩存
    cache: false
    # 格式為 HTML 格式
    mode: HTML5
    # 配置類型
    servlet:
      content-type: text/html

創(chuàng)建Thymeleaf模板

在src/main/resources/templates/目錄下創(chuàng)建Thymeleaf模板文件。例如，我們創(chuàng)建一個(gè)名為index.html的文件：

<!DOCTYPE html>
<html lang="en"  xmlns:th="http://www.thymeleaf.org">

<head>
    <meta charset="UTF-8">
    <title>修己</title>
</head>
<body>
<span th:text="${name}" style="font-size: 60px;font-weight: bold;color: #00C957;font-family: 楷體,cursive">xj</span>
</body>
</html>

修改 html 標(biāo)簽用于引入 thymeleaf 引擎，這樣才可以在其他標(biāo)簽里使用 th:* 語法，聲明如下：

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">

創(chuàng)建Controller

現(xiàn)在，我們需要一個(gè)Controller來處理請(qǐng)求并提供數(shù)據(jù)給Thymeleaf模板。創(chuàng)建一個(gè)簡單的Controller類：

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


@Controller
public class TestController {
    @GetMapping({"/","/index"})
    public String  listUser(Model model){
        model.addAttribute("name","修己");
        return "index";
    }
}

注：

我們前后端分離的項(xiàng)目在controller上一般都會(huì)使用@RestController注解，@RestController 注解是 @Controller 和 @ResponseBody 注解的結(jié)合，它的作用相當(dāng)于在每個(gè)方法上都添加了 @ResponseBody，用于構(gòu)建 RESTful Web服務(wù)。使用 @RestController 注解的類，每個(gè)方法的返回值都會(huì)被直接寫入HTTP響應(yīng)體中，而不會(huì)經(jīng)過視圖解析器進(jìn)行渲染。默認(rèn)情況下，返回的是JSON格式的數(shù)據(jù)，但可以通過其他注解配置以返回不同格式的數(shù)據(jù)。

@Controller 通常用于傳統(tǒng)的MVC應(yīng)用程序，其中控制器負(fù)責(zé)處理HTTP請(qǐng)求，并返回一個(gè)視圖（HTML頁面）或者通過視圖解析器解析的模型數(shù)據(jù)。Thymeleaf通常與@Controller一起使用，因?yàn)門hymeleaf模板引擎負(fù)責(zé)渲染HTML視圖。