SpringBoot中自定义首页(默认页)及favicon的方法

更新时间：2023年08月07日 10:16:09 作者：我要大芒果

这篇文章主要介绍了SpringBoot中如何自定义首页(默认页)及favicon,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

一、前言

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

二、自定义首页

在了解如何自定义首页之前，还是需要先了解一下SpringBoot中默认情况下访问静态资源的解决方案，可以参考我之前的博客，https://www.jb51.net/program/293798lcn.htm。

上面的博客中提到了共有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

到此这篇关于SpringBoot中如何自定义首页(默认页)及favicon的文章就介绍到这了,更多相关springboot自定义首页内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java中的六种经典比较排序算法
排序算法是程序开发和计算机科学中常见的算法之一，排序算法是算法分析的重要内容之一，因为排序算法的效率影响着程序的性能和稳定性，本文的目的是介绍常见的排序算法，并且通过代码示例演示它们的实现过程,需要的朋友可以参考下
2023-06-06
Idea如何导入一个SpringBoot项目的方法(图文教程)
这篇文章主要介绍了Idea如何导入一个SpringBoot项目的方法(图文教程)，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-09-09
Java中的HttpServletRequest接口详细解读
这篇文章主要介绍了Java中的HttpServletRequest接口详细解读,是一个接口,全限定名称为Jakarta.Serclet.http.HttpServletRequest
HttpServletRequest接口是Servlet规范的一员,需要的朋友可以参考下
2023-11-11
Spring详解四种加载配置项的方法
这篇文章主要给大家介绍了关于springboot加载配置项的四种方式,文中通过示例代码介绍的非常详细,对大家学习或者使用springboot具有一定的参考学习价值,需要的朋友可以参考下
2022-06-06
Spring boot 使用JdbcTemplate访问数据库
SpringBoot 是为了简化 Spring 应用的创建、运行、调试、部署等一系列问题而诞生的产物。本文重点给大家介绍spring boot 使用JdbcTemplate访问数据库,需要的朋友可以参考下
2018-05-05
详解Java中Period类的使用方法
Period类通过年、月、日相结合来描述一个时间量，最高精度是天。本文将通过示例详细为大家讲讲Period类的使用，需要的可以参考一下
2022-05-05
SpringBoot配置类中@Configuration和@Bean的作用
这篇文章主要介绍了SpringBoot配置类中@Configuration和@Bean的作用,@Configuration 指明当前类是一个配置类来替代之前的Spring配置文件,Spring boot的配置类,相当于Spring的配置文件,需要的朋友可以参考下
2023-11-11
Executor拦截器高级教程QueryInterceptor的规范
今天小编就为大家分享一篇关于Executor拦截器高级教程QueryInterceptor的规范，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
2018-12-12
MyBatis高级映射ResultMap解决属性问题
对于数据库中对表的增删改查操作，我们知道增删改都涉及的是单表，而只有查询操作既可以设计到单表操作又可以涉及到多表操作，所以对于输入映射parameterType而言是没有所谓的高级映射的，也就是说高级映射只针对于输出映射
2023-02-02
关于springboot-starter-undertow和tomcat的区别说明
这篇文章主要介绍了关于springboot-starter-undertow和tomcat的区别说明，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-03-03