Spring Boot资源文件问题总结（Spring Boot的静态资源访问，配置文件外置）

浅浅的花香味﹌ 2022-10-31 13:39 401阅读 0赞

文件系统是我们开发过程中常常会接触的问题。那么在Spring Boot框架中，文件的访问又是什么样的呢？今天在此做一个总结。

# 1，file和classpath #

存放在电脑上实际位置的文件，在Spring Boot中用file:开头表示。例如：

file:a.txt   当前目录下的a.txt文件。当前路径在开发环境下一般为Maven项目的目录下（与pom.xml同目录下），在打包为jar文件后当前路径即为运行jar文件时的**运行路径**。

file:D:\\a.txt    表示绝对路径，在此不多赘述。

而在jar文件内部中，我们一般把文件路径称为classpath，所以读取内部的文件就是从classpath内读取，classpath指定的文件不能解析成File对象，但是可以解析成InputStream。例如：

classpath:/a.txt    jar包根目录下的a.txt。

classpath以/开头表示绝对路径，即为jar包根目录。

# 2，Spring Boot的静态资源访问 #

我们都知道Spring工程文件夹中的src\\main\\resources是用于存放资源的地方。默认时Spring打包之后静态资源位置如下：

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

在Spring中classpath的根目录就对应工程文件夹下src\\main\\resources。

可以先看这个例子：

在工程文件夹下src\\main\\resources\\static下放入图片qiqi.png：

![20210222220849247.png][]

运行，访问127.0.0.1:8080/qiqi.png，效果如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmhhbmh1aTE_size_16_color_FFFFFF_t_70][]

这个例子可见外部访问的资源路径和Spring工程中资源文件路径的一一对应关系。即外部访问时的“根目录”即对应着上述的四个静态资源位置（classpath）。

还可以新建Controller类，写如下方法：

@GetMapping("/pic")
    public String ShowPic() {
        return "/qiqi.png";
    }

运行，访问127.0.0.1:8080/pic，效果同上。

在这个Controller方法中，上面GetMapping是路由路径，return的是对应的资源路径。

其实这个默认的资源路径是可以修改的。

我们需要知道在配置文件application.properties中可以加入下列两个配置：

1.  spring.mvc.static-path-pattern
2.  spring.resources.static-locations

其中**spring.mvc.static-path-pattern**代表的是应该以什么样的路径来访问静态资源，也就是只有静态资源满足什么样的匹配条件，Spring Boot才会处理静态资源请求。根据上述例子我们知道了这个配置默认值为/\*\*。假设在上述工程配置文件中加入：

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

那么再访问我们那个图片就要访问网址：[127.0.0.1:8080/resources/qiqi.png][127.0.0.1_8080_resources_qiqi.png]

再者，**spring.resources.static-locations**用于指定静态资源文件的查找路径，查找文件是会依赖于配置的先后顺序依次进行。根据上述例子可见这个值默认是：classpath:/static,classpath:/public,classpath:/resources,classpath:/META-INF/resources

其实上面提到了Spring默认资源文件位置，实质上就是这个配置的值。

假设在上述工程中配置文件写入：

spring.resources.static-locations=classpath:/myRes

那么我们要将qiqi.png放在项目文件夹的src\\main\\resources\\myRes文件夹中，才能访问：

![20210222223327978.png][]

配置此项后，默认值将失效！

还可以使用磁盘路径例如：

spring.resources.static-locations=file:res

即指定资源文件在项目文件夹中的res中（即打包后运行jar文件时的**运行路径下**的res文件夹中）。也可以使用绝对路径。

通俗地讲，**spring.mvc.static-path-pattern**配置指定了我们外部访问的“根目录”，**spring.resources.static-locations**配置了对应的资源位置。

# 3，Spring Boot的配置文件外置 #

我们也知道Spring的配置文件默认是位于classpath:/application.properties，默认会被打包进jar文件。

其实我们也可以修改这个配置文件的位置。

在我们的Spring主类上加入如下注解：

@PropertySource(value={"自定义配置文件路径"})

value表示配置文件位置，也可以填多个：

@PropertySource(value={"配置1路径", "配置2路径"})

此处以我的主类全部代码为例：

package com.example.demo;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.context.annotation.PropertySource;
    
    @SpringBootApplication
    @PropertySource(value={"file:self.properties"})
    public class DemoApplication {
    
    	public static void main(String[] args) {
    		SpringApplication.run(DemoApplication.class, args);
    	}
    
    }

即定义配置文件为项目文件夹下的self.properties文件（打包后运行jar文件时的**运行目录下**的self.properties文件）。

[20210222220849247.png]: /images/20221024/77bceda3329846f2839f9fb695f92ff5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmhhbmh1aTE_size_16_color_FFFFFF_t_70]: /images/20221024/a759701a5c36498fa737404dde92b3fa.png
[127.0.0.1_8080_resources_qiqi.png]: http://127.0.0.1:8080/resources/qiqi.png
[20210222223327978.png]: /images/20221024/903ea0e0f75443169f6b225e55b1e439.png