Spring Boot 配置文件
Spring Boot 配置文件
配置文件
SpringBoot 使用一个全局的配置文件,配置文件名是固定的;
application.properties
application.yml
配置文件的作用:修改 SpringBoot 自动配置的默认值;SpringBoot 在底层都给我们自动配置好;
YAML(YAML Ain’t Markup Language):
YAML A Markup Language:是一个标记语言
YAML isn’t Markup Language:不是一个标记语言
标记语言:
- 以前的配置文件;大多都使用的是 xxxx.xml 文件;
YAML:以数据为中心,比 json
、xml
等更适合做配置文件;
YAML:配置例子
1 | server: |
XML:
1 | <server> |
YAML 语法
基本语法
k:(空格)v
:表示一对键值对(空格必须有);
以 空格 的缩进来控制层级关系;只要是左对齐的一列数据,都是同一个层级的
1 | server: |
属性和值也是大小写敏感。
值的写法
字面量:普通的值(数字,字符串,布尔)
- k: v
:字面量直接来写;
- 字符串默认不用加上单引号或者双引号;
-
""
:双引号;不会转义字符串里面的特殊字符;特殊字符会作为本身想表示的意思
1 | name: "zhangsan \n lisi" |
''
:单引号;会转义特殊字符,特殊字符最终只是一个普通的字符串数据
1 | name: ‘zhangsan \n lisi’ |
对象、Map(属性和值)(键值对)
k: v
:在下一行来写对象的属性和值的关系;注意缩进。
对象还是 k: v
的方式
1 | friends: |
行内写法:
1 | friends: {lastName: zhangsan,age: 18} |
数组(List、Set)
用 -
值表示数组中的一个元素
1 | pets: |
行内写法:
1 | pets: [cat,dog,pig] |
配置文件值注入
配置文件:
1 | person: |
javaBean:
1 | /** |
我们可以导入配置文件处理器,以后编写配置就有提示了:
1 | <!--导入配置文件处理器,配置文件进行绑定就会有提示--> |
properties 配置文件在 idea 中默认 utf-8 可能会乱码
设置:
@Value 获取值和 @ConfigurationProperties 获取值比较
@ConfigurationProperties | @Value | |
---|---|---|
功能 | 批量注入配置文件中的属性 | 一个个指定 |
松散绑定(松散语法) | 支持 | 不支持 |
SpEL | 不支持 | 支持 |
JSR303数据校验 | 支持 | 不支持 |
复杂类型封装 | 支持 | 不支持 |
配置文件 yml
还是 properties
他们都能获取到值;
如果说,我们只是在某个业务逻辑中需要获取一下配置文件中的某项值,使用 @Value
;
如果说,我们专门编写了一个 javaBean
来和配置文件进行映射,我们就直接使用 @ConfigurationProperties
。
配置文件注入值数据校验
1 |
|
@PropertySource & @ImportResource & @Bean
@PropertySource:加载指定的配置文件。
1 | /** |
@ImportResource:导入Spring的配置文件,让配置文件里面的内容生效。
Spring Boot 里面没有 Spring 的配置文件,我们自己编写的配置文件,也不能自动识别。
想让 Spring 的配置文件生效,将其加载进来;使用 @ImportResource 标注在一个配置类上
1 |
|
不来编写 Spring 的配置文件
1 |
|
SpringBoot 推荐给容器中添加组件的方式;推荐使用全注解的方式
1、配置类 @Configuration ——> Spring 配置文件
2、使用**@Bean**给容器中添加组件
1 | /** |
配置文件占位符
随机数
1 | ${random.value}、${random.int}、${random.long} |
占位符获取之前配置的值,如果没有可以使用 指定默认值
1 | person.last-name=张三${random.uuid} |
Profile
多 Profile 文件
我们在主配置文件编写的时候,文件名可以是 application-{profile}.properties/yml
默认使用 application.properties
的配置。
yml 支持多文档块方式
1 | server: |
激活指定 profile
1、在配置文件
中指定 spring.profiles.active=dev
2、命令行
:
1 | java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev; |
可以直接在测试的时候,配置传入命令行参数:
3、虚拟机
参数(JVM);
1 | -Dspring.profiles.active=dev |
配置文件加载位置
Spring boot 启动会扫描以下位置的 application.properties
或者 application.yml
文件作为 Spring boot 的默认配置文件。
file:
./config/
file:
./
classpath:
/config/
classpath:
/
其中 file
表示当前项目文件路径下(项目/
),classpath
表示类路径(项目/src/main/resources
)。
优先级 由高到底,高优先级的配置会覆盖低优先级的配置;
Spring Boot 会从这四个位置全部加载主配置文件;互补配置
我们还可以通过 spring.config.location
来改变默认的配置文件位置
项目打包好以后,我们可以使用命令行参数
的形式,启动项目的时候来指定配置文件的新位置
,指定的配置文件
和默认加载的这些配置文件
共同起作用形成互补配置
。
1 | java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --spring.config.location=D:/application.properties |
外部配置加载顺序
Spring Boot 也可以从以下位置加载配置,优先级从高到低
;高优先级的配置覆盖低优先级的配置
,所有的配置会形成互补配置
。
1) 命令行参数
所有的配置都可以在命令行上进行指定:
1 | java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --server.port=8087 --server.context-path=/abc |
多个配置用空格分开; --配置项=值
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
指定的默认属性。
所有支持的配置加载来源参考官方文档:
自动配置原理
配置文件到底能写什么?怎么写?自动配置原理是什么?
自动配置原理:
1)、SpringBoot 启动的时候加载主配置类,开启了自动配置功能 @EnableAutoConfiguration
2)、@EnableAutoConfiguration 作用:
利用
EnableAutoConfigurationImportSelector
给容器中导入一些组件?可以查看
selectImports()
方法的内容;List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
获取候选的配置。SpringFactoriesLoader.loadFactoryNames()
,扫描所有 jar 包类路径下(META-INF/spring.factories
),把扫描到的这些文件的内容包装成properties
对象,从 properties 中获取到EnableAutoConfiguration.class
类(类名)对应的值,然后把他们添加在容器中.
将类路径下 META-INF/spring.factories 里面配置的所有EnableAutoConfiguration的值加入到了容器中;
1 | # Auto Configure |
每一个这样的 xxxAutoConfiguration
类都是容器中的一个组件,都加入到容器中;用他们来做自动配置。
3)、每一个自动配置类进行自动配置功能;
4)、以 HttpEncodingAutoConfiguration(Http编码自动配置) 为例解释自动配置原理;
1 | //表示这是一个配置类,以前编写的配置文件一样,也可以给容器中添加组件 |
根据当前不同的条件判断,决定这个配置类是否生效?
一但这个配置类生效,这个配置类就会给容器中添加各种组件,这些组件的属性是从对应的 properties
类中获取的,这些类里面的每一个属性又是和配置文件绑定的。
5)、所有在配置文件中能配置的属性都是在 xxxxProperties
类中封装着;配置文件能配置什么就可以参照某个功能对应的这个属性类。
1 | //从配置文件中获取指定的值和bean的属性进行绑定 |
精髓:
1)、SpringBoot 启动会加载大量的自动配置类
2)、我们看我们需要的功能有没有SpringBoot默认写好的自动配置类;
3)、我们再来看这个自动配置类中到底配置了哪些组件;(只要我们要用的组件有,我们就不需要再来配置了)
4)、给容器中自动配置类添加组件的时候,会从properties类中获取某些属性。我们就可以在配置文件中指定这些属性的值;
xxxxAutoConfigurartion
:是做自动配置的类,会给容器中添加组件。
xxxxProperties
:封装配置文件中相关的属性。
细节
@Conditional 派生注解(Spring 注解版原生的 @Conditional 作用)
作用:必须是 @Conditional
指定的条件成立,才给容器中添加组件,配置配里面的所有内容才生效;
@Conditional 扩展注解 | 作用(判断是否满足当前指定条件) |
---|---|
@ConditionalOnJava | 系统的 java 版本是否符合要求 |
@ConditionalOnBean | 容器中存在指定 Bean; |
@ConditionalOnMissingBean | 容器中不存在指定 Bean; |
@ConditionalOnExpression | 满足 SpEL 表达式指定 |
@ConditionalOnClass | 系统中有指定的类 |
@ConditionalOnMissingClass | 系统中没有指定的类 |
@ConditionalOnSingleCandidate | 容器中只有一个指定的 Bean,或者这个 Bean 是首选 Bean |
@ConditionalOnProperty | 系统中指定的属性是否有指定的值 |
@ConditionalOnResource | 类路径下是否存在指定资源文件 |
@ConditionalOnWebApplication | 当前是 web 环境 |
@ConditionalOnNotWebApplication | 当前不是 web 环境 |
@ConditionalOnJndi | JNDI 存在指定项 |
自动配置类必须在一定的条件下才能生效;
我们怎么知道哪些自动配置类生效;
我们可以通过启用 debug=true 属性;来让控制台打印自动配置报告,这样我们就可以很方便的知道哪些自动配置类生效;
1 | ========================= |