Spring Boot静态资源访问和配置全解析(看不懂你打我)

骑猪看日落 2022-05-19 12:47 170阅读 0赞

*   *   *  一、默认静态资源映射规则
         *  二、自定义静态资源映射规则
            
             *  2.1 自定义静态资源映射类
             *  2.2 在application.properties中进行配置
                
                 *  2.2.1 配置静态资源访问路径
                 *  2.2.2 配置静态资源目录

> 在web开发中，静态资源的访问时必不可少的，比如image、css、js等。SpringBoot对静态资源访问提供了很好的支持，使用其提供的基本默认配置基本可以满足开发需求，同时，又支持开发人员进行自定义配置。

### 一、默认静态资源映射规则 ###

**Spring Boot 默认将 /** 所有访问映射到以下目录：\*\*

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

接下来，在`main/resources`下新建`static`、`public`和`resources`三个文件夹，分别放入`a.png`、`b.png`和`c.png`三张图片，如下：  
![这里写图片描述][70]  
启动项目，分别访问：

http://localhost:8083/a.png
    http://localhost:8083/b.png
    http://localhost:8083/c.png

发现都能正常访问相应的图片资源。那么说明，`Spring Boot` 默认会挨个从 `public`、`resources`和`static` 里面找是否存在相应的资源，如果有则直接返回。

### 二、自定义静态资源映射规则 ###

#### 2.1 自定义静态资源映射类 ####

追溯源码发现，在`WebMvcAutoConfiguration`类中，有如下代码：

public void addResourceHandlers(ResourceHandlerRegistry registry) {
                if(!this.resourceProperties.isAddMappings()) {
                    logger.debug("Default resource handling disabled");
                } else {
                    Duration cachePeriod = this.resourceProperties.getCache().getPeriod();
                    CacheControl cacheControl = this.resourceProperties.getCache().getCachecontrol().toHttpCacheControl();
                    if(!registry.hasMappingForPattern("/webjars/**")) {
                        this.customizeResourceHandlerRegistration(registry.addResourceHandler(new String[]{
       "/webjars/**"}).addResourceLocations(new String[]{
       "classpath:/META-INF/resources/webjars/"}).setCachePeriod(this.getSeconds(cachePeriod)).setCacheControl(cacheControl));
                    }
    // 此处做的就是静态资源文件夹映射
                    String staticPathPattern = this.mvcProperties.getStaticPathPattern();
                    if(!registry.hasMappingForPattern(staticPathPattern)) {
                        this.customizeResourceHandlerRegistration(registry.addResourceHandler(new String[]{staticPathPattern}).addResourceLocations(getResourceLocations(this.resourceProperties.getStaticLocations())).setCachePeriod(this.getSeconds(cachePeriod)).setCacheControl(cacheControl));
                    }
    
                }
            }

通过追溯`staticPathPattern`，在`ResourceProperties`类中，发现如下常量信息被设置：

private static final String[] CLASSPATH_RESOURCE_LOCATIONS = new String[]{
       "classpath:/META-INF/resources/", "classpath:/resources/", "classpath:/static/", "classpath:/public/"};

到此，就可以发现，这就是`Spring Boot`为我们提供的默认静态资源映射，那么自定义映射规则的话，继承`WebMvcConfigurer`即可。如下：

@Configuration
    public class MyWebMvcConfig implements WebMvcConfigurer { 
        @Override
        public void addResourceHandlers(ResourceHandlerRegistry registry) {
            // 将/static/**访问映射到classpath:/mystatic/
            registry.addResourceHandler("/static/**").addResourceLocations("classpath:/mystatic/");
        }
    }

在`main/resources`下新建`mystatic`文件夹，并放入`d.png`图片。  
启动项目，访问如下链接：  
`http://localhost:8083/static/d.png`  
发现，可以正常请求`d.png`图片。

#### 2.2 在`application.properties`中进行配置 ####

##### 2.2.1 配置静态资源访问路径 #####

在`application.properties`中配置如下：

spring.mvc.static-path-pattern=/mystatic/**

重启项目，再访问静态资源，需要以`mystatic`开头，如下：  
`http://localhost:8083/mystatic/a.png`  
这样，仍可以访问之前的`a b c`三张图片。如果按照之前`http://localhost:8083/a.png`就不能再访问到了。

##### 2.2.2 配置静态资源目录 #####

在`application.properties`中，增加如下配置：

# 配置静态资源访问前缀
    spring.mvc.static-path-pattern=/mystatic/**
    # 配置静态资源路径，默认配置失效
    spring.resources.static-locations[0]=classpath:/mystatic
    spring.resources.static-locations[1]=classpath:/public

重启项目，访问：  
`http://localhost:8083/mystatic/a.png`  
发现可以正常访问，同理，`mystatic`和`static`中静态资源都可以正常访问。  
但当访问`resources`和`static`里静态资源时，就会`404`报错，访问不到了，这个是因为配置文件中如果进行了静态资源路径的配置，那么默认的配置就失效了。

好了，到此关于`Spring Boot`的静态资源访问和配置就介绍到这了，如有问题，欢迎留言~

[70]: /images/20220519/885bb03202e74d979352b230db3c0ec7.png