Spring MVC静态资源映射

本文详细介绍了Spring MVC中静态资源的映射规则,包括默认的静态资源路径、静态资源与动态资源的优先级处理、自定义欢迎页、设置自定义小图标以及定制错误页面的方法。通过示例展示了如何配置和访问静态资源,以及在冲突时Spring MVC的处理策略。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

Spring MVC静态资源映射

我们在做路径映射规则时,有时候我们并不想要匹配一个页面,或者返回数据,而是返回一个静态资源(类似图片等),这时候就需要用到Spring MVC的静态资源映射规则

默认静态资源路径

在Spring Boot中已经规定了一些包路径下的资源是静态资源,在默认的情况下,这个包下的静态资源是可以直接访问的

在这里插入图片描述

由官方文档可知,当我们将静态资源放在以下包中,可以直接访问

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

我们以classpath:/static为例

在这里插入图片描述

我在项目的类路径下的static包中放了一张图片,然后我们启动项目,在浏览器中看是否可以直接访问到这张图片

在这里插入图片描述

可以看到是可以直接访问到的

静态资源和动态资源的优先级

现在有一个问题,假设我们现在有一个动态资源请求路径,跟我们的静态资源路径名称相同,那么Spring MVC会怎样处理呢?

我们在项目中增加一个请求映射,请求路径和图片名相同,但是返回一个字符串,然后查看访问路径的结果

@RestController
public class MyController {
   

    @RequestMapping("/spring.png")
    public String spring(){
   
        return "spring";
    }
}

在这里插入图片描述

从结果可以看到,Spring MVC走了动态资源映射规则,原理是当一个请求发送过来时,Spring MVC的视图解析器会先去匹配动态资源,如果匹配不到,再去匹配静态资源,如果静态资源也没有匹配到,就会报404错误

自定义欢迎页

如果我们需要一个欢迎页,也就是在访问路径不加任何uri的时候映射到的一个页面,只需要将欢迎页命名为index.html,并放置在静态资源路径下,即可生效

### 如何在 Spring MVC 中配置静态资源映射以支持 Swagger 为了使 Spring MVC 支持 Swagger 的功能,除了需要引入必要的依赖外,还需要正确配置静态资源映射以便能够访问 Swagger UI 页面及其相关资源。以下是具体的实现方法: #### 1. 添加 Maven 依赖 确保项目的 `pom.xml` 文件中包含了 Swagger 和 Spring MVC 所需的依赖项。 ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> ``` 这些依赖会帮助加载 Swagger 功能以及其前端界面所需的静态文件[^1]。 --- #### 2. 创建 Docket Bean 配置类 通过定义一个配置类来初始化和设置 Swagger 的核心组件——Docket Bean。 ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; @Configuration public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage("com.example.controller")) // 替换为实际 Controller 包路径 .paths(PathSelectors.any()) .build(); } } ``` 上述代码片段展示了如何创建一个用于启用 Swagger 文档生成功能的 Docket 实例,并指定 API 接口所在的包名。 --- #### 3. 配置静态资源映射 为了让浏览器可以正常加载 Swagger UI 的 HTML、CSS 和 JavaScript 文件,必须显式声明对这些静态资源的支持。可以通过重写 WebMvcConfigurer 的 `addResourceHandlers` 方法完成此操作。 ```java import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; @Configuration public class WebConfig implements WebMvcConfigurer { @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { // 映射 Swagger UI 的静态资源 registry.addResourceHandler("/swagger-ui/**") .addResourceLocations("classpath:/META-INF/resources/webjars/springfox-swagger-ui/"); // 如果存在其他自定义静态资源目录,则继续添加处理规则 registry.addResourceHandler("/static/**") .addResourceLocations("classpath:/static/"); } } ``` 这段代码的作用是告诉 Spring MVC 将 `/swagger-ui/**` 请求转发到对应的静态资源位置,从而允许客户端顺利获取 Swagger UI 界面所需的内容[^3]。 --- #### 4. 启动应用并测试 启动应用程序后,在浏览器地址栏输入如下 URL 即可查看 Swagger UI 界面: ``` http://localhost:8080/swagger-ui/index.html ``` 如果一切配置无误,应该可以看到完整的接口文档页面。 --- ### 注意事项 - **版本兼容性**:确保使用的 Spring Boot 或 Spring MVC 版本与 Swagger 库版本相匹配,以免因不兼容而导致错误。 - **安全性考量**:生产环境中建议关闭或限制对外暴露的 Swagger 访问权限,防止敏感信息泄露。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值