springboot静态资源映射规则的使用小结

SpringBoot 对静态资源的访问提供了自动配置支持，核心依赖是 WebMvcAutoConfiguration 自动配置类，其底层通过重写 addResourceHandlers 方法，借助 ResourceHandlerRegistry（资源处理器注册器）注册多个 ResourceHandler（资源处理器），分别定义了普通静态资源和 WebJars 资源的存放路径与 URL 访问路径映射关系，同时遵循 Controller 映射优先级高于静态资源映射的规则，确保请求匹配的合理性。

springboot静态资源映射规则源码解析

首先我们找到 spring-boot-autoconfigure 的jar包，点击 spring.factories 文件，找到 org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration,
进入 WebMvcAutoConfiguration 核心配置类

SpringBoot 之所以能访问到静态资源，本质是 WebMvcAutoConfiguration 自动配置类中，通过 addResourceHandlers 方法注册了默认的资源处理器

下面具体简述该函数代码

第一部分：加载缓存配置

点击进入 ResourceProperties

这是静态资源相关配置的绑定类，可以在 application.yml/properties 静态资源配置中进行设置和静态资源有关的参数，包括缓存时间等

第二部分：注册 WebJars 专用资源处理器

Webjars 是以 jar 包的方式引入静态资源，Webjars 的网址为 https://www.webjars.org/

由代码可知所有以 /webjars/ 开头的请求都会被该处理器处理，WebJars 组件的 Jar 包中静态资源默认存放在 classpath:META-INF/resources/webjars/ 目录下

下面以引入 jQuery 为例进行演示
使用方式是导入 org.webjars 的相关依赖

        <dependency>
            <groupId>org.webjars</groupId>
            <artifactId>jquery</artifactId>
            <version>3.3.1</version>
        </dependency>

访问方式是访问 classpath:META-INF/resources/webjars/ 目录下的内容，例如访问 jquery 的路径为：localhost:8080/webjars/jquery/3.3.1/jquery.js

第三部分是：注册普通静态资源处理器

点击 getStaticPathPattern 函数进入 WebMvcProperties 类中，里面 staticPathPattern 注册 URL 访问路径模式，默认是 /**（所有未被 Controller 处理的请求），可通过配置修改

点击 getStaticLocations 函数进入 ResourceProperties 类中，里面 staticLocations 读取默认 / 自定义的静态资源目录，默认值为四个目录

优先级从高到低（同名文件会优先访问优先级高的目录）：
静态资源 classpath:/META-INF/resources/，即项目内实际存放路径 src/main/resources/META-INF/resources/
静态资源 classpath:/resources/，即项目内实际存放路径 src/main/resources/resources/
静态资源 classpath:/static/，即项目内实际存放路径 src/main/resources/static/
静态资源 classpath:/public/，即项目内实际存放路径 src/main/resources/public/

下面我们来看在 WebMvcAutoConfiguration 自动配置类中 SpringBoot 的默认欢迎页的自动配置核心

welcomePageHandlerMapping 函数专门处理欢迎页的 HandlerMapping

getWelcomePage() 函数用于查找静态资源目录和模板目录下的 index.html，严格遵循静态资源默认目录优先级进行查找，只要其中任意一个目录下有 index.html，就返回该资源路径。
另外，如果通过 spring.web.resources.staticLocations 自定义了静态资源目录，getWelcomePage() 也会在自定义目录中查找 index.html

由代码可知这个方法的本质是向 SpringMVC 容器注册一个 WelcomePageHandlerMapping 实例，它是一个请求处理器映射器（HandlerMapping），专门处理根路径（/）请求，自动查找并返回项目中的 index.html 作为欢迎页。

访问 http://localhost:8080/ 自动打开欢迎页的效果

到此这篇关于springboot静态资源映射规则的使用小结的文章就介绍到这了,更多相关springboot静态资源映射规则内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

最新评论