SpringBoot靜態(tài)資源與首頁配置實現(xiàn)原理深入分析

更新時間：2022年10月10日 08:32:28 作者：Decade0712

最近在做SpringBoot項目的時候遇到了“白頁”問題，通過查資料對SpringBoot訪問靜態(tài)資源做了總結，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習吧

一、靜態(tài)資源導入

關鍵源碼可以看WebMvcAutoConfiguration這個類下面的addResourceHandlers方法

在這個方法中，我們有幾個重點需要了解一下

1、webjars

可以理解為以maven的形式引入web的相關jar包

請求路徑為/webjars/**的，都會去classpath:/META-INF/resources/webjars/下尋找相關的靜態(tài)資源

2、靜態(tài)資源映射規(guī)則

如果在項目中要使用我們自己導入的靜態(tài)資源，它的映射規(guī)則是怎么樣的呢，我們分析源碼可以得出

以下四個路徑的中存放的靜態(tài)資源可以被識別，優(yōu)先

resource（注意，此處是resource下面的resource文件夾）>static （默認）>public

"classpath:/META-INF/resources/"
"classpath:/resources/"
"classpath:/static/"
"classpath:/public/"

3、自定義靜態(tài)資源路徑

我們可以使用spring.web.resources.static-locations

在yaml文件中自定義靜態(tài)資源文件的路徑，例如我們限制靜態(tài)文件都必須放在static目錄下

也可以使用spring.mvc.static-path-pattern，當前項目 + static-path-pattern + 靜態(tài)資源名 = 靜態(tài)資源文件夾下找

spring:
web:
resources:
static-locations: classpath:/static/
mvc:
static-path-pattern: /static/**

隨后我們訪問一下靜態(tài)資源，發(fā)現(xiàn)只有放在static下面可以被訪問到

二、首頁配置和圖標

1、首頁配置

springboot它會去找靜態(tài)資源文件夾下的index.html（注意不能配置spring.mvc.static-path-pattern）或者是controller處理/index轉發(fā)的頁面

下面是WebMvcAutoConfiguration這個類中關于首頁的相關方法

@Bean
public WelcomePageHandlerMapping welcomePageHandlerMapping(ApplicationContext applicationContext, FormattingConversionService mvcConversionService, ResourceUrlProvider mvcResourceUrlProvider) {
    WelcomePageHandlerMapping welcomePageHandlerMapping = new WelcomePageHandlerMapping(new TemplateAvailabilityProviders(applicationContext), applicationContext, this.getWelcomePage(), this.mvcProperties.getStaticPathPattern());
    welcomePageHandlerMapping.setInterceptors(this.getInterceptors(mvcConversionService, mvcResourceUrlProvider));
    welcomePageHandlerMapping.setCorsConfigurations(this.getCorsConfigurations());
    return welcomePageHandlerMapping;
}
private Resource getWelcomePage() {
    String[] var1 = this.resourceProperties.getStaticLocations();
    int var2 = var1.length;
    for(int var3 = 0; var3 < var2; ++var3) {
        String location = var1[var3];
        Resource indexHtml = this.getIndexHtml(location);
        if (indexHtml != null) {
            return indexHtml;
        }
    }
    ServletContext servletContext = this.getServletContext();
    if (servletContext != null) {
        return this.getIndexHtml((Resource)(new ServletContextResource(servletContext, "/")));
    } else {
        return null;
    }
}
private Resource getIndexHtml(String location) {
    return this.getIndexHtml(this.resourceLoader.getResource(location));
}
private Resource getIndexHtml(Resource location) {
    try {
        Resource resource = location.createRelative("index.html");
        if (resource.exists() && resource.getURL() != null) {
            return resource;
        }
    } catch (Exception var3) {
    }
    return null;
}