SpringBoot靜態(tài)資源映射規(guī)則淺析

更新時間：2023年02月27日 11:32:28 作者：哈密瓜Q

這篇文章主要介紹了SpringBoot靜態(tài)資源映射規(guī)則，今天在玩SpringBoot的demo的時候,放了張圖片在resources目錄下,啟動區(qū)訪問的時候,突然好奇是識別哪些文件夾來展示靜態(tài)資源的, 為什么有時候放的文件夾不能顯示,有的卻可以

1. 靜態(tài)資源映射規(guī)則

在項目中雙擊shift或ctrl+N搜索WebMvcAutoConfiguration.class文件，文件中的addResourceHandlers方法如下：

public void addResourceHandlers(ResourceHandlerRegistry registry) {
    if (!this.resourceProperties.isAddMappings()) {
        logger.debug("Default resource handling disabled");
    } else {
        this.addResourceHandler(registry, "/webjars/**", "classpath:/META-INF/resources/webjars/");
        this.addResourceHandler(registry, this.mvcProperties.getStaticPathPattern(), (registration) -> {
            registration.addResourceLocations(this.resourceProperties.getStaticLocations());
            if (this.servletContext != null) {
                ServletContextResource resource = new ServletContextResource(this.servletContext, "/");
                registration.addResourceLocations(new Resource[]{resource});
            }
        });
    }
}

隨后進入到getStaticLocations()方法可以發(fā)現(xiàn)變量 staticLocations 的取值如下：

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

即項目運行時會到上述路徑下尋找靜態(tài)資源，也可以自定義靜態(tài)資源路徑，需在 application.properties 中配置：

spring.resources.static-locations=classpath:/folder1/,classpath:/folder2/

注：一旦自定義了靜態(tài)文件夾的路徑，則默認的靜態(tài)資源路徑就會失效。

2. 歡迎頁

靜態(tài)資源路徑下的 index.html 文件會被/**所映射，當訪問http://localhost:8080/時，會默認映射到靜態(tài)資源文件夾下的 index.html。

遇到的問題

新建 index.html 文件后運行項目，訪問http://localhost:8080/時會頁面錯誤：

控制臺報如下錯誤：

Spring Boot 的版本是 2.7.8，tomcat 的版本是 9.0.71。Spring Boot 通過內(nèi)嵌的 tomcat 來運行項目，但需要依靠本地的 java 環(huán)境，我本地的 java 版本是 Java 1.8.0_261（即 java 8 版本），一般 java 8 和 tomcat 8.x.x 配套使用，這里可能是版本沖突導致的問題。將項目的 SDK 改為jbr-11 JetBrains Runtime version 11.0.10即可解決問題：