SpringBoot中静态资源映射详解

在现代 Web 应用开发中，静态资源（如 Javascript、CSS 和 HTML 文件）的管理至关重要。Spring Boot 提供了简洁且强大的机制来处理这些资源，极大地简化了开发流程。

1. 概述

Spring Boot 自动配置了许多静态资源映射规则，使得开发者无需手动配置即可轻松访问静态文件。官方文档：Spring Boot 官方文档。

Spring Boot 默认提供了三种静态资源映射规则：

• WebJars 映射


• 默认静态资源映射


• 静态首页映射

2. WebJars 映射

Web 应用通常需要引入大量的前端库（如 jQuery、Bootstrap 等）。对于传统的 Java Web 项目，这些库会被放置在 webapp 目录下。然而，在 Spring Boot 项目中，由于其打包为 JAR 文件，不存在 webapp 目录。WebJars 解决了这一问题，它允许以 JAR 包的形式引入前端资源。

WebJars 可以将前端资源打包成 JAR 文件，并发布到 Maven 仓库中进行统一管理。开发者只需在项目的 pom.xml 文件中添加相应的依赖即可使用这些资源。所有 WebJars 资源都存放在类路径下的 /META-INF/resources/webjars/ 目录中。

Spring Boot 通过 WebMvcAutoConfiguration 类自动配置了 WebJars 的映射规则，部分源码如下：

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/");
        // 其他映射规则
    }
}

这意味着所有以 /webjars/** 开头的请求都会被映射到 classpath:/META-INF/resources/webjars/ 目录。

示例：引入 jQuery

1. 在 pom.xml 文件中添加以下依赖：

    org.webjars
    jquery
    3.6.0

2. 启动 Spring Boot 项目后，可以通过浏览器访问 http://localhost:8080/webjars/jquery/3.6.0/jquery.js 来验证 jQuery 是否成功引入。

3. 默认静态资源映射

当访问任意资源时，Spring Boot 会按照以下顺序查找静态资源文件：

1. classpath:/META-INF/resources/


2. classpath:/resources/


3. classpath:/static/


4. classpath:/public/

优先级从高到低依次为：classpath:/META-INF/resources/ > classpath:/resources/ > classpath:/static/ > classpath:/public/。Spring Boot 会根据请求路径，依次在这些目录中查找静态资源，直到找到匹配的文件。

4. 静态首页映射

静态首页（或欢迎页）通常是一个名为 index.html 的文件，位于静态资源文件夹中。当用户访问根路径（如 / 或 /index.html）时，Spring Boot 会自动加载该文件作为首页。查找顺序与默认静态资源相同，即优先查找高优先级的目录。