yaml基本语法+配置注入

---

基本语法

配置文件

SpringBoot使用一个全局的配置文件 ， 配置文件名称是固定的

application.properties

语法结构 ：key=value

application.yaml

语法结构 ：key：空格 value

配置文件的作用 ：修改SpringBoot自动配置的默认值，因为SpringBoot在底层都给我们自动配置好了；

比如我们可以在配置文件中修改Tomcat 默认启动的端口号！测试一下！

server.port=8081

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

yaml与properties语法对比

application.yaml

# 可以注入到配置类中
# 对空格的要求十分高！

server:
  port: 8081

# 普通的 key-value
key: value

# 对象
student:
  name: allen
  age: 18

# 行内写法
suudent: {name: allen,age: 18}

# 数组
pets:
  - cat
  - dog
  - pig

pets: [cat,dog,pig]

application.properties

# properties只能保存键值对！
# key=value

student.name=allen
student.age=18

---

配置注入

yaml文件更强大的地方在于，它可以给实体类直接注入匹配值！

yaml注入配置文件

1、在springboot项目中的resources目录下新建一个文件 application.yaml

2、编写一个实体类 Dog；

@Component  //注册bean到容器中
public class Dog {
    private String name;
    private Integer age;

    //有参无参构造、get、set方法、toString()方法  
}

3、思考，我们原来是如何给bean注入属性值的！@Value, 注意是 String格式

@Component  //注册bean
public class Dog {

    //注入属性值，注意是String格式
    @Value("qianqian")
    private String name;
    @Value("18")
    private Integer age;
}

4、再编写一个复杂一点的实体类：Person 类

@Component
//绑定配置注入
@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;

    //有参无参构造、get、set方法、toString()方法  
}

5、编写一个yaml配置！注意空格

person:
  name: allen
  age: 18
  happy: false
  birth: 2020/12/21
  maps: {k1: v1,k2: v2}
  lists:
    - dog
    - music
    - code
  dog:
    name: qianqian
    age: 3

6、我们刚才已经把person这个对象的所有值都写好了，现在来注入到我们的Person类中

//注册bean组件
@Component
/**
@ConfigurationProperties作用：
将配置文件中配置的每一个属性的值，映射到这个组件中；
告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应
**/
//绑定配置注入
@ConfigurationProperties(prefix = "person")
public class Person {
    // ....
}

7、IDEA 提示，springboot配置注解处理器没有找到，让我们看文档，我们可以查看文档，找到一个依赖！

<!-- 导入配置文件处理器，配置文件进行绑定就会有提示，需要导入 -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-configuration-processor</artifactId>
  <optional>true</optional>
</dependency>

yaml配置注入到实体类完全OK！

加载指定的配置文件

@PropertySource ：加载指定的配置文件；

@configurationProperties：默认从全局配置文件中获取值；

1、我们去在resources目录下新建一个person.properties文件

name=kuangshen

2、然后在我们的代码中指定加载person.properties文件

@PropertySource(value = "classpath:person.properties")
@Component //注册bean
public class Person {

    @Value("${name}")
    private String name;

    ......  
}

配置文件占位符

配置文件还可以编写占位符生成随机数

person:
    name: allen${random.uuid} # 随机uuid
    age: ${random.int}  # 随机int
    happy: false
    birth: 2000/01/01
    maps: {k1: v1,k2: v2}
    lists:
      - code
      - music
    dog:
      name: ${person.hello:other}_浅浅
      age: 1

回顾properties配置

【注意】properties配置文件在写中文的时候，会有乱码 ， 我们需要去IDEA中设置编码格式为UTF-8；

settings–>FileEncodings 中配置；

编辑配置文件 user.properties

user1.name=allen
user1.age=18
user1.sex=男

对比小结

@Value这个使用起来并不友好！我们需要为每个属性单独注解赋值，比较麻烦；我们来看个功能对比图

1、@ConfigurationProperties只需要写一次即可 ， @Value则需要每个字段都添加

2、松散绑定：这个什么意思呢? 比如我的yml中写的last-name，这个和lastName是一样的， - 后面跟着的字母默认是大写的。这就是松散绑定。可以测试一下

3、JSR303数据校验 ， 这个就是我们可以在字段是增加一层过滤器验证 ， 可以保证数据的合法性

4、复杂类型封装，yml中可以封装对象 ， 使用value就不支持

结论：

1. 配置yml和配置properties都可以获取到值 ， 强烈推荐 yml；
2. 如果我们在某个业务中，只需要获取配置文件中的某个值，可以使用一下 @value；
3. 如果说，我们专门编写了一个JavaBean来和配置文件进行一一映射，就直接@configurationProperties，不要犹豫！