SpringBoot2.x基础篇：配置文件的加载顺序以及优先级覆盖 |
您所在的位置：网站首页 › spring的xml配置文件加载顺序 › SpringBoot2.x基础篇：配置文件的加载顺序以及优先级覆盖 |
SpringBoot2.x基础篇：配置文件的加载顺序以及优先级覆盖
|
SpringBoot约定了配置文件，默认为application.properties，通过该文件可以修改很多默认的配置，当然我们还可以在该配置文件内添加自定义的配置，该文件通过key=value的形式进行配置。 推荐阅读 SpringBoot2.x 教程汇总 疑惑配置提示？当我们使用开发工具来配置时，就会出现相应的提示，这要完全要归功于spring-configuration-metadata.json配置元数据文件，该文件内记录了配置的名称、类型、归属类等信息，如果配置类型为枚举还可以实现选择性配置。 SpringBoot提供了一个依赖，它的主要任务就是自动生成配置元数据，该依赖的名称为 spring-boot-configuration-processor，在打包时会在 META-INF目录生成一个名为 spring-configuration-metadata.json的文件。 配置方式虽然默认使用properties格式的配置文件，不过这种方式会导致配置的部分前缀冗余，可阅读性稍差，SpringBoot内部还支持使用yaml方式的配置文件，只需要在src/main/resources目录下创建一个名为application.yml文件即可，使用配置时同样也有提供功能。 项目内可以同时存在application.properties、application.yml两个文件，经过测试发现，properties优先级会高一些，相同名称的配置，会将yml内的配置覆盖掉。 指定配置文件如果你的应用程序配置文件的名称不是application，你想要进行自定义，可以通过--spring.config.name命令行参数进行指定，如下所示： java -jar project-sample.jar --spring.config.name=custome 注意事项：我们只需要指定配置文件的名称即可，可以使用 properties或 yaml文件格式，上面的配置会加载 src/main/resources/custome.yml或 src/main/resources/custome.properties。通过--spring.config.name仅仅是修改了配置文件的名称，那如果是修改配置文件所处的目录位置，我们需要怎么做呢？ SpringBoot已经给我们准备好了，通过--spring.config.location参数就可以指定配置文件的位置，如下所示： java -jar project-sample.jar --spring.config.location=classpath:/configs/custome.yml如果一个配置文件无法满足你的需求，那你看看下面这个方式： java -jar project-sample.jar --spring.config.location=classpath:/configs/custome.yml,classpath:/configs/default.properties 注意事项：支持通过命令行参数的方式指定多个配置文件，使用英文半角 , 隔开即可。如果你通过spring.config.location指定的不是一个文件而是一个目录，在路径最后务必添加一个"/"结束，然后结合spring.config.name进行组合配置文件，组合示例如下： # 加载/configs/application.properties 或 /configs/application.yml（默认文件名） java -jar project-sample.jar --spring.config.location=classpath:/configs/ # 加载/configs/custome.properties 或 /configs/custome.yml java -jar project-sample.jar --spring.config.location=classpath:/configs/ --spring.config.name=custome 注意事项： spring.config.name该配置参数默认值为 application，所以如果只是指定了 spring.config.location并为目录形式，上面示例中会自动将 spring.config.name追加到目录路径后，如果指定的 spring.config.location并非是一个目录，这里会忽略 spring.config.name的值。 加载顺序SpringBoot应用程序在启动时会遵循下面的顺序进行加载配置文件： 类路径下的配置文件 类路径内config子目录的配置文件 当前项目根目录下的配置文件 当前项目根目录下config子目录的配置文件示例项目配置文件存放结构如下所示： . project-sample ├── config │ ├── application.yml （4） │ └── src/main/resources | │ ├── application.yml （1） | │ └── config | | │ ├── application.yml （2） ├── application.yml （3）启动时加载配置文件顺序：1 > 2 > 3 > 4 src/main/resources下的配置文件在项目编译时，会放在 target/classes下。 优先级覆盖SpringBoot配置文件存在一个特性，优先级较高的配置加载顺序比较靠后，相同名称的配置优先级较高的会覆盖掉优先级较低的内容。 为了更好地解释这一点，我们根据对应的加载顺序分别创建一个application.yml配置文件，来验证根据优先级的不同是否存在覆盖问题，如下图所示：
在上面四个配置文件中都有一个名为name的配置，而红色字体标注的内容就是每个配置文件name的配置内容，下面我们来启动项目测试下输出内容。 运行测试在测试之前我们让启动类实现CommandLineRunner接口，如下所示： @SpringBootApplication public class LoadOrderOfConfigFilesApplication implements CommandLineRunner { public static void main(String[] args) { SpringApplication.run(LoadOrderOfConfigFilesApplication.class, args); } @Value("${name}") private String name; @Override public void run(String... args) throws Exception { System.out.println("配置名称：" + name); } }项目启动后通过run方法进行打印${name}配置的内容。 测试一：顺序覆盖保留上面四个对应加载顺序的配置文件，启动项目，控制台输出内容： 配置名称：project/config期望与实际输出是符合的，项目根下的config目录是最后加载的，所以它的优先级相对其他三个来说是最高的，覆盖顺序为：4 > 3 > 2 > 1。 测试二：跨顺序覆盖上一个测试点我们对每一个加载顺序都对应添加了一个配置文件，那如果我们只有两个project/config、classes/config两个目录的配置文件，是否按照优先级进行覆盖呢？ 删除另外两个，只保留project/config、classes/config两个位置的配置文件，启动项目控制台输出如下所示： 配置名称：project/config同样是输出了优先级最高的project/config配置文件的内容，覆盖顺序为：4 > 1 测试点：单顺序加载平时在项目开发中一般都是将application.yml配置文件放在src/main/resources目录下，然而根据上面的加载顺序来看，我们可以将配置文件放置在任意一处，启动时都会进行加载。 仅保留classes/config位置的配置文件，启动项目控制台输出内容如下所示： 配置名称：classes/configIDEA对SpringBoot的支持真的很强大， classes/config下的配置文件同样提供了关键字提醒功能。 总结了解配置文件的加载顺序，才能得心应手的进行配置覆盖，完全控制在不同环境下使用不同的配置内容，要记住classes/application.yml优先级最低，project/config/application.yml优先级最高。 |
【本文地址】
今日新闻 |
推荐新闻 |