17、YML配置文件 及让springboot启动时加载我们自定义的yml配置文件的几种方式

目录

YML配置文件及加载自定义配置文件的几种方式

YAML配置文件介绍

其实本质和 .properties 文件的是一样的。

Spring Boot默认使用 SnakeYml 工具来处理YAML配置文件，SnakeYml工具默认就会被spring-boot-starter导入，因此无需开发者做任何额外配置。

YAML本质是JSON的超级，它在表示结构化文档时更有表现力。

properties文件使用 【.分隔符】作为结构化的表现：

 spring.datasource.url=a
 spring.datasource.user=b
 spring.datasource.password=c
 server.name=fkjava
 server.addrs[0]=guangzhou
 server.addrs[1]=shenzhen
 java.user.names=java01, java02

YAML文件使用【缩进和冒号】作为结构化的表现，且属性值与key之间也用冒号隔开

 spring:
   datasource:
     url: a
     user: b
     password: c
 server:
   name: fkjava
   addrs: 
     - guangzhou
     - shenzhen
 java:
   user:
     names: java01, java02

【备注】：无论是properties文件，还是YAML配置文件，都可使用逗号隔开的多个值来作为List或数组。

手动加载自定义配置文件

加载自定义的配置文件：

1、PropertiesFactoryBean | YamlPropertiesFactoryBean：将属性文件或YAML文件加载成Properties对象。

2、YamlMapFactoryBean：它将YAML文件加载成Map对象。

3、PropertiesPropertySourceLoader | YamlPropertySourceLoader：将属性文件或YAML文件加载成PropertySource。
  通常用于在配置环境后处理器中使用，接下来可将PropertySource添加到配置环境中。
  
4、@PropertySource注解和@TestPropertySource注解只能读取属性文件（propertie文件）
  告诉Spring Boot要去加载哪些额外的属性文件。

代码演示:01：

演示如何通过 YamlPropertySourceLoader 来加载我们自定义的yml配置文件，通过配置环境后处理器，从自定义的yml中获取值。

演示这句话：

PropertiesPropertySourceLoader | YamlPropertySourceLoader：将属性文件或YAML文件加载成PropertySource。

通常用于在配置环境后处理器中使用，接下来可将PropertySource添加到配置环境中。

步骤：

1、自定义一个yml的配置文件

2、编写一个控制器类

编写一个控制器类，通过注解@Value去获取自定义yml配置文件里面的属性值，这@Value是import org.springframework.beans.factory.annotation.Value;

3、定义一个环境配置后处理器

定义一个环境配置后处理器，用来让springboot启动的时候额外加载我们自定义的这个yml配置文件。

定义一个环境配置后处理器的类，需要实现EnvironmentPostProcessor这个接口，然后重写run方法。

4、配置环境后处理器注册到spring.factories中

最后需要把这个配置环境后处理器注册到spring.factories中。

5、再去访问 PropertySourceLoaderController类里面的testPSL方法，看有没有成功拿到自定义yml配置文件里面的值并返回。

代码演示02：

演示这句：

YamlMapFactoryBean：它将YAML文件加载成Map对象。

用YamlMapFactoryBean这个工厂bean来加载我们自定义的yml配置文件

代码示例：

步骤：

1、自定义yml配置文件

2、定义一个配置类，

定义一个配置类，让bean加载指定的yml自定义配置文件，将这个bean注入到后面创建的PropertySourceLoaderController类的properties字段里面使用。

用@Configuration修饰的类为配置类，在项目启动的时候就会加载这个配置类，然后spring容器就会有我们添加的这个 ymlFB 的bean。

3、添加Properties的属性

创建一个类，然后添加一个Properties的属性，把我们创建的用来加载自定义yml配置文件的bean注入进来。

@Resource(name = “ymlFB”) //根据名称注入，这里把名为ymlFB的bean注入到这个属性中 ， autowire是根据类型注入

4、进行访问：

总结

用YamlMapFactoryBean这个工厂bean来加载我们自定义的yml配置文件的完整流程