SpringBoot中自定義首頁(默認頁)及favicon的方法

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

這篇文章主要介紹了SpringBoot中如何自定義首頁(默認頁)及favicon,本文給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下

一、前言

之前就有小伙伴問我，SpringBoot項目如何自定義首頁，因為看到別人項目首頁都挺漂亮的，今天剛剛說一下這個首頁，順帶也說一下favicon。

二、自定義首頁

在了解如何自定義首頁之前，還是需要先了解一下SpringBoot中默認情況下訪問靜態(tài)資源的解決方案，可以參考我之前的博客，http://chabaoo.cn/program/293798lcn.htm。

上面的博客中提到了共有5個路徑，這5個路徑下放首頁都可生效。下面我將一探究竟。

首先，在classpath:/static/和classpath:/templates/下，分別放入index.html，至于里面顯示的內(nèi)容可以區(qū)分一下，如下：

【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刷新一下，再看看，如下：

在這里插入圖片描述

這個結(jié)果正好驗證了我上面的假設是成立的，所以我們學習知識，不能靠假設，還需要通過源碼來驗證你的假設，下面我將對上面兩種情況用源碼進行驗證。

三、源碼剖析

首先，我們找到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，因為創(chuàng)建項目時，我添加了thymeleaf依賴，如下：

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

如果沒有上面這個依賴，上面的假設將不會成立，那為什么添加了這個依賴后，這個假設就成立呢？

因為SpringBoot默認已經(jīng)集成了4種類型的模板，如下：

在這里插入圖片描述

所以，只要添加了模板依賴，classpath:/templates/下的模板文件便可以訪問。

四、自定義favicon

給大家推薦一個制作favicon的網(wǎng)站，如：https://tool.lu/favicon/。

先在上面的網(wǎng)站中，制作好自己想要的favicon，然后將該favicon放在項目的classpath:/static/下，其他favicon可以放的目錄和靜態(tài)資源可放目錄基本相同，至于為什么放classpath:/static/下呢？因為創(chuàng)建項目時，該目錄默認被創(chuàng)建好了，所以就放在它下面即可，如下：

在這里插入圖片描述