一、配置文件
Spring Boot有两个全局的配置文件,文件名固定:application.properties 和 application.yml
.properties配置文件的优先级高于.yaml配置文件(两者同时存在时,先读yml,再读properties,这时后者会覆盖前者配置)
配置文件的作用:修改Spring Boot自动配置的默认值(Spring Boot在底层都给我们自动配置好)
YAML(YAML Ain't Markup Language):不是一种标记语言,以数据为中心,比json、xml更适合做配置文件。
1、YAML语法
- k: v 表示键值对关系,冒号后面必须有一个空格
- 使用空格的缩进表示层级关系,空格数目不重要,只要是左对齐的一列数据,都在同一个层级
- 大小写敏感
- 缩进时不允许使用Tab键,只允许使用空格
- 支持松散绑定。Java中对于驼峰命名法,可使用原名或-代替驼峰,如:lastName属性,在yml文件中使用lastName或last-name都可以正确映射
2、键值关系
以Java语言为例,对于键与值主要是看能否表示一下内容。普通的值(数组、字符串、布尔)、日期、对象、数组、集合等。
(1)普通值(字面量)
- k: v 字面量直接写,字符串默认不加单引号或者双引号
- "":双引号,不会转义字符串里面的特殊字符。如:name: "zhangsan \n lisi" 输出:zhangsan 换行 lisi
- '':单引号,会转义特殊字符,特殊字符最终只是一个普通的字符串数据。如:name: 'zhangsan \n lisi' 输出:zhangsan \n lisi
(2)日期:跟普通值一样对待
- date: 2019/01/01
(3)对象、Map(都是键值对的形式)
第一种写法:在下一行来写对象的属性和值的关系,主要缩进
people:
name: zhangsan
age: 18
行内写法:
people: {name: zhangsan, age: 18}
(4)数组(List、Set)应- 值表示数组中的一个元素
第一种写法:
pets:
- cat
- dog
- pig
行内写法:
pets: [cat,dog,pig]
(5)混合
peoples:
- name: zhangsan
age: 22
- name: lisi
age: 20
- {name: wangwu,age: 18}
3、文档块
二、配置文件注入
1、基本配置
(1)、配置文件
(2)、JavaBean
(3)、导入提示的依赖
导入配置文件处理器,以后编写配置就有提示了 。导入后,重新run一下即可。
<!--导入配置文件处理器,配置文件进行绑定就会有提示-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
(4)、配置文件乱码问题
配置文件的编码是格外设置的,默认不与class文件一致
2、@Value获取值和@ConfigurationProperties获取值比较
https://blog.csdn.net/lzb348110175/article/details/105142007 --写的很详细
@Value是Spring的底层注解,也可以实现将class类与配置文件绑定的效果。
@ConfigurationProperties | @Value | |
---|---|---|
功能 | 批量注入配置文件中的属性 | 一个个指定 |
松散绑定(松散语法) | 支持 | 不支持??测试支持 |
SpEL(Spring表达式 如11*2) | 不支持 | 支持 |
JSR303数据校验 对 Java Bean中的字段的值进行验证 | 支持 @Validated //说明该类需要被校验 @Size(min = 1, max = 3) | 不支持 |
复杂类型封装 | 支持 | 不支持 |
如果我们,只是在某个业务逻辑中需要获取一下配置文件中的某项值,使用@Value方便
如果我们,专门编写了一个JavaBean来和配置文件进行映射,使用 @ConfigurationProperties更好
3、@PropertySource&@ImportResource&@Bean
@PropertySource:加载指定的配置文件。
不可能把所有的配置都写在主配置文件里,比如把有关person的配置提取出来。
@ImportResource:导入Spring的配置文件(导入自己编写的配置文件,使之生效)
Spring Boot里面没有Spring的配置文件,我们自己编写的文件不能自动识别,要想让我们编写的文件生效,需要将@ImportResource标注在一个配置类上。这里把它标志在主配置类上了。
@Bean:给容器中添加组件。。。上面是一个方法,但Spring不推荐写xml文件,推荐全注解的方式。
所以我们得写一个配置类代替xml文件。
4、配置文件占位符
${random.value}、${random.int}、${random.long}、${random.int(10)}、${random.int[1024,65536]}等
如果没有值可以是用:指定默认值
5、Profile
5.1 多Profile文件 -- properties方式实现多Profiles及激活
配置文件名可以是application-{profile}.properties/yml,默认使用application.properties/yml主配置,可在主配置文件中指定激活的文件
5.2 yml支持多文档块方式 -- yml方式实现多Profiles及激活
5.3 指定激活Profile方法汇总
- 在配置文件中指定spring.profiles.active=dev
- 命令行:在idea里面指定--spring.profiles.active=dev 或者 打包后直接在测试的时候配置传入命令行参数 java -jar xx.jar --spring.profiles.active=dev
- 虚拟机参数:-Dspring.profiles.active=dev
6、配置文件加载位置
Spring Boot启动会扫描以下位置的application.properties或application.yml文件作为Spring Boot的默认配置文件,那么顺序是怎样的呢?classpath默认路径为①
四个文件可以共存,高优先级的配置会覆盖低优先级的配置,形成互补配置。
项目打包好以后,可以使用命令行参数的形式,启动项目的时候来指定配置文件的新配置(指定的配置文件优先级最高,可以覆盖默认加载的配置文件。。。什么场景下这样用,如:运维的时候,已经打包了,现场需要改一下配置运行,就可以在执行的时候使用命令行,指定配置文件中的配置)。java -jar xxx.jar --spring.config.location=E:/application.properties 。指定配置文件和默认加载的这些配置文件共同起作用形成互补配置。
7、外部配置加载顺序
- ==SpringBoot也可以从以下位置加载配置; 优先级从高到低;高优先级的配置覆盖低优先级的配置,所有的配置会形成互补配置==
- 1、命令行参数:所有的配置都可在命令行上进行指定。形式:--配置项=值。多个配置用空格隔开。java -jar xxx.jar --server.port=8087 server.servlet.context-path=/boot02
- 2、来自java:comp/env的JNDI属性
- 3、Java系统属性(System.getProperties())
- 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)配置文件
- 10、@Configuration注解类上的@PropertySource
- 11、通过SpringApplication.setDefaultProperties指定的默认属性
- 参考官方文档
8、自动配置的原理
配置文件到底可以修改哪些配置,参考:配置文件能配置的属性参照
@EnableAutoConfiguration 扫描所有jar包类路径下 META-INF/spring.factories,这里面是所有的自动配置,但并不是都会生效,满足自动配置的启动要求,才会生效 .......