为什么说yaml是学习SpringBoot必会的配置文件？

为什么说yaml学习SpringBoot必会的配置文件？

此文为跟随狂神学习笔记，记录学习过程，如有逻辑错误或理论有误，欢迎在评论区指正。如果觉得有用，一键三连更是对我最大的鼓励💬🥂🥂

1、yaml概述

YAML（/ˈjæməl/，尾音类似camel骆驼）是一个可读性高，用来表达数据序列化的格式。YAML 的语法和其他高级语言类似，并且可以简单表达清单、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲（例如：许多电子邮件标题格式和YAML非常接近）。这种语言以数据作为中心，而不是以标记语言为重点。

类似的配置文件xml，比如在Spring中使用的.xml配置文件；Mybatis中配置和映射文件格式。但在SpringBoot中，使用.yaml会更加的方便，如下一个简单的端口配置。

传统的xml配置：

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

yaml配置：

server：
  prot: 8080

2、yaml基础语法

语法要求严格

• 大小写敏感
• 属性和值的大小都是十分敏感的
• 使用缩进表示层级关系,只要左边对齐的一列数据都是同层级的
• 缩进不允许使用tab，只允许空格
• 缩进的空格数不重要，只要相同层级的元素左对齐即可
• '#'表示注释

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

字面量值键值对使用冒号结构表示 key：value，冒号后面要加一个空格

k: v

注意：

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

​ 比如 ：name: ”xiao \n jiang“ 输出 ：xiao 空格 jiang

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

  比如 ：name: ‘xiao \n jiang’ 输出 ：xiao \n jiang

对象、Map（键值对）

k:
	v1:
	v2:

student:
	name: lisiqiang
	age: 3

也可使用行内写法 注：冒号后加空格

student: {name: lisiqiang,age: 3}

数组(List、set)

用 -值表示数组中的一个元素

pets：
 - cat
 - dog
 - camel

行内写法

pets: [cat,dog,camel]

数组也可以使用流式(flow)的方式表示,每个数组元素又是由id name price

companies: [{id: 1,name: company1,price: 200W},{id: 2,name: company2,price: 500W}]

复合结构

数组和对象可以构成复合结构，例：

languages:
  - Ruby
  - Perl
  - Python 
websites:
  YAML: yaml.org 
  Ruby: ruby-lang.org 
  Python: python.org 
  Perl: use.perl.org

修改SpringBoot的默认端口号，也可配置多套端口使用 — 分隔

server:
  port: 8081
-
spring:
  profiles:
    active: prod  #选择要激活那个环境块

---
server:
  port: 8082
spring:
  profiles: dev #配置环境的名称


---
server:
  port: 8083
spring:
  profiles: prod  #配置环境的名称

​ 扩展:设置多套端口号是为了可以进行多环境切换,激活不同的环境版本，实现快速切换版本环境,上面是使用yaml配置躲到环境，接下来使用properties来配置。

我们在主配置文件编写的时候，文件名可以是 application-{profile}.properties , 用来指定多个环境版本（默认使用application.properties主配置）；如：

application-test.properties 代表测试环境配置

application-dev.properties 代表开发环境配置

我们需要激活一个环境：

spring.profile.active=dev

3、yaml注入配置文件

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

1、对比@Value注解

在springboot项目中的resources目录下新建一个文件application.yaml（必须以application开头才会被springboot识别）

​ 扩展：application.yaml文件可以在任何地方创建，其优先级为:

  file:./config/   >    file:./   >   classpath:/config/  >    classpath:/
优先级1：项目路径下的config文件夹配置文件
优先级2：项目路径下配置文件
优先级3：资源路径下的config文件夹配置文件
优先级4：资源路径下配置文件

一般我们给一个bean注入属性值是通过@Value注解的方式

@Component //注册bean到容器中
public class Dog {
    @Value("来福")
    private String name;
    @Value("18")
    private Integer age;
}

在SpringBoot测试类中输出实体类：

@SpringBootTest  //标准的SpringBoot测试类的注解
class DemoApplicationTests {
    @Autowired //将狗狗自动注入进来
    Dog dog;

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

结果成功输出，@Value注入成功，这是我们原来的办法，但是一单属性过多，就容易造成代码冗余。

我们再编写一个复杂一点的实体类：Person类

@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的方式进行注入！

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注解的处理器没有找到，需要点开文档找到依赖导进去。

<!-- 导入配置文件处理器，配置文件进行绑定就会有提示，需要重启 -->
<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信息
    }
}

同样的我们也能打印出来，由此看来，使用yaml配置的方式，不仅可以减少代码量，也能降低代码的耦合性。

【注意】：若配置文件的key值和属性值设置的不一样，结果会输出为null，注入失败。这里就要提到新的名词松散绑定,虽然值和属性设置不一样会注入不进，但是也有特定的情况。比如比如我的yaml中写的last-name，这个和lastName是一样的， - 后面跟着的字母默认是大写的。这就是松散绑定。

2、对比properties配置

在我们使用Mybatis时免不了使用properties配置文件来定义一些固定的属性，在SpringBoot中依旧可以使用properties来编辑配置文件。

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

settings–>FileEncodings 中配置；

新建一个实体类User

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

编辑配置文件user.properties

user.name=xiaojiang
user.age=18
user.sex=男

我们在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;
}

​ 扩展：上面代码中由许多Spring表达式特有的占位符，实际上还有许多的其他功能，比如JSR303数据校验:这个就是可以在字段上增加一层过滤验证，可以保证数据的合法性。需要导入javax.validation.constrains包，这里不深入了解，比如：

person:
    name: qinjiang${random.uuid} # 随机uuid
    age: ${random.int}  # 随机int

我们在SpringBoot中测试一下

@SpringBootTest
class DemoApplicationTests {

    @Autowired
    User user;

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

正常输出

使用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;
}

3、对比小结

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

由此看来：

1. 配置yaml和配置properties都能获取到值，并且SpringBoot强烈推荐使用yaml
2. 如果我们业务中需要获取配置信息中的一个值，我们可以使用一下@Value
3. 如果我们专门编写了一个JavaBean来与我们的配置文件进行一一映射，就直接使用@configurationProperties！