【SpringBoot】3、yaml配置【狂神篇】
yaml
也称yml；和xml、properties一样，都是配置文件SpringBoot推荐使用yaml
SpringBoot使用一个全局的配置文件 ， 配置文件名称是固定的 application
-
application.properties
-
- 语法结构 ：
key=value
- 语法结构 ：
-
application.yml
-
- 语法结构 ：
key：空格 value
- 语法结构 ：
配置文件的作用：修改SpringBoot自动配置的默认值，因为SpringBoot在底层都自动配置好了
1、yaml概述
YAML是 “YAML Ain’t a Markup Language” （YAML不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是：“Yet Another Markup Language”（仍是一种标记语言）
这种语言以数据作为中心，而不是以标记语言为重点！
以前的配置文件，大多数都是使用xml来配置；比如一个简单的端口配置，我们来对比下yaml和xml
- xml端口配置
<server>
<port>8081<port>
server>
- yaml端口配置
server:
port: 8080
port：与8080中间有空格
2、yaml基础语法
说明：语法要求严格！
1、空格不能省略
2、以缩进来控制层级关系，只要是左边对齐的一列数据都是同一个层级的
3、属性和值的大小写都是十分敏感的
- 字面量：普通的值 [ 数字，布尔值，字符串 ]
字面量直接写在后面就可以 ， 字符串默认不用加上双引号或者单引号；
k: v
注意：
-
“ ”双引号，不会转义字符串里面的特殊字符 ， 特殊字符会作为本身想表示的意思；比如 ：name: “kuang \n shen” 输出 ：kuang 换行 shen
-
''单引号，会转义特殊字符 ， 特殊字符最终会变成和普通字符一样输出比如 ：name: ‘kuang \n shen’ 输出 ：kuang \n shen
-
对象、Map(键值对)
#对象、Map格式
k:
v1:
v2:
在下一行来写对象的属性和值的关系，注意缩进；比如：
student:
name: qinjiang
age: 3
行内写法
student: {name: qinjiang,age: 3}
- 数组（List、Set）
用 - 值表示数组中的一个元素；比如：
pets:
- cat
- dog
- pig
行内写法
pets: [cat,dog,pig]
3、yaml注入配置文件
yaml文件更强大的地方在于，可以给实体类直接注入匹配值！
- Dog.java
@Component // 注册bean到容器中
@Data
public class Dog {
private String name;
private Integer age;
}
- Person.java
@Component
@Data
@ConfigurationProperties(prefix = "person")
public class Person {
private String name;
private Integer age;
private Boolean happy;
private Date birth;
private Map<String,Object> maps;
private List<Object> lists;
private Dog dog;
}
@ConfigurationProperties作用：将配置文件中配置的每一个属性的值，映射到这个组件中；告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定参数
prefix = “person”: 将配置文件中的person下面的所有属性一一对应默认从全局配置文件中获取值
添加 @ConfigurationProperties 后，IDEA中可能会有配置注解处理器没有找到的提示；加入下面依赖即可，不加也不会影响程序运行
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-configuration-processorartifactId>
<optional>trueoptional>
dependency>
- application.yml
person:
name: tuwer
age: 3
happy: false
birth: 2000/5/12
maps:
k1: v1
K2: v3
lists:
- code
- girl
- music
dog:
name: 旺财
age: 2
-
测试
HelloworldApplicationTests 为 SpringBoot 自动生成的测试类
@SpringBootTest
class HelloworldApplicationTests {
@Autowired // 自动注入
private Person person;
@Test
void contextLoads() {
System.out.println(person);
}
}
4、加载指定的配置文件
-
@PropertySource
加载指定的配置文件，可以自定义
@configurationProperties：默认从全局配置文件中获取值
- 在resources目录下新建一个person.properties文件
name=kuangshen- 修改Person实体类
@PropertySource(value = "classpath:person.properties")
@Component //注册bean
public class Person {
@Value("${name}")
private String name;
......
}
5、配置文件占位符
配置文件还可以编写占位符生成随机数等
person:
name: qinjiang${random.uuid} # 随机uuid
age: ${random.int} # 随机int
happy: false
birth: 2000/01/01
maps: {k1: v1,k2: v2}
lists:
- code
- girl
- music
dog:
name: ${person.hello:other}_旺财
age: 1
${random.uuid} ${random.int}
6、回顾properties配置
properties 中配置时，需要在类中属性上加 @Value 来注入
name=kuangshen
@PropertySource(value = "classpath:person.properties")
@Component //注册bean
public class Person {
@Value("${name}")
private String name;
......
}
7、比较
@Value这个使用起来并不友好！需要为每个属性单独注解赋值，比较麻烦
- @ConfigurationProperties 只需要写一次即可 ， @Value则需要每个字段都添加
- 松散绑定：比如 yml 中写的 last-name，这个和 lastName 是一样的， - 后面跟着的字母默认是大写的。这就是松散绑定
- JSR303数据校验：就是可以在字段上增加一层过滤器验证 ， 可以保证数据的合法性
- 复杂类型封装：yml 中可以封装对象 ， 使用value就不支持