一、YAML基本语法
- 使用缩进表示层级关系
- 缩进时不允许时候TAB键,只允许使用空格
- 缩进的空格数目不重要,只要相同层级的元素左侧对齐即可
- 大小写敏感
1.1 YAML支持的三种数据结构
1. 字面量
普通值的值(数字、字符串、布尔)
字符串默认不用加上单引号和双引号。
双引号:不会转义字符串里面的特殊字符,特殊字符会作为本身想表示意思
单引号:会转义特殊字符,特殊字符最终只是一个普通的字符串
2. 对象、Map(属性和值)
friends:
lastName: zhangsan
age: 30
行内写法
friends: {lastName:zhangsan,age:30}
3. 数组(List、Set)
用-值表示数组中的一个元素
pets:
- cat
- dog
- pig
行内写法
pets: [cat,dog,pig]
二、读取YAML配置文件的值
方式一:@ConfigurationProperties
-
配置一个实体类组件,配置文件中每一个属性的值
@ConfigurationProperties:告诉springboot本类的所有属性都是配置文件 prefix:配置文件中哪个下面的所有属性一一映射 @Component @ConfigurationProperties(prefix = "person") public class Person{ private String lastName; private Date birth; private Boolean boss; private Map<String,Object> map; private List<Object> list; private Dog dog; }
使用配置文件需要导入依赖
<dependency>
<groupId>org.springframework.boot<groupId>
<artifactId>spring-boot-configuration-processor<artifactId>
<optional>true<optional>
<dependency>
只有这个组件是容器中的组件,才能使用容器提供的@ConfigurationProperties功能
方式二:@Value
@Component
public class Person{
//@Value等同于以下配置
<bean class = "Person">
<property name="lastName" value="?" />
</bean>
@Value("字面量、${key}从环境变量、配置文件中获取/#{SPEL}")
private String name;
private Map<String,Object> map;
private List<Object> list;
private Boolean boss;
}
@Value和ConfigurationProperties区别
@Configuration | @Value | |
---|---|---|
功能 | 批量注入配置文件中的属性 | 一个一个指定 |
松散绑定(松散语法) | 支持 | 不支持 |
Spel | 不支持 | 支持 |
JSR303数据校验 | 支持 | 不支持 |
复杂类型封装 例如map | 支持 | 不支持 |
@Validated
用来验证每个值的校验 只能和 @ConfigurationProperties 使用
什么时候用value和configurationproeprties
- 只是在某个业务逻辑中需要获取一下配置文件中的某项值,使用@Value
- 专门编写了一个javabean来和配置文件进行映射;使用@configurationproperties
配置properties配置文件编码问题
person.lastName=张三
person.age=18
person.birth=2017/12/15
person.lists=a,b,c
person.dog.name=dog
#Idea使用编码是UTF-8
三、spring高级配置读取
@PropertySource、@ImportResource、@Bean
@PropertySource:加载指定的配置文件
@PropertySource(value = {classpath:person.properties})
@ConfigurationProperties:从全局配置文件中获取
@ImportResource:导入Spring的配置文件,让配置文件里面的内容生效
<bean id="helloService" class="com.atguigu.springboot.service">
<bean>
@Autowired
ApplicationContext ioc;
-
springboot里面没有spring的配置文件,我们自己编写的配置文件也不能识别
-
需要标注在主配置类上
@ImportResource(localtions = {"classpath:beans.xml"}) 导入spring的配置文件让其生效
springboot推荐给容器中添加组件的方式:推荐使用全注解的方式
- 配置类 ==== spring配置文件
- @Configuration:指明当前类是一个配置类,就是代替之前的spring文件
@Configuration
public class MyAppConfig{
//将方法的返回值添加到容器中,容器的默认id就是方法名字
@Bean
public HelloService helloService(){
return new HelloService();
}
}
配置文件的占位符
-
RandomValuePropertySource:配置文件中可以使用随机数
- ${random.value}
- ${random.int}
- ${ramdom.long}
- ${random.int(10)}
- ${random.int[1024,65535]}
-
属性配置占位符
app.name= MyApp app.description= ${app.name} is Spring Boot application
- 可以在配置文件中引用前面配置过的属性(优先级前面配置过的也可以用)
- ${app.name:默认值}:来指定找不到的属性时的默认值
四、Profile
Profile是spring对不同环境提供不同配置功能的支持,可以通过激活、指定参数等方式快速切换环境
- 多profile文件形式:
- 格式:application-{profile}.properties
- application-dev.properites、application-prod.properties
- 多profile文档块模式
- 激活方式:
- 命令行:–spring.profiles.active=dev
- 配置文件:spring.profiles.active=dev
- jvm参数:-Dspring.profile.active=dev
多Profile文件
在主配置文件编写的时候,文件名可以是 application-{profile}.properties/yml
默认:使用application.properties的配置
- application-dev.properties
- application-prod.properties
激活指定Profile
- 在配置文件中指定 spring.profiles.active=dev
yml支持多文档块方式
不用写很多配置文件了
server:
port: 8080
spring:
profiles:
active: dev
--- //这是文档块
server:
port: 8084
spring:
profiles: dev
--- //这是文档块
server:
port :8083
spring:
profiles: prod
命令行模式
在Program argument中配置命令行
Program argument: --spring.profiles.active=dev
五、配置文件加载位置
- springboot 启动会扫描以下位置的application.properties或者application.yml文件作为spring boot的默认配置文件
- file:./config/
- file:./
- classpath:/config/
- classpath:/
- 以上是按照【优先级从高到低】的顺序,所有位置的文件都会被加载,【高优先级配置内容】会覆盖低优先级内容
- 也可以通过spring.config.location来改变默认配置
- 互补配置
- 用高优先级配置部分内容,低优先级全部内容
spring.config.location改变配置文件
项目打包之后,使用命令行参数的形式,启动项目的时候指定配置文件的新位置;
指定的配置文件和默认加载的配置文件会一起起作用形成互补配置
java -jar 打包文件 --spring.config.location=配置文件路径
六、外部配置文件加载顺序
从以下位置加载配置,优先级从高到低
- 命令行参数
- 来自java:comp/env的JNDI属性
- 操作系统环境变量
- RandomValuePropertySource配置的random.*属性
- jar包外部的application-{profile}.properties或application.yml(带spring.profile)文件
- jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件
- jar包外部的application.properties或application.yml(不带spring.profile)配置文件
- jar包内部的application.properties或application.yml(不带spring.profile)配置文件
- @Configuration注解类上的@PropertySource
- 通过SpringApplication.setDefaultProperties指定的默认属性
七、自动配置原理
- springboot启动的时候加载主配置类,开启了自动配置功能@EnableAutoConfiguration
- @EnableAutoConfiguration
- 利用EnableAutoConfigurationImportSelector给容器中导入一些组件
八、@Conditional&自动配置报告
@Conditional派生注解(spring注解原生的@Conditional作用)
作用:必须是@Conditional指定的条件成立,才能给容器添加组件,配置里面的内容才生效