SpringBoot（基础篇 ==＞ 详解yaml文件的使用

本章导学：

SpringBoot有三种配置文件格式，分别为：properties格式，yml格式，yaml格式

本章重点学习yml格式（企业流行格式）

---

 一、三种配置文件

1.1，.properties配置文件 

1.2， .yaml配置文件 （重点掌握） 

1.3，.yml配置文件

那么问题来了，如果三种配置文件共存，谁的优先级最高呢？ 

我们把三个配置文件放一起，看看谁的端口号被执行了

此时加载的是.properties文件里的配置信息

把.properties文件删除，我们在运行看看 

此时加载的是.yml文件里的配置信息 

结论：当三种配置文件共存时，优先级为：properties > yml > yaml 

二、yaml配置文件 

2.1，yaml 介绍

YAML（YAMl Ain't Markup Language），一种数据序列化格式

优点：

• 容易阅读
• 容易与脚本语言交互
• 以数据为中心，重数据轻格式 

YAML文件扩展名：

• .yml（主流）
• .yaml 

2.2，yaml语法规则 

• 大小写敏感
• 属性层级关系用多行描述，每行结尾使用冒号表示结束
• 使用缩进表示层级关系，同层级左侧对其，只允许使用空格
• 属性值前面需要添加空格
• 属性名与属性值直接必须使用冒号+空格作为分割
• #表示注释 

2.2.1，字面值表示方式（了解即可） 

 2.2.2，数组表示方式

 数组表示方式：在属性名书写位置的下方使用减号作为开始符号，每写一个减号都要带空格

2.2.4，数组对象表示方式

  

2.3，yaml文件读取方法

2.3.1，读取单一属性变量

package com.brrbaii.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class testController {

    //读取yaml文件中的单一数据
    @Value("${name2}")
    private String myName;

    //读取有层级关系的数据
    @Value("${brrbaii.description}")
    private String  myDescription;

    //读取数组中的数据
    @Value("${likes2[0]}")
    private String  myLike;

    //读取对象数组中的数据（年龄）
    @Value("${users[0].age}")
    private String  myAge;

    @GetMapping
    public String getTest(){
        System.out.println("-----读取yaml文件中的单一数据-----\n"+myName);
        System.out.println("-----读取有层级关系的数据-----\n"+myDescription);
        System.out.println("-----读取数组中的数据-----\n"+myLike);
        System.out.println("-----读取对象数组中的数据（年龄）-----\n"+myAge);
        return "读取测试";
    }
}

总结：

        1，使用@Value注解配合SPEL读取属性

        2，多个层级的属性，按层级关系逐一书写即可

        3，属性名引用方式为：${一级属性名.二级属性名}

2.3.2，yaml文件中的变量引用 

2.3.4，一键读取全部属性变量 

使用自动装配将所有的数据封装到一个对象Environment中

@Autowired

private Environment env; 

 

我们直接调用这个对象的getProperty方法（还是写层级关系）就可以读取任意数据啦

三、重点：yml读取引用类型数据 

如果我们不想把配置文件的全部数据都注入进去，只想注入指定的数据该怎么办呢？

比如注入这个datasource

 1，为当前信息创造实体类

//1，定义数据模型封装yaml文件中对应的数据
//2，把当前类给Spring管理

//3，指定加载的数据，注意prefix的值要和配置文件里的属性名一样

package com.brrbaii;

import lombok.Data;
import lombok.ToString;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

//1，定义数据模型封装yaml文件中对应的数据
@Data
@ToString
//2，把当前类给Spring管理
@Component
//3，指定加载的数据，注意prefix的值要和配置文件里的属性名一样
@ConfigurationProperties(prefix = "datasource")

public class MyDataSource {
    private String driver;
    private String url;
    private String username;
    private String password;

}

2， 将实体类自动装配进来

package com.brrbaii.controller;

import com.brrbaii.MyDataSource;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.env.Environment;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class testController {
    

    @Autowired
    private MyDataSource myDataSource;


    @GetMapping
    public String getTest(){


        System.out.println(myDataSource);
        System.out.println("===============");
        System.out.println(myDataSource.getDriver());
        System.out.println(myDataSource.getUrl());
        System.out.println(myDataSource.getUsername());
        System.out.println(myDataSource.getPassword());

        return "test";
    }
}

最终测试结果：