SpringBoot中如何自定义首页(默认页)及favicon,你知道吗?

本文介绍了如何在SpringBoot项目中自定义首页和favicon。通过分析源码,揭示了SpringBoot加载静态资源的机制,并提供了实现自定义首页和favicon的方法。同时,推荐了一个在线制作favicon的网站。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

一、前言

之前就有小伙伴问我,SpringBoot项目如何自定义首页,因为看到别人项目首页都挺漂亮的,今天刚刚说一下这个首页,顺带也说一下favicon。

二、自定义首页

在了解如何自定义首页之前,还是需要先了解一下SpringBoot中默认情况下访问静态资源的解决方案,可以参考我之前的博客,https://blog.youkuaiyun.com/java_miss_you/article/details/104362771

上面的博客中提到了共有5个路径,这5个路径下放首页都可生效。下面我将一探究竟。

首先,在classpath:/static/classpath:/templates/下,分别放入index.html,至于里面显示的内容可以区分一下,如下:

classpath:/static/ -> index.html】

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>hello static !</h1>
</body>
</html>

classpath:/templates/ -> index.html】

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>hello thymeleaf !</h1>
</body>
</html>

至于为什么在classpath:/templates/下放index.html,是因为我需要验证一下,如果classpath:/static/下没有index.html文件时,是否会访问classpath:/templates/下的index.html文件?

因为classpath:/templates/下的模板,一般情况下,需要使用Controller来访问,所以,这里我们还需要定义一个HelloController,如下:

@Controller
public class HelloController {

    @GetMapping("/index")
    public String hello(){
        return "index";
    }
}

启动项目,在浏览器地址栏输入http://localhost:8080/,看到底访问的是哪个index.html文件,如下:
在这里插入图片描述
可以看到,默认情况下,是访问classpath:/static/下的index.html,那么接下来,我们把classpath:/static/下的index.html文件删除,然后重启项目,在浏览器使用Ctrl+F5刷新一下,再看看,如下:
在这里插入图片描述
这个结果正好验证了我上面的假设是成立的,所以我们学习知识,不能靠假设,还需要通过源码来验证你的假设,下面我将对上面两种情况用源码进行验证。

三、源码剖析

首先,我们找到WebMvcAutoConfiguration类中的getWelcomePage方法,如下:
在这里插入图片描述
该方法中的第一行,其实就很熟悉了,我上面给的那篇博客中有详细的介绍,这里我只说明第一行,共返回了5个目录,分别是:classpath:/META-INF/resources/classpath:/resources/classpath:/static/classpath:/public//,所以你的index.html放在上面的哪个目录下都行。第二行就是在这5个目录下依次去寻找index.html,有一个getIndexHtml方法,就是它的功劳,如下:
在这里插入图片描述
接下来,我们再看看为什么classpath:/static/下没有index.html文件时,默认会访问classpath:/templates/下的index.html,因为创建项目时,我添加了thymeleaf依赖,如下:

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

如果没有上面这个依赖,上面的假设将不会成立,那为什么添加了这个依赖后,这个假设就成立呢?

因为SpringBoot默认已经集成了4种类型的模板,如下:
在这里插入图片描述
所以,只要添加了模板依赖,classpath:/templates/下的模板文件便可以访问。

四、自定义favicon

给大家推荐一个制作favicon的网站,如:https://tool.lu/favicon/

先在上面的网站中,制作好自己想要的favicon,然后将该favicon放在项目的classpath:/static/下,其他favicon可以放的目录和静态资源可放目录基本相同,至于为什么放classpath:/static/下呢?因为创建项目时,该目录默认被创建好了,所以就放在它下面即可,如下:
在这里插入图片描述
运行结果如下:
在这里插入图片描述

五、源码地址

https://github.com/java22/welcome

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值