SpringBoot-yaml配置注入

2. yaml配置注入

2.1 配置文件

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

• application.properties

• • 语法结构 ：key=value

• application.yml

• • 语法结构 ：key：空格 value
  • 注意：yaml配置时在”：“号的后面必须严格空一个空格

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

比如我们可以在配置文件中修改Tomcat 默认启动的端口号（8080）

server.port=8081

2.2 yaml概述和语法

1.概述

​ YAML是 "YAML Ain't a Markup Language" （YAML不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是："Yet Another Markup Language"（仍是一种标记语言）

这种语言以数据作为中心，而不是以标记语言为重点！

以前的配置文件，大多数都是使用xml来配置

传统xml配置：

	<server>
	<port>8081<port>
	</server>

yaml配置：

	server：
	prot: 8080

2.基础语法

说明：语法要求严格！

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]

修改SpringBoot的默认端口号

配置文件中添加，端口号的参数，就可以切换端口；

	server:
	port: 8081

2.3 yaml注入配置文件

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

2、编写两个实体类进行测试

	@Component //注册bean到容器中
	public class Dog {
	private String firstname;
	private Integer age;
	// 有参无参构造、get、set方法、toString()方法
	}

	@Component //注册bean到容器中
	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()方法
	}

3、使用yaml配置的方式进行注入，在先前创建好的application.yaml文件中进行配置！

	Person:
	name: aadzj@qq.com
	age: 18
	happy: true
	birth: 2021/09/22
	maps: {k1: v1,k2: v2}
	hello: hi
	lists:
	-code
	-music
	-girl
	dog:
	name: 旺财
	age: 3
	dog:
	first-name: 小黄
	age: 5

4、把在application.yaml文件中配置好的数据注入到实体类中

如何实现注入呢？在先前的实体类中添加如下注解：@ConfigurationProperties(prefix = "xxx")

	/*
	@ConfigurationProperties作用：
	将配置文件中配置的每一个属性的值，映射到这个组件中；
	告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
	参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应
	*/
	@Component //注册bean到容器中
	@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、此时 IDEA 提示，springboot配置注解处理器没有找到，让我们看文档，我们可以查看文档，找到一个依赖！

6、在pom.xml文件中添加配置文件处理器依赖：spring-boot-configuration-processor

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

这样下来就把application.yaml文件中的数据注入到实体类中了

如果配置文件的key值和实体类属性的名设置的不一样，则结果输出为null，该属性值注入失败

2.4 加载指定的配置文件

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

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

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

name=kuangshen

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

	@PropertySource(value = "classpath:person.properties")
	@Component //注册bean
	public class Person {
	private String name;
	private Integer age;
	private Boolean happy;
	......
	}

2.5 配置文件占位符

	person:
	name: aadzj@qq.com${random.uuid} # 随机uuid
	age: ${random.int} # 随机int
	happy: true
	birht: 2021/09/22
	maps: {k1: v1,k2: v2}
	hello: hi
	lists:
	-code
	-music
	-girl
	dog:
	name: ${Person.hello:hello}_旺财 #使用占位符方式
	age: 3
	dog:
	first-name: 小黄
	age: 5

2.6 结论

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

settings-->File Encodings 中配置

配置yml和配置properties都可以获取到值 ， 强烈推荐 yaml

如果我们在某个业务中，只需要获取配置文件中的某个值，可以使用一下 @value；

如果说，我们专门编写了一个JavaBean来和配置文件进行一一映射，就直接@configurationProperties，不要犹豫！