SpringBoot 配置文件修正和参数覆盖
- SpringBoot 配置文件加载和参数覆盖
- 1、SpringBoot 配置文件加载
- 1.1、修改application.properties的参数几种方式
- 1.2、方法一:直接CMD
- 1.3、方法二:系统变量配置
- 1.4、方法三:程序运行配置
- 1.5、方法四:外部加载
- 2、SpringBoot 启动参数覆盖
- 2.1、不指定profile的加载顺序
- 2.2、指定profile的加载顺序
- 3、使用外部配置
- 3.1、扩展nacos开启本地覆盖远程配置
- 外部参考
SpringBoot 配置文件加载和参数覆盖
SpringBoot 或者SpringCloud 有配置文件加载和参数修改的机制,本文将从两个角度阐述参数修改和配置文件启动覆盖问题。
1、SpringBoot 配置文件加载
以下几种方式都可以被@Value读取到
- java -jar -Dserver.port=8080 -Xms1024m demo.jar
- java -jar demo.jar --server.port=8080
- 从操作系统的环境变量中读取
- 通过项目中配置文件bootstrap/application文件载入
1.1、修改application.properties的参数几种方式
- 方法一:直接在cmd中执行
- 方法二:系统变量配置
- 方法三:程序运行配置
- 方法四:外部加载
1.2、方法一:直接CMD
java -jar xxx.jar --server.port:8082
如果要修改多个参数,空格后继续写就可以了。再例如:java -jar xxx.jar --server.port:8082 --test.name=xxx
1.3、方法二:系统变量配置
1.4、方法三:程序运行配置
1.5、方法四:外部加载
springboot 有读取外部配置文件的方法,如下优先级:
第一种是在jar包的同一目录下建一个config文件夹,然后把配置文件放到这个文件夹下。
第二种是直接把配置文件放到jar包的同级目录。
第三种在classpath下建一个config文件夹,然后把配置文件放进去。
第四种是在classpath下直接放配置文件。
我们通常在src/main/resources 文件夹下创建的application.properties 文件的优先级是最低的!
1)内外都有配置文件,配置文件读取是有优先级,外配置文件优于内配置文件读取。
2)如果内配置文件里有外配置文件没有的配置,那两者互补。比如外配置文件没有配置数据库,内配置文件里配置了数据库,那内配置文件的配置会被使用。
3)如果内配置文件里和外配置文件里都有相同的配置,比如两者都配置了数据库,但是两个连接的不同,那外配置文件会覆盖内配置文件里的配置。
2、SpringBoot 启动参数覆盖
2.1、不指定profile的加载顺序
首先,在默认的情况下也就是不存在活动的profile(即不指定spring.profiles.active=?)时,四种文件的加载优先级依次为bootstrap.properties -> bootstrap.yml -> application.properties -> application.yml。
总结:bootstrap的配置先于application的配置加载,同时.properties的加载又先于.yml的加载,即加载优先级bootstrap.properties -> bootstrap.yml -> application.properties -> application.yml。
需要注意的是:
- 当同一个配置属性在bootstrap.properties和bootstrap.yml文件中都存在时,那么properties中的配置会被加载,而忽略yml文件中的配置(即优先级高的配置覆盖优先级低的配置),不同配置相互互补。此处application(.properties/yml)同理。
- 但当同一配置在bootstrap.properties和application.properties中都存在时,那么虽然优先加载bootstrap.properties但是会被applicatioin.properties中的配置覆盖,此时则变成了低优先级覆盖高优先的配置,所以网上很多文章所说的高优先级覆盖低优先级其实是不严谨的。
- 不同的配置会进行互补操作,即SpringBoot会读取全部的配置文件,加载所有不同的配置项,汇成一个总的配置。
2.2、指定profile的加载顺序
例如在指定了spring.profiles.active=dev/test/prod此类时,即指定profile时,加载优先级便会发生变化此时活动的优先级最高。
当指定dev时:
此时的加载优先级变为了bootstrap-dev.yml -> bootstrap.properties -> application-dev.yml ->application.properties。且同属性配置的覆盖问题和之前一样,在同为bootstrap或同为application的情况下,优先级高的覆盖优先级低的。但当同时存在bootstrap和application时后者仍会覆盖前者中的配置。
**举例1:**假如此时只有bootstrap-dev.yml 和bootstrap.properties且存在相同配置,则使用bootstrap-dev.yml中的配置,此时遵循高优先级覆盖低优先级。
**举例2:**假如此时有bootstrap-dev.yml 、bootstrap.properties及application.properties且存在相同配置,则使用application.properties中的配置,遵循application覆盖bootstrap原则,同样此时变成了低优先级覆盖高优先级。
3、使用外部配置
如项目使用nacos做配置中心,则存在相同配置时以nacos中配置为主(在没有开启本地覆盖nacos远程配置的情况下),nacos中的配置将会覆盖一切本地相同的配置,不同配置可以和本地进行互补。
3.1、扩展nacos开启本地覆盖远程配置
如果需要启动参数或者本地配置覆盖远程配置,那么需要在远程配置里配置上允许重写:
spring.cloud.config.allowOverride=true
但这是不够的,尽管它开启了总开关,但是还有两个默认的小开关卡住了。
应同时添加如下配置:
spring.cloud.config.overrideNone=true
spring.cloud.config.overrideSystemProperties=false
第一个开关是远端不覆盖本地?true 是的不覆盖。
第二个开关是远端是否覆盖系统配置?false 不覆盖。 (默认为true 覆盖)
请注意,第一个小开关包括第二个。
overrideNone = true的话会开启所有包括本地配置和系统配置并忽略掉overrideSystemProperties配置。
如果只想开启overrideSystemProperties,那么就是overrideNone = false,overrideSystemProperties=false。
外部参考
- springBoot项目配置文件加载优先级及同配置覆盖问题
- springboot 启动修改application.properties中的参数的方法