【Spring Boot】静态资源、首页配置原理

原创已于 2022-09-06 22:28:59 修改 · 499 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #前端 #java

于 2022-07-24 22:01:18 首次发布

SpringBoot 专栏收录该内容

21 篇文章

订阅专栏

本文详细介绍了SpringBoot中静态资源的导入与映射规则，包括/webjars/的处理、静态资源路径（resource > static > public）以及自定义配置。同时，解析了首页配置，包括默认首页的选择逻辑，并提及了favicon.ico图标的自动识别。通过深入源码，有助于理解SpringBoot对静态资源的管理。

一、静态资源导入

关键源码可以看WebMvcAutoConfiguration这个类下面的addResourceHandlers方法
在这里插入图片描述
在这个方法中，我们有几个重点需要了解一下

1、webjars

可以理解为以maven的形式引入web的相关jar包
请求路径为/webjars/**的，都会去classpath:/META-INF/resources/webjars/下寻找相关的静态资源

2、静态资源映射规则

如果在项目中要使用我们自己导入的静态资源，它的映射规则是怎么样的呢，我们分析源码可以得出
在这里插入图片描述
以下四个路径的中存放的静态资源可以被识别，优先
resource（注意，此处是resource下面的resource文件夹）>static （默认）>public

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

3、自定义静态资源路径

我们可以使用spring.web.resources.static-locations
在yaml文件中自定义静态资源文件的路径，例如我们限制静态文件都必须放在static目录下

也可以使用spring.mvc.static-path-pattern，当前项目 + static-path-pattern + 静态资源名 = 静态资源文件夹下找

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

在这里插入图片描述

随后我们访问一下静态资源，发现只有放在static下面可以被访问到
在这里插入图片描述

二、首页配置和图标

1、首页配置

springboot它会去找静态资源文件夹下的index.html（注意不能配置spring.mvc.static-path-pattern）或者是controller处理/index转发的页面

下面是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;
}