springboot复杂配置文件

Ⅰ Springboot 读取配置文件原理

Springboot 读取配置文件(application.yaml, application.properties)的过程发生在SpringApplication#prepareEnvironment() 阶段，而prepareEnvironment又属于整个Springboot 应用启动的非常前置阶段，因为Environment的准备是后续bean创建的基础。让我们来一探启动是的详细code。除去StopWatch这些code，可以发现prepareEnvironment 发生在SpringApplication#run 这在整个应用启动的多步实质性操作中几乎是第一步。

而prepareEnvironment中最重要的是通过触发listener（EventPublishingRunListener）来通过#multicastEvent发出。

而#multicastEvent的实现其实也很简单，找到相关的监听的listener，然后一个个的调用他们的Listener#onApplicationEvent(event)方法，而这其中就包括了处理configuration文件的listener。
在Springboot 2.4.0 之前这个处理configuration 文件的lister是ConfigFileApplicationListener，在2.4.0之后，处理configuration 文件的lister是，并且对configuration文件的加载做了较大的改变，导致一些行为可能出现了变化，这也就是下面要详细讲的内容。

Springboot 2.4.0之后，configuration 文件的load顺序按照优先级是如下顺序(序号大的会被小的覆盖）：

和之前版本比较，整体的属性加载顺序并无调整，只有Application properties（14，15）这里有顺序的调整，具体调整为：

如果存在多个active的profiles，例如[Test, Dev], 那么对于同时存在两个profile 配置文件中的配置，后面的profile里的配置（Dev）会覆盖前面profile(Test)里配置的值。

前面讲了这么多，终于要引出Springboot 2.4之后配置文件加载的行为变化了。

考虑这样的情况，如果我想在跑Springboot test的时候指定特定的profile，那么可以在Test class中加入@ActiveProfile("Test")。 如果我的应用中存在的某个自定义listener中，会根据当前environment 设置profile，如env.addActiveProfile("Dev")。
当前就会有两个active profile，由于springboot-test会在调用application#run 前利用DefaultActiveProfilesResolver把@ActiveProfile注解定义的profile（Test）先加入了active的profile，等test run的时候 env.addActiveProfile("Dev") 又会把"Dev"也作为active profile 加入，这时候当前的active profile便为["Test", "Dev"]。

据上面介绍，后面的profile(Dev)对应的configuration 会覆盖前面的(Test)。可Springboot 2.4.0之前的版本为我们做了调整，让Test class中@ActiveProfile内定义的profile所对应的配置文件成为最高优先级。

刚才提到在Springboot 2.4.0 之前这个处理configuration 文件的lister是ConfigFileApplicationListener，我们
来看看ConfigFileApplicationListener的相关code。

查看initializeProfiles()，发现此时对profile的顺序做了调整，将activatedViaProperty (Test) 放在最后add，于是profile的顺序就变成了[Dev, Test]。

在profiles.poll()时原本profile的顺序已经倒了过来，已经变为[Dev, Test], 在load()方法中由于后置的Test profile，application-Test.yaml中的值最终生效了。

可是到了Springboot2.4.0之后，ConfigFileApplicationListener被deprecated了，取而代之的是，通过调用来完成configuration加载。
.java

.java

只是老老实实的set了active profile，并没有调换profile的顺序。最后调用定义在spring.factories中的resource loader class来load 配置文件。

YamlPropertySourceLoader.java

插一句，Springboot为我们提供了很好的yaml文件parse的code，当你需要解析yaml文件时不妨直接参考Springboot的YamlPropertySourceLoader

这样一旦应用升级到Springboot 2.4.0之后相同的test code会使用application-Dev.yaml中配置的值，造成了test结果的改变。
如果要解决这个问题，根据上面介绍的配置文件优先级顺序，可以在@SpringbootTest中设置properties 来作为最终的配置覆盖当前profile对应的配置。

了解一个框架很不容易，一个小小的变化都有可能造成应用的行为变化，唯有刨根问底，不断总结才是framework人解决一切问题的不变的方法论。

Ⅱ SpringBoot 如何优雅读取配置文件10分钟教你搞定

很多时候我们需要将一些常用的配置信息比如阿里云 oss 配置、发送短信的相关信息配置等等放到配置文件中。

下面我们来看一下 Spring 为我们提供了哪些方式帮助我们从配置文件中读取这些配置信息。

application.yml 内容如下：

wuhan2020: 2020年初武汉爆发了新型冠状病毒，疫情严重，但是，我相信一切都会过去！武汉加油！中国加油！my-profile:name: Guide哥email: [email protected]:location: 湖北武汉加油中国加油books:    -name: 天才基本法description: 二十二岁的林朝夕在父亲确诊阿尔茨海默病这天，得知自己暗恋多年的校园男神裴之即将出国深造的消息——对方考取的学校，恰是父亲当年为她放弃的那所。    -name: 时间的秩序description: 为什么我们记得过去，而非未来？时间“流逝”意味着什么？是我们存在于时间之内，还是时间存在于我们之中？卡洛·罗韦利用诗意的文字，邀请我们思考这一亘古难题——时间的本质。    -name: 了不起的我description: 如何养成一个新习惯？如何让心智变得更成熟？如何拥有高质量的关系？ 如何走出人生的艰难时刻？

1.通过 @value 读取比较简单的配置信息

使用 @Value("${property}") 读取比较简单的配置信息：

@Value("${wuhan2020}")String wuhan2020;

需要注意的是 @value这种方式是不被推荐的，Spring 比较建议的是下面几种读取配置信息的方式。

2.通过@ConfigurationProperties读取并与 bean 绑定

LibraryProperties 类上加了 @Component 注解，我们可以像使用普通 bean 一样将其注入到类中使用。

importlombok.Getter;importlombok.Setter;importlombok.ToString;importorg.springframework.boot.context.properties.ConfigurationProperties;importorg.springframework.context.annotation.Configuration;importorg.springframework.stereotype.Component;importjava.util.List;@Component@ConfigurationProperties(prefix ="library")@Setter@Getter@{privateString location;privateList books;@Setter@Getter@ToStringstaticclassBook{        String name;        String description;    }}

这个时候你就可以像使用普通 bean 一样，将其注入到类中使用：

packagecn.javaguide.readconfigproperties;importorg.springframework.beans.factory.InitializingBean;importorg.springframework.boot.SpringApplication;importorg.springframework.boot.autoconfigure.SpringBootApplication;/** *@authorshuang.kou */@ntsInitializingBean{privatefinalLibraryProperties library;(LibraryProperties library){this.library = library;    }publicstaticvoidmain(String[] args){        SpringApplication.run(.class,args);    }@(){        System.out.println(library.getLocation());        System.out.println(library.getBooks());    }}

控制台输出：

湖北武汉加油中国加油[LibraryProperties.Book(name=天才基本法, description........]

3.通过@ConfigurationProperties读取并校验

我们先将application.yml修改为如下内容，明显看出这不是一个正确的 email 格式：

my-profile:name: Guide哥email: koushuangbwcx@

ProfileProperties 类没有加 @Component 注解。我们在我们要使用ProfileProperties 的地方使用@

EnableConfigurationProperties注册我们的配置 bean：

importlombok.Getter;importlombok.Setter;importlombok.ToString;importorg.springframework.boot.context.properties.ConfigurationProperties;importorg.springframework.stereotype.Component;importorg.springframework.validation.annotation.Validated;importjavax.validation.constraints.Email;importjavax.validation.constraints.NotEmpty;/***@authorshuang.kou*/@Getter@Setter@ToString@ConfigurationProperties("my-profile")@{@NotEmptyprivateString name;@Email@NotEmptyprivateString email;//配置文件中没有读取到的话就用默认值privateBooleanhandsome =Boolean.TRUE;}

具体使用：

packagecn.javaguide.readconfigproperties;importorg.springframework.beans.factory.InitializingBean;importorg.springframework.beans.factory.annotation.Value;importorg.springframework.boot.SpringApplication;importorg.springframework.boot.autoconfigure.SpringBootApplication;importorg.springframework.boot.context.properties.EnableConfigurationProperties;/** *@authorshuang.kou */@SpringBootApplication@EnableConfigurationProperties(ProfileProperties.class){privatefinalProfileProperties profileProperties;(ProfileProperties profileProperties){this.profileProperties = profileProperties;    }publicstaticvoidmain(String[] args){        SpringApplication.run(.class,args);    }@(){        System.out.println(profileProperties.toString());    }}

因为我们的邮箱格式不正确，所以程序运行的时候就报错，根本运行不起来，保证了数据类型的安全性：

Binding to target org.springframework.boot.context.properties.bind.BindException:Failedtobindpropertiesunder'my-profile'to cn.javaguide.readconfigproperties.ProfileProperties failed:Property:my-profile.emailValue:koushuangbwcx@Origin:classpathresource[application.yml]:5:10Reason:mustbeawell-formedemailaddress

我们把邮箱测试改为正确的之后再运行，控制台就能成功打印出读取到的信息：

ProfileProperties(name=Guide哥, [email protected], handsome=true)

4.@PropertySource读取指定 properties 文件

importlombok.Getter;importlombok.Setter;importorg.springframework.beans.factory.annotation.Value;importorg.springframework.context.annotation.PropertySource;importorg.springframework.stereotype.Component;@Component@PropertySource("classpath:website.properties")@Getter@SetterclassWebSite{@Value("${url}")privateString url;}

使用：

@Autowiredprivate WebSite webSite;System.out.println(webSite.getUrl());//https://javaguide.cn/

5.题外话:Spring 加载配置文件的优先级

Spring 读取配置文件也是有优先级的，直接上图：

原文链接：https://www.toutiao.com/a6791445278911103500/?log_from=7f5fb8f9b4b47_1640606437752

Ⅲ springboot获取复杂的list配置文件

使用springboot获取以List类型为主的配置项 (包含list嵌套的使用)
1.在application.yml 主配置文件中配置以smtpmail开头的配置项

(方法2)创建 ApplicationConfig.java 配置类用于获取application.yml所有配置
@ConfigurationProperties 注解作用在方法上

3.使用单元测试获取属性

Ⅳ Spring Boot 第二弹，配置文件详解-史上最全

  Spring Boot 官方 提供了两种常用的配置文件格式，分别是 properties 、 YML 格式。相比于 properties 来说， YML 更加年轻，层级也是更加分明。 强烈推荐使用 YML 格式

  Spring Boot项目 启动会扫描以下位置的 application.properties 或者 application.yml 作为默认的配置文件.

徒手撕源码

内部类Loader的load方法

getSearchLocations()方法

asResolvedSet()

下面给出优先级 从高到低 的配置文件排列顺序：

以设置应用端口为例 初体验Spring Boot配置文件

properties后缀结尾(application.properties)

yml/yaml后缀结尾(application.yml/application.yaml)

数字，字符串，布尔，日期

对象、Map

数组

数字，字符串，布尔，日期

对象、Map

数组

@ConfigurationProperties(prefix = "person")详解

标注在类上

标注在方法上

综上所述

  @ConfigurationProperties 注解能够轻松的让配置文件跟实体类绑定在一起。

 值得关注的是： @ConfigurationProperties 这个注解仅仅是支持从 Spring Boot的默认配置文件 中取值，也就是 application.properties 、 application.yml 、 application.yaml ，那我们如何从自定义配置文件取值呢？？？

 别着急，有解决办法，那就是再加一个注解： @PropertySource(value = "classpath:custom-profile.properties") ,下面会有对 @PropertySource 注解的介绍。请耐心往下面看。

使用@PropertySource注解

对应配置文件

创建两个配置文件 custom-profile.yml、custom-profile1.yml ，如下去引入。

我们可以通过控制变量法进行测试，具体过程我这里就不赘述了。

直接说 结论 吧： Spring加载顺序 为 从左到右顺序加载 ，后加载的会 覆盖 先加载的属性值。

另外需要注意的是 ： @PropertySource 默认加载 xxx.properties类型 的配置文件，不能加载 YML格式 的配置文件。如何解决呢？下面来解决这一问题

对应配置文件：

编写PropertiesController

扩展功能

application.yml 主配置文件

application-dev.yml 开发配置文件

application-prod.yml 生产配置文件

application-test.yml 测试配置文件

（1）主配置文件：配置激活选项

（2）其他配置文件：指定属于哪个环境（同yml，只不过表现形式是 key=value 的,三个配置文件分别是： application-dev.properties , application-prod.properties , application-test.properties ）

 无论是使用上述 多文档块 的方式，还是新建 application-test.yml 文件，都可以在配置文件中指定 spring.profiles.active=test 激活指定的profile。

感谢阅读小生文章。祝大家早日富可敌国，实现财富自由。

写文不易 ,一定要 点赞、评论、收藏哦 , 感谢感谢感谢!!!

Ⅳ springboot配置文件总结

springboot 本身支持多种灵活的配置方式，为开发 springboot 程序带来了很大的灵活性和扩展性，但是同时由于太灵活，经常会导致明明配置了相关属性，却没有生效。
本文总结了 springboot 配置文件的原理以及多个配置文件生效的顺序。

springboot 配置文件支持灵活的路径，以及灵活的文件名，用一个变量表达式总结如下：

部分源码如下：

当满足上述变量表达式的配置文件有多个时，会有一个配置的优先级。假设

上面每个条件组合起来，则最多有配置文件如下，且顺序从上到下：

获取属性时，按从上到下的顺序遍历由上述文件生成的属性资源对象 PropertySource ，如果遇到匹配的key直接返回。
总结一下：就是如果同一个key的属性只出现一次，则直接取该值即可。如果同一个key的属性出现多次，则取顺序靠前的属性资源对象。另外其中每个文件都是可选的。

需要注意的一点是：如果在同一个 location 下配置了多个文件名一样的文件，则只会取一个，比如在 classpath:/ ，有如下两个文件 application.yml ：

则只会根据 classloader 的 classpath 列表，选取第一个出现的文件。因为 springboot 加载配置文件时最底层是使用的下面的方法：

这两个方法只会获取 classloader 类的 ucp 属性里面第一个匹配到的值。如果对 springboot 自身的机制不满意，想获取所有的classpath:/路径下面的 applicaiton.yml 文件，可以使用下面的方法：

本文总结了 springboot 配置文件的原理以及多个配置文件生效的顺序。如果存在增加了配置文件或者在配置文件里面增加了属性却没有生效，可以参考上面的 springboot 配置文件表达式和配置文件生效顺序进行排查。

后面还会有一篇文章讨论基于 springboot 配置原理如何实现自定义的配置读取方式。

Ⅵ 二、SpringBoot的配置--yaml

SpringBoot使用一个全局的配置文件，配置文件名是固定的；

配置文件的作用：修改SpringBoot自动配置的默认值；SpringBoot在底层都给我们自动配置好；

YAML 是一个标记语言

标记语言：

以前的配置文件；大多都使用的是xxx.xml文件

YAML：以数据为中心，比json、xml等更适合做配置文件

YAML：配置例子

XML:

k:(空格)v ： 表示一对键值对（空格必须有）

以空格的缩进来控制层级关系；只要是左对齐的一列数据，都是同一个层级的

属性和值也是大小写敏感；

k: v :字面直接来写；

字符串默认不用加上单引号或者双引号；

"" :双引号；不会转义字符串里面的特殊字符； 特殊字符会作为本身想表示的意思

name : "zhangsan lisi" :输出 ： zhangsan 换行 lisi

'' :单引号；会转义特殊字符，特殊字符最终只是一个普通的字符串数据

name: 'zhangsan lisi' : 输出 ； zhangsan lisi

k: v : 在下一行来写对象的属性和值的关系 ；注意缩进

对象还是 k: v 的方式

行内写法：

用- 值表示数组中的一个元素

行内写法

配置文件

javaBean:

我们可以导入配置文件处理器，以后编写配置就有提示了

调整 图示：

配置文件yml还是properties他们都能获取到值；

如果说，我们只是在某个业务逻辑中需要获取一下配置文件中的某项值，使用@Value

如果说，我们专门编写一个javaBean来和配置文件进行映射，我们就直接使用@ConfigurationProperties

@ImportResource:导入Spring的配置文件，让配置文件里面的内容生效

SpringBoot里面没有Spring的配置文件，我们自己编写的配置文件，也不能自动识别；

想让Spring的配置文件生效，加载进来；@ImportResource标注在一个配置类上

不来编写Spring的配置文件

Spring Boot推荐给容器添加组件的方式；推荐全注解的方式

1、配置类@Configuration------>Spring配置文件

2、使用@Bean给容器中添加组件

我们在主配置文件编写的时候，文件名可以是application-{profile}.properties/yml

默认使用application.properties的配置

1、在配置文件中指定spring.profiles.active=dev

2、在命令行：

java -jar spring-boot-02-config.jar --spring.profiles.active=dev;

可以直接在测试的时候，配置传入命令行参数

3.虚拟机参数

-Dspring.profiles.active=dev

springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring Boot的默认配置文件

-file:./config/

-file:./

-classpath:/config/

-classpath:/

优先级由高到低，高优先级的配置会覆盖低优先级的配置

SpringBoot会从这四个位置加载主配置文件：互补配置

==我们还可以通过spring.config.location来改变默认的配置文件位置==

项目打包好以后，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件的新位置；指定配置文件和默认加载的这些配置文件共同起作用互补配置；

java -jar spring-boot-02-config.jar --spring.config.location=G:/application.properties

==SpringBoot也可以从以下位置加载配置；优先级从高到低；高优先级的配置低优先级的配置，所有的配置会形成互补配置==

1.命令行参数

2.来自java:comp/env的JNDI属性

3.java系统属性

4.操作系统环境变量

5.RandomValuePropertySource配置的random.*属性值

==有jar包外箱jar包内进行寻找==

==优先加载带profile==

6.jar包外部的application-{profile}.properties 或 application.yml(带spring.profile)配置文件

7.jar包内部的application-{profile}.properties 或 application.yml(带spring.profile)配置文件

==再来加载不带profile==

8.jar包外部的application.properties或者application.yml(不带spring.profile)配置文件

9.jar包内部的application.properties或者application.yml(不带spring.profile)配置文件

精髓：

1》springboot启动会加载大量的自动配置类

2》我们看我们需要的功能有没有springboot默认写好的自动配置类

3》我们再来看这个自动配置类中到底配置了那些组件；（只要我们要用的组件有，我们就不需要再来配置了）

4》给容器中自动配置类添加组件的时候，会从properties类中获取某些属性，我们就可以在配置文件中指定这些属性的值

Ⅶ springboot常用注解

springboot常用注解有@SpringBootApplication；@Repository；@Service；@RestController；@ResponseBody。

3、starter 是 SpringBoot 中一种非常重要的机制，它可以繁杂的配置统一集成到 starter 中，我们只需要通过 maven 将 starter 依赖引入到项目中，SpringBoot 就能自动扫描并加载相应的默认配置。starter 的出现让开发人员从繁琐的框架配置中解放出来，将更多的精力专注于业务逻辑的开发，极大的提高了开发效率。

Ⅷ Spring Boot | 配置文件

创建 Spring Boot 项目默认会在 src/main/resources 目录下生成一个全局配置文件 application.properties 。全局配置文件的作用是对一些默认配置进行修改。

Spring Boot 的参数配置除了使用 properties 文件之外，还可以使用 yml 文件。如果你喜欢用 yml 格式的配置文件可以将 application.properties 修改为 application.yml 。

Spring Boot 应用程序有多种设置途径。Spring Boot 能从多种属性源获得属性，包括如下几处：

这个列表按照优先级排序，也就是说，任何在高优先级属性源里设置的属性都会覆盖低优先级属性源里设置的相同属性。例如，命令行参数会覆盖其它属性源里的属性。

application.properties 和 application.yml 文件能放下如下四个位置：

同样，这个列表也是按照优先级排序。也就是说，/config 子目录里 application.properties 会覆盖应用程序 classpath 里的 application.properties 中的相同属性。

Ⅸ SpringBoot的配置文件有哪几种格式

SpringBoot中的配置文件来主要有三种格式，自properties、yaml、和xml方式。

- 其中properties格式配置文件后缀是.properties，配置项为：server.port = 9090
- yaml格式配置文件后缀是.yml，配置项是：server.port: 9090

在SpringBoot中，使用最广泛的配置文件是yaml，yaml之所以流行，除了他配置语法精简之外，还因为yaml是一个跨编程语言的配置文件。

在SpringBoot中，除了yaml之外，properties也比较常用，但是XML几乎不用，看得出来Spring团队非常痛恨XML配置文件！认为它不是一个好的语言。

如果你对常见的配置文件有哪几种格式不熟悉，就去黑马程序员官网视频库看免费视频。