文章目录

  • Spring Boot——yaml语法使用
  • 1、什么是yaml
  • 2、yaml基础语法
  • 3、注入yaml文件


Spring Boot——yaml语法使用

配置文件

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

  • application.properties
    语法结构 ：key=value
server.port=8081
  • application.yml
    语法结构 ：key：空格 value
server:
  port: 8081

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

1、什么是yaml

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

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

2、yaml基础语法

说明：语法要求严格！

1、空格不能省略

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

3、属性和值的大小写都是十分敏感的。

server:
  port: 8081

#普通键值对
name: 万里

#对象,在下一行来写对象的属性和值得关系，注意缩进
student:
 name1: wanli
 age:3
#对象行内写法
student1: {name: wanli,age: 3}

#数组 用 - 值表示数组中的一个元素
pets:
  - cat
  - dog
  - pig
#行内写法
pets1: [cat,dog,pig]

注意：

  • “ ” 双引号，不会转义字符串里面的特殊字符 ， 特殊字符会作为本身想表示的意思；
    比如 ：name: “cheng\n shen” 输出 ：cheng换行 shen
  • ‘’ 单引号，会转义特殊字符 ， 特殊字符最终会变成和普通字符一样输出
    比如 ：name: ‘cheng\n shen’ 输出 ：cheng\n shen

3、注入yaml文件

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

编写两个实体类

@Component
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Dog {
    private String name;
    private Integer age;
}
@Component
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Person {
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birthday;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
}

使用yaml配置的方式进行注入,在springboot项目中的resources目录下新建一个文件 application.yml

person:
  name: wanli
  age: 3
  happy: true
  birthday: 2021/4/25
  maps: {k1: v1,k2: v2}
  lists:
    - code
    - music
    - game
  dog:
    name: 刘狗
    age: 3

我们刚才已经把person这个对象的所有值都写好了，我们现在来注入到我们的类中！

/*
@ConfigurationProperties作用：
将配置文件中配置的每一个属性的值，映射到这个组件中；
告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应
*/
@Component //注册bean
@ConfigurationProperties(prefix = "person")
public class Person {
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birthday;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
}

注意：使用@ConfigurationProperties后，IDEA会在上面有个提示，添加下面依赖即可解决

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-configuration-processor</artifactId>
  <optional>true</optional>
</dependency>

在SpringBoot的测试类下测试

package com.cheng;

import com.cheng.pojo.Dog;
import com.cheng.pojo.Person;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class Springboot02ConfigApplicationTests {

    @Autowired
    private Person person;

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

测试结果，OK！

yaml支持松散绑定：这个什么意思呢? 比如我的yml中写的last-name，这个和lastName是一样的， - 后面跟着的字母默认是大写的。这就是松散绑定。