【模板引擎】SpringBoot：thymeleaf模板引擎

最新推荐文章于 2022-09-06 19:52:30 发布
最新推荐文章于 2022-09-06 19:52:30 发布
阅读量547 收藏 1
点赞数
分类专栏： java 文章标签： SpringBoot Thymeleaf
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/jjjikerupup/article/details/91462673
版权

SpringBoot：thymeleaf模板引擎

1. webjars&静态资源映射规则

SpringBoot 项目使用 Maven 构建，导入 web 模块，pom.xml文件如下

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.5.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.jiker</groupId>
    <artifactId>springboot-web</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot-web</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>11</java.version>
    </properties>

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

若是原来的web应用时，应用中的静态资源将放在webapp目录下
如今，项目打包方式为 jar ，若需要放入静态资源文件，则需要了解 SpringBoot 的静态资源映射规则

在 Spring Boot 应用中，SpringMVC 的相关配置都是在 WebMvcAutoConfiguration 中
查看该类源码一部分

 public void addResourceHandlers(ResourceHandlerRegistry registry) {
	if (!this.resourceProperties.isAddMappings()) {
		logger.debug("Default resource handling disabled");
    } else {
        Duration cachePeriod = this.resourceProperties.getCache().getPeriod();
        CacheControl cacheControl = this.resourceProperties.getCache().getCachecontrol().toHttpCacheControl();
        if (!registry.hasMappingForPattern("/webjars/**")) {
            this.customizeResourceHandlerRegistration(registry.addResourceHandler(new String[]{"/webjars/**"}).addResourceLocations(new String[]{"classpath:/META-INF/resources/webjars/"}).setCachePeriod(this.getSeconds(cachePeriod)).setCacheControl(cacheControl));
        }

        String staticPathPattern = this.mvcProperties.getStaticPathPattern();
       	if (!registry.hasMappingForPattern(staticPathPattern)) {
            this.customizeResourceHandlerRegistration(registry.addResourceHandler(new String[]{staticPathPattern}).addResourceLocations(getResourceLocations(this.resourceProperties.getStaticLocations())).setCachePeriod(this.getSeconds(cachePeriod)).setCacheControl(cacheControl));
        }

    }
}

该方法名为 addResourceHandlers：添加资源映射

规则1、所有 /webjars/** 请求，都去 classpath:/META-INF/resources/webjars/ 下寻找资源
webjars：以 jar 包的方式引入资源，参考：https://www.webjars.org/
例子：若项目中需要引入 jQuery ，原 Web 应用的方式是将 jQuery.js 文件导入到 webapp文件夹中
现在可以通过 webjars，以 jar 包的方式导入 jQuery
在官网中搜索需要的插件
在这里插入图片描述
将依赖导入进 pom.xml 文件中

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

    <!--导入jQuery依赖-->
    <dependency>
        <groupId>org.webjars</groupId>
        <artifactId>jquery</artifactId>
        <version>3.3.1</version>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

查看依赖
在这里插入图片描述
发现该文件夹目录已经和映射规则 classpath:/META-INF/resources/webjars/ 对应
即，现可以发送：http://localhost:8080/webjars/jquery/3.3.1/jquery.js 查看 jquery 源码
在这里插入图片描述
规则2、“/**” 访问当前项目的任何资源（静态资源文件夹）
在源码中的另一个规则 String staticPathPattern = this.mvcProperties.getStaticPathPattern();获取静态资源路径
该方法的源码如下

public String getStaticPathPattern() {
    return this.staticPathPattern;
}

public class WebMvcProperties {
    private Format messageCodesResolverFormat;
    private Locale locale;
    private WebMvcProperties.LocaleResolver localeResolver;
    private String dateFormat;
    private boolean dispatchTraceRequest;
    private boolean dispatchOptionsRequest;
    private boolean ignoreDefaultModelOnRedirect;
    private boolean throwExceptionIfNoHandlerFound;
    private boolean logResolvedException;
    private String staticPathPattern;
    private final WebMvcProperties.Async async;
    private final WebMvcProperties.Servlet servlet;
    private final WebMvcProperties.View view;
    private final WebMvcProperties.Contentnegotiation contentnegotiation;
    private final WebMvcProperties.Pathmatch pathmatch;

    public WebMvcProperties() {
        this.localeResolver = WebMvcProperties.LocaleResolver.ACCEPT_HEADER;
        this.dispatchTraceRequest = false;
        this.dispatchOptionsRequest = true;
        this.ignoreDefaultModelOnRedirect = true;
        this.throwExceptionIfNoHandlerFound = false;
        this.logResolvedException = false;
        this.staticPathPattern = "/**";
        this.async = new WebMvcProperties.Async();
        this.servlet = new WebMvcProperties.Servlet();
        this.view = new WebMvcProperties.View();
        this.contentnegotiation = new WebMvcProperties.Contentnegotiation();
        this.pathmatch = new WebMvcProperties.Pathmatch();
    }
	
	... ...

即默认路径为 this.staticPathPattern = "/**";
通过 getStaticLocations() 方法源码可知

private static final String[] CLASSPATH_RESOURCE_LOCATIONS = new String[]{"classpath:/META-INF/resources/", "classpath:/resources/", "classpath:/static/", "classpath:/public/"};

若访问 http://localhost:8080/xxx 无任何处理时，则去以下文件夹下寻找资源

classpath:/META-INF/resources/
classpath:/resources/
classpath:/static/
classpath:/public/
/ ： 当前项目的根路径

即可以将 css 、js、img 等文件放在以下目录中
在这里插入图片描述
规则3、首页；静态资源文件夹下所有的 index.html 页面；被 “/**” 映射
同样在 WebMvcAutoConfiguration 中查看以下源码

	//配置首页映射
	@Bean
    public WelcomePageHandlerMapping welcomePageHandlerMapping(ApplicationContext applicationContext) {
        return new WelcomePageHandlerMapping(new TemplateAvailabilityProviders(applicationContext), applicationContext, this.getWelcomePage(), this.mvcProperties.getStaticPathPattern());
    }

	//WelcomePageHandlerMapping 方法
	WelcomePageHandlerMapping(TemplateAvailabilityProviders templateAvailabilityProviders, ApplicationContext applicationContext, Optional<Resource> welcomePage, String staticPathPattern) {
        if (welcomePage.isPresent() && "/**".equals(staticPathPattern)) {
            logger.info("Adding welcome page: " + welcomePage.get());
            this.setRootViewName("forward:index.html");
        } else if (this.welcomeTemplateExists(templateAvailabilityProviders, applicationContext)) {
            logger.info("Adding welcome page template: index");
            this.setRootViewName("index");
        }

    }

在静态资源文件夹中创建一个 index 页面，之后通过 http://localhost:8080/ 进行访问
在这里插入图片描述
在这里插入图片描述
首页 index.html 得到映射

规则4、所有的 **/favicon.ico 都是在静态资源文件夹中映射（配置网页图标）

		//配置网页图标
        @Configuration
        @ConditionalOnProperty(
            value = {"spring.mvc.favicon.enabled"},
            matchIfMissing = true
        )
        public static class FaviconConfiguration implements ResourceLoaderAware {
            private final ResourceProperties resourceProperties;
            private ResourceLoader resourceLoader;

            public FaviconConfiguration(ResourceProperties resourceProperties) {
                this.resourceProperties = resourceProperties;
            }

            public void setResourceLoader(ResourceLoader resourceLoader) {
                this.resourceLoader = resourceLoader;
            }

            @Bean
            public SimpleUrlHandlerMapping faviconHandlerMapping() {
                SimpleUrlHandlerMapping mapping = new SimpleUrlHandlerMapping();
                mapping.setOrder(-2147483647);
                mapping.setUrlMap(Collections.singletonMap("**/favicon.ico", this.faviconRequestHandler()));
                return mapping;
            }

            @Bean
            public ResourceHttpRequestHandler faviconRequestHandler() {
                ResourceHttpRequestHandler requestHandler = new ResourceHttpRequestHandler();
                requestHandler.setLocations(this.resolveFaviconLocations());
                return requestHandler;
            }

            private List<Resource> resolveFaviconLocations() {
                String[] staticLocations = WebMvcAutoConfiguration.WebMvcAutoConfigurationAdapter.getResourceLocations(this.resourceProperties.getStaticLocations());
                List<Resource> locations = new ArrayList(staticLocations.length + 1);
                Stream var10000 = Arrays.stream(staticLocations);
                ResourceLoader var10001 = this.resourceLoader;
                var10001.getClass();
                var10000.map(var10001::getResource).forEach(locations::add);
                locations.add(new ClassPathResource("/"));
                return Collections.unmodifiableList(locations);
            }
        }

从网上下载一个 .ico 文件当作图标：https://www.easyicon.net/
在静态资源文件夹中引入网页图标
在这里插入图片描述

2. 引入thymeleaf模板引擎

Spring Boot 推荐使用 Thymeleaf 模板引擎
官网：https://www.thymeleaf.org/

1、引入thymeleaf模板引擎

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

2、thymeleaf使用&语法
查看 ThymeleafProperties 源码默认规则

... ...
@ConfigurationProperties(
    prefix = "spring.thymeleaf"
)
public class ThymeleafProperties {
    private static final Charset DEFAULT_ENCODING;
    public static final String DEFAULT_PREFIX = "classpath:/templates/";
    public static final String DEFAULT_SUFFIX = ".html";
    private boolean checkTemplate = true;
    private boolean checkTemplateLocation = true;
    private String prefix = "classpath:/templates/";
    private String suffix = ".html";
    private String mode = "HTML";

只要我们把 HMTL 页面放在 classpath:/templates/ 文件夹下，Thymeleaf 就能自动渲染

测试
在 templates 文件夹中创建 success.html ，创建一个控制器访问

package com.jiker.springbootweb.controller;

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

@Controller
public class HelloController {

    @GetMapping("/success")
    public String success(){
        //classpath:/templates/success.html
        return "success";
    }
}

在这里插入图片描述
访问成功

使用语法：
1、导入 thymeleaf 名称空间

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

2、使用示例

package com.jiker.springbootweb.controller;

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

import java.util.Map;

@Controller
public class HelloController {

    @GetMapping("/success")
    public String success(Map<String,String> map){
        map.put("thymeleaf","模板引擎");
        //classpath:/templates/success.html
        return "success";
    }
}

在 html 页面中取出值

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <h1>success</h1>
    <div th:text="${thymeleaf}"></div>
</body>
</html>

更多语法示例，详见参考文档：https://www.thymeleaf.org/doc/tutorials/3.0/usingthymeleaf.pdf

时间：2019.6.11 20:17

JJJiker
关注
专栏目录
【SpringBoot】3、SpringBoot中整合Thymeleaf模板引擎
Asurplus
04-16 21万+
SpringBoot 为我们提供了 Thymeleaf 自动化配置解决方案，所以我们在 SpringBoot 中使用 Thymeleaf 非常方便 一、简介 Thymeleaf是一个流行的模板引擎，该模板引擎采用Java语言开发，模板引擎是一个技术名词，是跨领域跨平台的概念，在Java语言体系下有模板引擎，在C#、PHP语言体系下也有模板引擎。除了thymeleaf之外还有Velocity、Fr...
SpringBoot：Thymeleaf模板引擎
yooppa的博客
08-17 199
Thymeleaf
狂神说SpringBoot11：Thymeleaf模板引擎
狂神说
03-18 9922
狂神说SpringBoot系列连载课程，通俗易懂，基于SpringBoot2.2.5版本，欢迎各位狂粉转发关注学习。未经作者授权，禁止转载Thymeleaf模板引擎前端交给我们的页面，是...
01Thymeleaf介绍
痞子王的博客
02-11 616
1. thymeleaf介绍 thymeleaf是一个XML/XHTML/HTML5模板引擎，可用于Web与非Web环境中的应用开发。它是一个开源的Java库，基于Apache License 2.0许可，由Daniel Fernández创建，该作者还是Java加密库Jasypt的作者。 Thymeleaf提供了一个用于整合Spring MVC的可选模块，在应用开发中，你可以使用Thymele...
thymeleaf模板引擎-
CreayBoom的博客
06-20 79
引入pom依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-thymeleaf</artifactId> </dependency>
thymeleaf 模板引擎
好好学习，天天向上
11-29 4850
thymeleaf 简介 ​ SpringBoot默认不支持JSP，因为jsp相对于一些模板引擎，性能都比较低，官方推荐使用thymeleaf。 ​ Thymeleaf是一个Java模板引擎开发库，可以处理和生成HTML、XML、JavaScript、CSS和文本，在Web和非Web环境下都可以正常工作。 如果实在想使用jsp，参考https://blog.csdn.net/a1405/article/details/100037062 HelloWorld 导入依赖 ​ 选择web和thymel
thymeleaf模板引擎
Kevinnsm的博客
12-18 368
文章目录前言一、thymeleaf是什么？二、使用步骤1.导入坐标2.Spring Boot项目中创建controller3.分析源码4.配置success.html5.启动主配置文件访问http://localhost:8080/success总结 前言 Thymeleaf是Spring Boot官方的推荐使用模板。 所以放弃jsp吧（我不是打广告的） 一、thymeleaf是什么？ Thymeleaf是一个用于Web和独立Java环境的模板引擎，能够处理HTML、XML、JavaScript、.
springboot整合thymeleaf模板
02-17
SpringBoot整合Thymeleaf模板是一项常见的Web开发任务，它结合了SpringBoot的便捷性和Thymeleaf的动态模板引擎，使得开发人员可以快速构建功能丰富的Web应用。下面将详细介绍这个过程及其涉及的关键知识点。 首先，...
详解SpringBoot+Thymeleaf 基于HTML5的现代模板引擎
08-29
SpringBoot+Thymeleaf 基于HTML5的现代模板引擎 在本篇文章中，我们将详细介绍 SpringBoot+Thymeleaf 基于HTML5的现代模板引擎的相关知识点。 Thymeleaf 简介 Thymeleaf 是 Java 服务端的模板引擎，与传统的 JSP ...
一个基于SpringBoot+Thymeleaf渲染的图书管理系统
12-17
结合Thymeleaf模板引擎，可以快速构建出功能丰富的Web应用，如本案例中的图书管理系统。本文将深入探讨如何利用Java的SpringBoot框架与Thymeleaf技术来创建一个高效、易用的图书管理系统。 首先，SpringBoot是...
Thymeleaf模板引擎
Massimo__JAVA的博客
09-06 162
Thymeleaf模板引擎
SpringBoot与Thymeleaf模板引擎实战解析
"Thymeleaf是SpringBoot推荐的模板引擎，它允许HTML模板在服务器端和客户端都能正确解析。Thymeleaf通过在HTML中添加特定的属性来实现动态内容的展示，使得前后端分离更加便捷。" Thymeleaf在SpringBoot中的应用...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值