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 中的相同属性。
Spring Boot 外置配置文件
默认情况下，我们 spring boot 项目的配置文件small（application.yaml、application.properties）/small是在项目的 jar 包『里面』的。
如果是要改配置文件中的配置项时，就需要将项目重新打包，在某些情况下，这就显得十分不方便。
对此，我们可以将 spring boot 项目的配置文件『挪到』jar 包之外，然后再启动 spring boot 项目时再指定它使用外部的这些配置文件。
根据上述的 outputDirectory 的配置，相关的配置文件会被复制到 target 下的 resources 目录中，并且，jar 包中也不会包含你所配置的这些配置文件。
这种情况下，在启动 spring boot 项目时，需要额外的参数（ -Dspring.config.location ）告诉它项目的配置文件在哪：
注意：
spring boot 默认是以 classpath:/,classpath:/config/,file:./,file:./config/ 这样的配置在查找、加载配置文件，有意思的是查找顺序是上述配置的反向顺序：
因此，如果你在 spring.config.location 中也定义了多个配置文件位置，例如： classpath:/custom-config/,file:./custom-config/ , 那么配置文件的查找、加载顺序同样是反向的:
另外，还有一个功能相似的配置 spring.config.additional-location ，使用它的话，它会作为默认配置路径的『 扩展配置 』路径来使用。扩展的配置路径会比默认的配置优先被扫描到. 比如说, 如果设置了扩展的配置文件所在路径为： classpath:/custom-config/,file:./custom-config/ , 那么查找路径将会是下面的顺序:
这种扫描顺序使得你可以通过自己的自定义配置来修改默认的配置项。
SpringBoot 配置文件详解（告别XML）
快速学会和掌握 SpringBoot 的 核心配置文件的使用。
SpringBoot 提供了丰富的 外部配置 ，常见的有：
其中核心配置文件我们并不陌生，主要以Key-Value的形式进行配置，其中属性Key主要分为两种：
在 application.properties 添加配置如下：
① 添加数据源信息
在 application.propertis 添加配置如下：
① 添加认证信息，其中 socks.indentity.* 是自定义的属性前缀。
② 添加随机值，其中spring.test.* 是自定义的属性前缀。
使用方法： @ConfigurationProperties(prefix = "spring.datasource")
使用说明：提供 Setter方法 和 标记组件 Component
如何验证是否成功读取配置？答：这里可以简单做个验证，注入 MyDataSource ，使用 Debug 模式可以看到如下信息：
使用方法： @Value("spring.datasource.*")
使用说明：提供 Setter方法 和 标记组件 Component
注意事项：@Value不支持注入静态变量，可间接通过Setter注入来实现。
关于两者的简单功能对比：
显然，前者支持松绑定的特性更强大，所以在实际开发中建议使用@ConfigurationProperties来读取自定义属性。
SpringBoot 默认会加载这些路径加载核心配置文件，按优先级从高到低进行排列：具体规则详见 ConfigFileApplicationListener
如果存在多个配置文件，则严格按照优先级进行覆盖，最高者胜出：
举个简单的例子，例如再上述位置都有一个application.properties ，并且每个文件都写入了server.port=xx （xx分别是9001，9002，9003，9004），在启动成功之后，最终应用的端口为：9004。图例：
如果想修改默认的加载路径 或者 调改默认的配置文件名，我们可以借助命令行参数进行指定，例如：
YAML是JSON的一个超集，是一种可轻松定义层次结构的数据格式。
答： 因为配置文件这东西，结构化越早接触越规范越好。这里推荐阅读阮一峰老师写的 YAML语言教程 ，写的很简单明了。
引入依赖： 在POM文件引入 snakeyaml 的依赖。
使用说明： 直接在类路径添加 application.yml 即可。
例如下面这两段配置是完全等价的：
① 在 application.yml 配置数据源:
② 在 application.properties 配置数据源：
在项目的实际开发中，我们往往需要根据不同的环境来加载不同的配置文件。例如生产环境，测试环境和开发环境等。此时，我们可以借助 Profiles 来指定加载哪些配置文件。例如：
温馨提示：如果spring.profiles.active指定了多个配置文件，则按顺序加载，其中最后的优先级最高，也就是最后的会覆盖前者。
使用方法：
使用Maven插件打包好项目，然后在当前路径，执行DOS命令： java -jar demo.jar --server.port=8081 ，在控制台可看到应用端口变成了8081。
实现原理：
默认情况下，SpringBoot会将这些命令行参数转化成一个 Property ，并将其添加到 Environment 上下文。
温馨提示：
由于命令行参数优先级非常之高，基本高于所有常见的外部配置，所以使用的时候要谨慎。详见 PropertySource 执行顺序 。
关闭方法：
如果想禁用命令行属性，可以设置如下操作：springApplication.setAddCommandLineProperties(false)
二、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)
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使用一个全局配置文件，配置文件的名字是固定的：
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会扫描当前包和所有子包的注解配置到容器中。