静态资源
- 默认静态资源目录
-
Spring Boot默认将以下目录作为静态资源目录,并且可以直接访问其中的资源:
- classpath:/META-INF/resources/
- classpath:/resources/
- classpath:/static/
- classpath:/public/
- ${user.dir}/public/(程序运行目录下的public目录)
这些目录的优先级从上到下,当多个静态资源目录中出现同名文件时,越靠上的目录权重越高。
- 静态资源的处理
- 静态资源的处理类是ResourceHttpRequestHandler,它会正确地处理资源的Last-Modified响应和Range请求。
- 静态资源和RequestMapping冲突
- 如果静态资源路径和@RequestMapping路径冲突,则@RequestMapping优先。例如,如果有一个@RestController返回了/foo,同时在public目录下有一个名为foo的文本文件,访问http://localhost:8080/foo时,响应的内容将是@RestController返回的内容,而不是静态文件的内容。
- 默认主页
- 静态资源根目录中的index.html会被当做应用默认的主页。这意味着创建Spring Boot应用后不需要创建Controller,就可以快速地开发一个应用主页。
- 自定义静态资源目录
-
有两种方式自定义静态资源目录:配置文件和配置类。
- 在配置文件中配置静态资源目录
xml# 静态资源的访问路径 spring.mvc.static-path-pattern=/** # 静态资源的目录 spring.web.resources.static-locations[0]=classpath:/public/ spring.mvc.static-path-pattern指定了静态资源的访问路径,默认为/**,也就是没有前缀。你可以专门为静态资源配置一个访问路径,如:spring.mvc.static-path-pattern=/static/**。
- 通过WebMvcConfigurer配置静态资源目录
通过WebMvcConfigurer配置接口的addResourceHandlers方法,可以编程式地配置静态资源访问路径和静态资源目录:
java
@Configuration
public class WebMvcConfiguration implements WebMvcConfigurer {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
// 静态资源访问路径
registry.addResourceHandler("/**")
// classpath下的静态资源目录
.addResourceLocations("classpath:/public/")
// 本地磁盘下的静态资源目录
.addResourceLocations("file:D:\\upload\\");
}
}
这种方式不支持使用${}表达式。
- 原理分析
Spring Boot在启动时会加载许多自动配置类,其中WebMvcAutoConfiguration类负责Spring MVC的大部分自动配置。这个类中的WebMvcAutoConfigurationAdapter静态内部类是一个配置类,它将配置文件的属性与WebMvcProperties、ResourceProperties和WebProperties等类进行绑定。
通过分析WebMvcAutoConfigurationAdapter的源码,我们可以了解到静态资源的默认配置规则,以及如何通过编程方式自定义这些规则。例如,可以通过设置add-mappings属性为false来禁用默认的静态资源路径映射,从而自定义静态资源的访问路径和目录。
配置文件加载优先级
- 命令行参数
命令行参数具有最高的优先级,它们可以覆盖任何其他配置文件中的设置。例如,通过 --spring.config.location 参数可以指定配置文件的位置 - bootstrap配置文件
bootstrap配置文件用于基础设置和安全配置,它们在应用程序启动时最早被加载。bootstrap配置文件的加载顺序如下:- bootstrap.yaml
- bootstrap.properties
- bootstrap-{profile}.yaml
- bootstrap-{profile}.properties
- 主配置文件
主配置文件application.yaml或application.properties在bootstrap配置文件之后加载。 - Profile特定的配置文件
如果定义了激活的profile,Spring Boot会加载与该profile相关的配置文件,例如application-dev.yaml或application-dev.properties。 - 外部配置文件
Spring Boot也可以从外部位置加载配置文件,例如通过--spring.config.location指定的文件或目录
。 - 配置文件的位置
Spring Boot会在以下位置加载配置文件,按照以下顺序:- 文件系统下的/config子目录。
- 文件系统当前目录。
- 类路径下的/config包。
- 类路径根目录。 这些位置的配置文件会被按照上述顺序加载,高优先级的配置会覆盖低优先级的配置
。
- 配置文件的格式优先级
如果存在同名的配置项,.properties文件中的配置项会覆盖.yaml或.yml文件中的配置项
。 - 环境变量和系统属性
环境变量和系统属性也会影响配置,但它们的优先级低于命令行参数和配置文件
。 - @PropertySource注解
通过@PropertySource注解指定的配置文件具有特定的优先级,可以在配置文件中定义额外的配置源
。
java
@Configuration
@PropertySource(value = "classpath:/app-config.properties", encoding = "UTF-8")
public class AppConfig {
// 这个类可以包含 Bean 定义或其他配置
}