<返回更多

Springboot配置文件加载路径及使用方式你真的都了解了吗?

2021-09-26    睿智Java研发架构师
加入收藏

环境:Springboot2.4.10


当应用程序启动时,Spring Boot将自动从以下位置查找并加载Application.properties和application.yaml文件:

  1. 从Classpath类路径classpath的根类路径classpath下的/config包
  2. 从当前目录当前目录当前目录中的/config子目录/config子目录的直接子目录

列表按优先级排序(较低项的值优先于较早项)。加载文件中的文档作为PropertySources添加到Spring环境中。

上面的加载顺序是倒着的。

  1. 修改加载的配置文件名称

默认是加载的以application的配置文件,可以通过spring.config.name启动参数进行修改:

JAVA -jar myproject.jar --spring.config.name=myproject
  1. 修改配置文件路径

使用spring.config.location属性显式指定位置。此属性接受以逗号分隔的列表,其中包含一个或多个要检查的位置。

java -jar myproject.jar --spring.config.location=optional:classpath:/default.properties,optional:classpath:/override.properties

这里的optional前缀的意思是:

如果位置是可选的,并且您不介意它们是否不存在。简单说就是这些路径下的文件是可选的。

  1. 配置文件位置

如果spring.config.location包含目录(与文件相反),则它们应以/结尾。在运行时,它们将在加载之前附加从spring.config.name生成的名称。直接导入spring.config.location中指定的文件。

1.1 可选位置

默认情况下,当指定的配置数据位置不存在时,Spring Boot将抛出
ConfigDataLocationNotFoundException,应用程序将不会启动。

如果要指定一个位置,但不介意它是否总是存在,则可以使用optional:作为前缀 。你可以将此前缀与spring.config.location和
spring.config.additional-location属性以及spring.config.import声明一起使用。

例如,spring.config.import值
optional:file:./myconfig.properties允许启动应用程序,即使myconfig.properties文件丢失。

如果要忽略所有
ConfigDataLocationNotFoundException并始终继续启动应用程序,可以使用
spring.config.on-not-found属性。使用
SpringApplication.setDefaultProperties(...)或使用系统/环境变量。

1.2 通配符位置

如果配置文件位置包含最后一个路径段的*字符,则将其视为通配符位置。在加载配置时,通配符会展开,以便同时检查直接子目录。在Kube.NETes这样的环境中,当存在多个配置属性源时,通配符位置特别有用。

例如,如果你有一些redis配置和一些MySQL配置,你可能希望将这两个配置分开,同时要求它们都存在于application.properties文件中。这可能会导致两个单独的application.properties文件装载在不同的位置,例如
/config/redis/application.properties和/config/mysql/application.properties。在这种情况下,如果通配符位置为config/*/,将导致处理这两个文件。

默认情况下,Spring Boot在默认搜索位置包含config/*/。这意味着将搜索jar之外的/config目录的所有子目录。

您可以将通配符位置与spring.config.location和
spring.config.additional-location属性一起使用。

1.3 特定配置文件

除了应用程序属性文件外,Spring Boot还将尝试使用命名约定应用程序{profile}加载特定于概要文件的文件。例如,如果应用程序激活名为prod的概要文件并使用YAML文件,则将同时考虑application.yml和application-prod.yml。

特定于配置文件的属性从与标准application.properties相同的位置加载,特定于配置文件的文件始终覆盖非特定文件。如果指定了多个配置文件,则应用最后一个wins策略。例如,如果prod、live(即顺序为:prod, live)配置文件由spring.profiles.active属性指定,则
application-prod.properties中的值可以被application-live.properties中的值覆盖。

1.4 导入其它数据

应用程序属性可以使用spring.config.import属性从其他位置导入更多配置数据。导入会在发现时进行处理,并被视为插入声明导入的文档下方的附加文档。

例如:

spring:
  config:
    import:
    - optional:classpath./config/cfg.yml  

这里的optional表示可选的,即导入的文件可以不存在;

看如下情况:

cfg.yml配置文件内容

cfg:
  name: classpath:/config
spring:
  config:
    import:
    - optional:classpath:/config/cfg.yml
---  
cfg:
  name: a1    

这里的a1会覆盖import中的值

cfg:
  name: a1
---  
spring:
  config:
    import:
    - optional:classpath:/config/cfg.yml   

这里cfg.yml配置的值会覆盖a1值

可以在单个spring.config.import键下指定多个位置。位置将按照其定义的顺序进行处理,以后的导入将优先。

注意:官方文档说上面的两种顺序配置,产生的是同样的效果,但是我这测试的后面的会替换前面的。

1.5 导入无扩展名文件

某些云平台无法向卷装载的文件添加文件扩展名。要导入这些无扩展文件,您需要给Spring Boot一个提示,以便它知道如何加载它们。可以通过将扩展提示放在方括号中来实现这一点。

例如,假设你有一个/etc/config/myconfig文件,希望将其作为yaml导入。您可以使用以下命令从application.properties导入它:

spring:
  config:
    import: "file:/etc/config/myconfig[.yaml]"

完毕!!!

声明:本站部分内容来自互联网,如有版权侵犯或其他问题请与我们联系,我们将立即删除或处理。
▍相关推荐
更多资讯 >>>