yaml配置文件与注入

一、yaml语法学习

1. 配置文件

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

• application.properties

• • 语法结构 ：key=value

• application.yml

• • 语法结构 ：key：空格 value

配置文件的作用 ：修改SpringBoot自动配置的默认值，因为SpringBoot在底层已经自动配置好了。如我们可以在配置文件中修改Tomcat 默认启动的端口号

server.port=8081

2. 什么是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：
  prot: 8080

3. yaml语法

说明：语法要求严格

1、空格不能省略

2、以缩进来控制层级关系，只要是左边对齐的一列数据都是同一层级

3、属性和值的大小写敏感

配置普通数据

字面量：如普通的值 [ 数字，布尔值，字符串 ]

字面量直接写在后面就可以 ， 字符串默认不用加上双引号或者单引号

语法： key: value

k: v

注意：

• value之前有一个空格

• “ ” 双引号不会转义字符串里面的特殊字符 ， 特殊字符能表达本身想表示的意思

  比如 ：name: "Hello \n Springboot" 输出 ：Hello 换行 Springboot

• '' 单引号会转义特殊字符 ， 特殊字符最终会变成和普通字符一样输出

  比如 ：name: ‘Hello \n Springboot’ 输出 ：Hello \n Springboot

配置对象、Map（键值对）数据

#对象、Map格式
key: 
	key1: value1
	key2: value2
	
#行内写法
	key: {key1: value1,key2: value2}

示例代码：

• person:
    name: java
    age: 18
  
  #或者
  person: {name: haohao,age: 31}
  

配置数组（List、Set）数据

用-值表示数组中的一个元素，注意value与数据之间的 - 之间存在一个空格

#语法：
key: 
	- value1
	- value2
	
#行内写法
	key: [value1,value2]

二、注入配置文件

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

1. yaml注入配置文件

① 在springboot项目中的resources目录下新建一个文件 application.yml

② 编写一个实体类 Dog

package com.kuang.springboot.pojo;

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

③ 试着用@Value给bean注入属性值

@Component //注册bean
public class Dog {
    @Value("旺财")
    private String name;
    @Value("1")
    private Integer age;
}

④ 在SpringBoot的测试类下注入并输出

@SpringBootTest
class DemoApplicationTests {

    @Autowired //将狗狗自动注入进来
    Dog dog;

    @Test
    public void contextLoads() {
        System.out.println(dog); //打印看下狗狗对象
    }

}

结果成功输出，@Value注入成功

Dog{name='旺财', age=1}

⑤ 再编写一个复杂点的实体类

@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()方法  
}

⑥ 使用yaml配置的方式进行注入

写的时候注意区别和优势，首先编写一个yaml配置

person:
  name: qinjiang
  age: 3
  happy: false
  birth: 2000/01/01
  maps: {k1: v1,k2: v2}
  lists:
   - code
   - girl
   - music
  dog:
    name: 旺财
    age: 1

⑦ 把对象的所有值都写好后，注入到类中

/*
@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;
}

⑧ IDEA 提示，springboot配置注解处理器没有找到

Not Found

The requested URL /spring-boot/docs/2.3.3.RELEASE/reference/html/configuration-metadata.html was not found on this server.

查看文档(在网址中更改版本获得，如回到2.1.9)，找到一个依赖

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

⑨ 确认以上配置都完成后，去测试类中测试

@SpringBootTest
class DemoApplicationTests {

    @Autowired
    Person person; //将person自动注入进来

    @Test
    public void contextLoads() {
        System.out.println(person); //打印person信息
    }

}

结果：所有值全部注入成功

2. 加载指定配置文件

@PropertySource ：加载指定的配置文件；
@configurationProperties：默认从全局配置文件中获取值

1. 在resources目录下新建一个person.properties文件

name=hello

2. 在代码中指定加载person.properties文件

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

3. 再次输出测试，指定配置文件绑定成功

配置文件占位符

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

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

回顾properties配置

上面采用的yaml方法都是最简单的方式，也是开发中最常用的、pringboot所推荐的

接下来看看其他的实现方式，原理都是相同的，写还是那样写

配置文件除了yml还有之前常用的properties

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

测试步骤

1. 新建一个实体类User

@Component //注册bean
public class User {
    private String name;
    private int age;
    private String sex;
}

2. 编辑配置文件 user.properties

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

3. 在User类上使用@Value来进行注入

@Component //注册bean
@PropertySource(value = "classpath:user.properties")
public class User {
    //直接使用@value
    @Value("${user.name}") //从配置文件中取值
    private String name;
    @Value("#{9*2}")  // #{SPEL} Spring表达式
    private int age;
    @Value("男")  // 字面量
    private String sex;
}

4. Springboot测试

SpringBootTest
class DemoApplicationTests {

    @Autowired
    User user;

    @Test
    public void contextLoads() {
        System.out.println(user);
    }

}

结果正常输出

对比小结

@Value使用起来并不友好！我们需要为每个属性单独注解赋值比较麻烦

1. @ConfigurationProperties只需要写一次即可 ， @Value则需要每个字段都添加
2. 松散绑定：这个什么意思呢? 比如yml中写的last-name，这个和lastName是一样的， - 后面跟着的字母默认是大写的。这就是松散绑定
3. JSR303数据校验 ，可以在字段是增加一层过滤器验证 ， 保证数据的合法性
4. 复杂类型封装，yml中可以封装对象 ， 使用value就不支持

结论：

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

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

3. 如果专门编写了一个JavaBean来和配置文件进行一一映射，就直接使用@configurationProperties

JSR303数据校验

Springboot中可以用@validated来校验数据，如果数据异常则会统一抛出异常，方便异常中心统一处理。这里来写个注解让name只能支持Email格式

@Component //注册bean
@ConfigurationProperties(prefix = "person")
@Validated //数据校验
public class Person {
    @Email(message="邮箱格式错误") //name必须是邮箱格式
    private String name;
}

运行结果：default message [不是一个合法的电子邮件地址]

使用数据校验，可以保证数据的正确性； 下面列出一些常见的使用

@NotNull(message="名字不能为空")
private String userName;
@Max(value=120,message="年龄最大不能查过120")
private int age;
@Email(message="邮箱格式错误")
private String email;

空检查
@Null 验证对象是否为null
@NotNull 验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空
格.
@NotEmpty 检查约束元素是否为NULL或者是EMPTY.
Booelan检查
@AssertTrue 验证 Boolean 对象是否为 true
@AssertFalse 验证 Boolean 对象是否为 false
长度检查
@Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内
@Length(min=, max=) string is between min and max included.
日期检查
@Past 验证 Date 和 Calendar 对象是否在当前时间之前
@Future 验证 Date 和 Calendar 对象是否在当前时间之后
@Pattern 验证 String 对象是否符合正则表达式的规则
.......等等
除此以外，我们还可以自定义一些数据校验规则

三、多环境切换

profile是Spring对不同环境提供不同配置功能的支持，可以通过激活不同的环境版本，实现快速切换环境

多配置文件

在主配置文件编写的时候，文件名可以是 application-{profile}.properties/yml , 用来指定多个环境版本。例如：application-test.properties 代表测试环境配置 application-dev.properties 代表开发环境配置
但是Springboot并不会直接启动这些配置文件，它默认使用application.properties主配置文件。但可以通过配置来选择需要激活的环境

#比如在配置文件中指定使用dev环境，我们可以通过设置不同的端口号进行测试；
#我们启动SpringBoot，就可以看到已经切换到dev下的配置了；
spring.profiles.active=dev

yml的多文档块

和properties配置文件中一样，但使用yml去实现不需要创建多个配置文件，更加方便

server:
	port: 8081
#选择要激活那个环境块
spring:
	profiles:
		active: prod
---
server:
	port: 8083
spring:
	profiles: dev #配置环境的名称
	
---
server:
	port: 8084
spring:
	profiles: prod #配置环境的名称

注意：如果yml和properties同时都配置了端口，并且没有激活其他环境 ， 默认会使用properties配置文件的

配置文件加载位置

外部加载配置文件的方式很多，一般选择最常用的即可，在开发的资源文件中进行配置

springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件

优先级1：项目路径下的config文件夹配置文件
优先级2：项目路径下配置文件
优先级3：资源路径下的config文件夹配置文件
优先级4：资源路径下配置文件

优先级由高到底，高优先级的配置会覆盖低优先级的配置；
SpringBoot会从这四个位置全部加载主配置文件；互补配置