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使用一个全局配置文件，配置文件的名字是固定的：
application.properties或application.yml
@ConfigurationProperties： 将 全局配置文件 的属性值，映射到SpringBoot 组件 上
@Value: 从 全局配置文件 中读取属性，映射到组件上
@PropertySource: 加载指定的配置文件。可以配合 @Value 和 @ConfigurationProperties 使用。默认只能加载XML文件，若需要加载yml文件需要实现 DefaultPropertySourceFactory 的 createPropertySource() 方法，并在注解中声明。spring boot 中 yml 、yaml 对应的加载类为 YamlPropertySourceLoader .
@ImportResource: 加载自定义的Spring XML 配置文件
SpringBoot不推荐使用这种方式，推荐使用全注解（JavaConfig）的方式。
SpringBoot会扫描当前包和所有子包的注解配置到容器中。
Springboot 读取配置文件原理
Springboot 读取配置文件(application.yaml, application.properties)的过程发生在SpringApplication#prepareEnvironment() 阶段，而prepareEnvironment又属于整个Springboot 应用启动的非常前置阶段，因为Environment的准备是后续bean创建的基础。让我们来一探启动是的详细code。除去StopWatch这些code，可以发现prepareEnvironment 发生在SpringApplication#run 这在整个应用启动的多步实质性操作中几乎是第一步。
而prepareEnvironment中最重要的是通过触发listener（EventPublishingRunListener）来通过SimpleApplicationEventMulticaster#multicastEvent发出ApplicationEnvironmentPreparedEvent。
而SimpleApplicationEventMulticaster#multicastEvent的实现其实也很简单，找到相关的监听ApplicationEnvironmentPreparedEvent的listener，然后一个个的调用他们的Listener#onApplicationEvent(event)方法，而这其中就包括了处理configuration文件的listener。
在Springboot 2.4.0 之前这个处理configuration 文件的lister是ConfigFileApplicationListener，在2.4.0之后，处理configuration 文件的lister是EnvironmentPostProcessorApplicationListener，并且对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")。 如果我的应用中存在ApplicationEnvironmentPreparedEvent的某个自定义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了，取而代之的是EnvironmentPostProcessorApplicationListener，EnvironmentPostProcessorApplicationListener通过调用ConfigDataEnvironmentPostProcessor来完成configuration加载。
EnvironmentPostProcessorApplicationListener.java
ConfigDataEnvironmentPostProcessor.java
ConfigDataEnvironmentPostProcessor只是老老实实的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配置文件
1. 配置文件
Spring Boot使用一个全局的配置文件
application.properties
application.yml
配置文件的作用：修改Spring Boot自动配置的默认值，SpringBoot在底层都给我们自动
配置好。有什么配置项，可以移步官方文档
配置文件一般放在src/main/resources目录或者类路径/confifig下，当然还有很多位置可
以放，它们会有不同优先级，后面会讲到。
YAML （YAML Ain't Markup Language）
简单介绍
!--绑定配置文件处理器，配置文件进行绑定的时候就会有提示--
dependency
groupIdorg.springframework.boot/groupId
artifactIdspring-boot-configuration-processor/artifactId
optionaltrue/optional
/dependency
!-- 将应用打包成一个可执行Jar包，直接使用java -jar xxxx的命令来执行 --
build
plugins
plugin
groupIdorg.springframework.boot/groupId
artifactIdspring-boot-maven-plugin/artifactId
/plugin
/plugins
/build以前的配置文件：大多是xml
.yml是YAML语言的文件，以数据为中 心，比json、xml等更适合做配置文件
全局配置文件的可以对一些默认配置值进行修改
配置实例
xml：
yml:
2. YAML语法
基本语法
K:(空格)V 标识一对键值对
以空格的缩进来控制层级关系
只要是左对齐的一列数据，都是同一层级的
属性和值也是大小写敏感
实例：
值的写法
普通的值
k: v 字面量直接来写，字符串默认不用添加单引号
" " 双引号 不会转义字符串里面的特殊字符；
server
port8081/port
/server
server:
port: 8081
server:
port: 8081
path: /hello // 冒号后面的空格不要拉下' ' 单引号 会转义字符，特殊字符最终是一个普通的字符串
对象
普通写法：
行内写法
frends:{ lastName: zhang,age: 18 }
Map
示例：
maps: {k1: v1,k2: v2}
数组
普通写法：
pets: // var onj = {pets: ['cat','pig','dog']}
- cat
- pig
- dog
行内写法
pets:[cat, pig, dog]
配置文件获取
将配置文件中的每一个值映射到此组件中
1. Persion
name: "wang \n qian" // 输出：wang 换行 qian
frends:
lastName: zhang
age: 20package com.wrq.boot.bean;
@Component
@ConfigurationProperties(prefix = "persion")
public class Persion {
private String name;
private int age;
private double weight;
private boolean boss;
private Date birth;
private MapString,Object maps;
private ListObject list;
private Dog dog;
此处，这个bean的getter、setter和tostring方法已经省略，千万不能忽略！
}
@ConfifigurationProperties 意思是:我们类里面的属性和配置文件中的属性做绑定
不使用此注解，可以在bean的属性添加@value()注解，如下：
@Component
// @ConfigurationProperties(prefix = "persion")
public class Persion {
@value("${persion.name}") // $()读取配置文件、环境变量中的值
private String name;
@value("#{11*2}") // #{SpEL} 采用表达式
private int age;
@value("true") // 直接赋值
private boolean boos;
}
此处采用@ConfifigurationProperties的方式，@value()和@ConfifigurationProperties的
区别见下方表格。prefifix = "persion" 配置文件中那个下面的属性来一一映射
@Component 如果想要这个注解起作用，必须放到容器里面
2. Dog
package com.wrq.boot.bean;
public class Dog { // 用作Persion中的属性
private String name;
private int age;
此处，这个bean的getter、setter和tostring方法已经省略，千万不能忽略！
}
3. 配置文件
方式一: application.yml
persion:
name: 王大锤
age: 18
weight: 125
boss: false
birth: 2018/5/5
maps: {k1: v1,k2: v2}
list:
- wangli
- wangbai
dog:
name: xiaogou
age: 2
方式二: application.propertiespersion.name = 王大锤
persion.age = 18
persion.weight = 125
persion.boss = false
persion.birth = 2018/5/5
persion.maps.k1 = v1
persion.maps.k2 = v2
persion.dog.name = xiaogou
persion.dog.age = 15
4. 测试类：BootApplicationTests
package com.wrq.boot;
@RunWith(SpringRunner.class)
@SpringBootTest
public class BootApplicationTests {
@Autowired
Persion persion;
@Test
public void contextLoads() {
System.out.print(persion);
}
}
5. 运行 BootApplicationTests方法
控制台打印：
application.yml的结果：
Persion{name='王大锤', age=18, weight=125.0, boss=false, birth=Sat May
05 00:00:00 CST 2018, maps={k1=v1, k2=v2}, list=[wangli, wangbai],
dog=Dog{name='xiaogou', age=2}}
application.properties的结果：
Persion{name='��Ǭ', age=18, weight=125.0, boss=false, birth=Sat
May 05 00:00:00 CST 2018, maps={k2=v2, k1=v1}, list=[wangli, wangbai],
dog=Dog{name='xiaogou', age=15}}
把Bean中的属性和配置文件绑定，通过yml文件和properties都可以做到,但是properties
文件出现乱码。
properties中文读取乱码：File-Settings-File Encodings最底部选utf-8、Tranparent打
上勾
注解比较
@value和@ConfifigurationProperties获取值比较
名词解释:
松散绑定
last-name和lastName都可以获取导致，则代表支持松散绑定
JSR303@Component
@ConfigurationProperties(prefix = "persion") // 如果使用的是@value注入值
时，无法使用校验
@Validated // 添加此注解
public class Persion {
@Email // 配置文件书写的属性必须是邮箱格式，不符合报错！
private String name;
}
复杂类型封装
如果获取配置文件中map的值时,@value是获取不到值的
@value("${persion.maps}") // 由于使用的是@value，无法获取配置文件中的map
private MapString,Object maps;
@PropertySource
@PropertySource：加载指定配置文件
@ConfifigurationProperties()默认是从全局配置文件中获取值，也就是
application.properties这个文件中获取值。
如果做的配置很多，全局的配置文件就会特别大，为了方便管理。我会创建不同的配置文
件定向管理不同的配置。
如创建persion.properties文件单独存放persion需要的配置
@PropertySource就是用来导入创建的配置文件
示例：
1. persion.properties
同时把两个全局的配置中关于Persion的配置都注释掉persion.name = 王弟弟
persion.age = 18
persion.weight = 125
persion.boss = false
persion.birth = 2018/5/5
persion.maps.k1 = v1
persion.maps.k2 = v2
persion.dog.name = xiaogou
persion.dog.age = 15
2. Persion
package com.wrq.boot.bean;
@Component
@PropertySource(value = {"classpath:persion.properties"})
@ConfigurationProperties(prefix = "persion")
public class Persion {
private String name;
private int age;
private double weight;
private boolean boss;
private Date birth;
private MapString,Object maps;
private ListObject list;
private Dog dog;
此处，这个bean的getter、setter和tostring方法已经省略，千万不能忽略！
}
这样运行测试类，控制台就可以打印persion.properties中的数据。
通过下面的注解，把类路径下的persion.properties加载进来。并且把persion开头的数
据进行绑定。
@PropertySource(value = {"classpath:persion.properties"})@ConfifigurationProperties(prefifix = "persion")
@ImportResource
@ImportResource：导入Spring的配置文件，让配置文件生效。
示例：
1. com.wrq.boot.service
package com.wrq.boot.service;
/**
* Created by wangqian on 2019/1/12.
*/
public class HelloService {
}
2. resources目录手动建立bean.xml
?xml version="1.0" encoding="UTF-8"?
beans xmlns=""
xmlns:xsi=""
xsi:schemaLocation="
"
bean id="helloService" class="com.wrq.boot.service.HelloService"
/bean
/beans
3. 测试类
package com.wrq.boot;
@RunWith(SpringRunner.class)
@SpringBootTest
public class BootApplicationTests {
@Autowired
ApplicationContext ioc;@Test
public void testConfig() {
boolean b = ioc.containsBean("helloService");
System.out.print(b);
}
}
试图通过添加一个Spring的配置文件bean.xml来把HelloService注入进去。
运行测试类结果：false
结果表明IoC容器中并不包含HelloService，即：配置文件bean.xml没有生效
解决方式
方式一： 主程序中进行配置@ImportResouece注解
package com.wrq.boot;
@ImportResource(locations = {"classpath:bean.xml"}) // 通过此配置是
bean.xml生效
@SpringBootApplication
public class BootApplication {
public static void main(String[] args) {
//应用启动起来
SpringApplication.run(BootApplication.class, args);
}
}
方法二：通过配置类实现，这种方式也是Spring Boot推荐的
1. com.wrq.boot.confifigpackage com.wrq.boot.config;
/**
* Created by wangqian on 2019/1/12.
*/
@Configuration
public class MyConfig {
// 将方法的返回值添加到容器之中,并且容器中这个组件的id就是方法名
@Bean
public HelloService helloService(){
System.out.print("通过@Bean给容器添加组件了..");
return new HelloService();
}
}
@Confifiguration标注这是一个配置类
通过@Bean注解，将方法的返回值添加到容器之中,并且容器中这个组件的id就是方
法名
2. 把主程序类中@ImportResource()配置注释掉
3. 测试成功，添加了HelloService()组件
3. 配置文件占位符
随机数
RandomValuePropertySource：配置文件中可以使用随机数
${random.value}
${random.int}
${random.long}
${random.uuid}
${random.int(10)}
${random.int[1024,65536]}
属性配置占位符可以在配置文件中引用前面配置过的属性（优先级前面配置过的这里都能用）
${app.name:默认值}来指定找不到属性时的默认值
persion.name = 王弟弟${random.uuid}
persion.age = ${random.int}
persion.dog.name = ${persion.name}_dog
4. Profifile 多环境支持
Profifile是Spring对不同环境提供不同配置功能的支持，可以通过激活、 指定参数等方式
快速切换环境
1. 多Profifile的方式
格式：application-{profifile}.properties/yml
application-dev.properties
application-prod.properties
默认采用application.properties配置文件，如果使用别的，需要激活：
1. application.properties中配置：
# 激活application-dev.properties配置文件
spring.profiles.active=dev
2. application-dev.properties:
server.port=8082
3. 运行BootApplication主程序:
2019-01-12 20:46:09.345 INFO 14404 --- [main]
s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s):
8082 (http)
2. 多文档块的方式
除了上方多Profifile的方式来切换环境，也可以通过YAML多文档块的方式。示例:
application.yml:
server:
port: 8081
spring:
profiles:
active: dev
---
spring:
profiles: dev
server:
port: 8083
---
spring:
profiles: prod
server:
port: 8084
3. 激活指定Profifile
1. application.properties中配置：
# 激活application-dev.properties配置文件
spring.profiles.active=dev
2. application.yml中配置
server:
port: 8081
spring:
profiles:
active: dev
---
spring:
profiles: dev
server:
port: 80833. 启动配置-参数
在IDE中，类似于配置tomcat的地方，按下方配置：
Program arguments:--spring.profiles.active=dev
4. 启动配置-虚拟机
在IDE中，类似于配置tomcat的地方，按下方配置：
VM options:-Dspring-profiles-active=dev
5. 命令行 使用Maven的package命令打包，移动到jar的目录。
java -jar spring-boot-project-config.jar --spring.profiles.active=dev
5. 配置文件优先级
GitHub对应项目：boot-confifig-position
优先级
Spring Boot 启动会扫描以下位置的application.properties或者 application.yml文件作
为Spring boot的默认配置文件
fifile:./confifig/ (项目根目录confifig文件夹下的配置文件)
fifile:./ (项目根目下的配置文件)
classpath:/confifig/ (resources目录confifig文件夹下的配置文件)
classpath:/ (resources目下的配置文件)
以上是按照优先级从高到低的顺序，所有位置的文件都会被加载，高优先级配置内容会覆
盖低优先级配置内容,形成互补配置。
默认配置
我们也可以通过配置spring.confifig.location来改变默认配置。
项目打包后以后，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件的新
位置；指定配置文件和默认加载的这些配置文件共同起作用，形成互补配置。
1. Maven-package对项目打包2. 把待使用的配置文件放在本地文件夹中，如：D:/application.properties
3. 命令行执行命令
java -jar boot-config-position-xxxxxx.jar --
spring.config.location=D:/application.properties
这样即使项目上线了，我们也可以通过修改本地的配置文件，使用一行命令即可，极大方
便了运维人员。
6. 外部配置加载顺序
Spring Boot 支持多种外部配置方式
可以从以下位置加载配置，优先级从高到低，高优先级配置覆盖低优先级的，所以配置形
成互补配置。
1. 命令行参数
java -jar boot-config-position-xxxxxx.jar --server.port // 多个配置用空格
隔开
2. 来自java:comp/env的JNDI属性
3. Java系统属性（System.getProperties()）
4. 操作系统环境变量
5. RandomValuePropertySource配置的random.*属性值
6. jar包外部的application-{profifile}.properties或application.yml(带spring.profifile)配
置文件
7. jar包内部的application-{profifile}.properties或application.yml(带spring.profifile)配
置文件
8. jar包外部的application.properties或application.yml(不带spring.profifile)配置文件
9. jar包内部的application.properties或application.yml(不带spring.profifile)配置文件
10. @Confifiguration注解类上的@PropertySource
11. 通过SpringApplication.setDefaultProperties指定的默认属性
注意：从jar包外向jar包内寻找，优先加载profifile最后加载不带profifile，更多参考官方文
档
7. 自动配置原理GitHub对应项目：boot-confifig-autoconfifig
1. 配置文件写什么？
配置文件可配置属性查阅
2. 什么是注解，如何实现一个注解？
关于注解的机制和相关原理可以移步此篇博客
3. 配置原理解析
我们运行Spring Boot应用是从main方法启动，在主程序类上有一个
@SpringBootApplication注解。
@SpringBootApplication是一个复合注解，包括@ComponentScan，和
@SpringBootConfifiguration，@EnableAutoConfifiguration。
@SpringBootConfifiguration继承自@Confifiguration，二者功能也一致，标注当前类
是配置类，并会将当前类内声明的一个或多个以@Bean注解标记的方法的实例纳入到
srping容器中，并且实例名就是方法名。
@EnableAutoConfifiguration的作用启动自动的配置，@EnableAutoConfifiguration注
解的意思就是SpringBoot根据你添加的jar包来配置你项目的默认配置，比如根据
spring-boot-starter-web ，来判断你的项目是否需要添加了webmvc和tomcat，就
会自动的帮你配置web项目中所需要的默认配置
@ComponentScan，扫描当前包及其子包下被@Component，@Controller，
@Service，@Repository注解标记的类并纳入到spring容器中进行管理。是以前的co
ntext:component-scan（以前使用在xml中使用的标签，用来扫描包配置的平行支
持）。
@SpringBootApplication注解分析
配置原理视频讲解
4. 自动配置类判断
在配置文件properties中设置：debug=true 来让控制台打印自动配置报告，方便的得知
那些配置类生效。
=========================
AUTO-CONFIGURATION REPORT
=========================Positive matches:
-----------------
DispatcherServletAutoConfiguration matched:
- @ConditionalOnClass found required class
'org.springframework.web.servlet.DispatcherServlet';
@ConditionalOnMissingClass did not find unwanted class
(OnClassCondition)
- @ConditionalOnWebApplication (required) found 'session' scope
(OnWebApplicationCondition)
Negative matches:
-----------------
ActiveMQAutoConfiguration:
Did not match:
- @ConditionalOnClass did not find required classes
'javax.jms.ConnectionFactory',
'org.apache.activemq.ActiveMQConnectionFactory' (OnClassCondition)
Springboot配置文件读取-ConfigFileApplicationListener
ConfigFileApplicationListener 主要作用就是读取应用的配置文件并add到Environment的PropertySources列表里
Springboot应用在启动的时候准备好了环境后就会触发 ApplicationEnvironmentPreparedEvent 事件就开始执行读取配置的逻辑:
首先加载当前激活的Profile列表
然后从默认的 classpath:/,classpath:/config/,file:./,file:./config/ 这四个目录下
查找默认的application-{profile}名字对应的配置文件,配置文件格式支持两大类（Properties和Yaml）既：.properties .xml .yml .yaml
可以修改默认的配置文件名字(默认：application),可以指定多个比如 --spring.config.name= application,demo
可以修改默认的配置文件路径,比如 --spring.config.location= (目录结尾不带“/”会按照文件处理,而不是目录，容易掉坑)
阅读源码入口就从他的onApplicationEvent开始跟即可,将自身添加到postProcessor列表里并执行postProcessEnvironment方法，核心逻辑是靠一个Loader内部类
new Loader(environment, resourceLoader).load()
大概就是，如果没有spring.profiles.active 和 spring.profiles.include都没有特别指定激活的profile的话
没有特别指定profile的话就是：null + default，也就是我们常见的application.properties 和 application-default.properties这种
如果指定了那就是：null + 已经激活(pre-existing)的profile + spring.profiles.active + spring.profiles.include
举个例子，假如激活了多个profile比如：--spring.profiles.active=prd1,prd2，最终优先级上prd1 prd2 default(null)