SpringBoot--yaml语法讲解 & 注入配置文件

Posted 2021-07-09 Z && Y

1. SpringBoot--yaml语法讲解

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

1. application.properties
   语法结构 ：key=value
2. application.yml
   语法结构 ：key：空格 value

---

1.1 配置文件的作用

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

比如我们可以在配置文件中修改Tomcat 默认启动的端口号。
application.properties

server.port=8081

---

1.2 yaml概述

以前的配置文件，大多数都是使用xml来配置；比如一个简单的端口配置，我们来对比下yaml和xml

• 传统xml配置：

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

• yaml配置：

server：
  port: 8080

---

1.2 yaml基础语法

说明：语法要求严格！

• 1、空格不能省略
• 2、以缩进来控制层级关系，只要是左边对齐的一列数据都是同一个层级的。
• 3、属性和值的大小写都是十分敏感的。

---

2. 注入配置文件

---

2.1 原来的装配方式

2.1.1 Dog类

Dog.java

package com.tian.springboot02config.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.stereotype.Component;

@Component  //注册bean到容器中
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Dog {
    private String name;
    private Integer age;
}

---

2.1.2 Spring如何给bean注入属性值

@Value，给狗狗类测试一下：

package com.tian.springboot02config.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component  //注册bean到容器中
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Dog {
    @Value("二狗")
    private String name;
    @Value("21")
    private Integer age;
}

---

2.1.3 在SpringBoot的测试类下注入狗狗输出一下；

package com.tian.springboot02config;

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

@SpringBootTest
class Springboot02ConfigApplicationTests {
    //将狗狗自动注入进来
    @Autowired
    Dog dog;

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

}

运行结果：

---

2.2 使用yaml进行装配

---

2.2.1 Person 类

Person.java

package com.tian.springboot02config.pojo;


import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.stereotype.Component;

import java.util.Date;
import java.util.List;
import java.util.Map;


@Component //注册bean到容器中
@Data
@AllArgsConstructor
@NoArgsConstructor
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;
}

---

2.2.2 yaml数据准备

大家写的时候注意区别和优势，我们编写一个yaml配置

application.yaml

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

---

2.2.3 yaml配置的方式进行注入

@ConfigurationProperties作用： 将配置文件中配置的每一个属性的值，映射到这个组件中； 告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定 参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应

package com.tian.springboot02config.pojo;


import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import java.util.Date;
import java.util.List;
import java.util.Map;


@Component //注册bean到容器中
@Data
@AllArgsConstructor
@NoArgsConstructor

/**
 @ConfigurationProperties作用： 将配置文件中配置的每一个属性的值，映射到这个组件中；
 告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
 参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应
 **/
@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;
}

---

2.2.4 IDEA 提示

springboot配置注解处理器没有找到，让我们看文档，我们可以查看文档，找到一个依赖！

pom.xml

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

---

2.2.5 确认以上配置都OK之后，我们去测试类中测试一下

package com.tian.springboot02config;

import com.tian.springboot02config.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
    Person person; //将person自动注入进来

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

}

运行结果

---

2.2.6 小结

yaml配置注入到实体类完全OK

• 1、将配置文件的key 值 和 属性的值设置为不一样，则结果输出为null，注入失败
• 2、在配置一个person2，然后将 @ConfigurationProperties(prefix = “person2”) 指向我们的person2；

---

3. 补充： yaml搭配EL表达式使用

下面示例的测试代码均为：

package com.tian.springboot02config;

import com.tian.springboot02config.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
    Person person;

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

}

3.1 给name属性生成一个随机的id

application.yaml

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

---

3.2 随机生成一个年龄

person:
  name: 天骄
  age: ${random.int}
  happy: false
  birth: 2000/01/01
  maps: {k1: v1,k2: v2}
  lists:
    - code
    - girl
    - music
  dog:
    name: 旺财
    age: 1

---

3.3 类似于三目运算符

person:
  name: 天骄
  age: 3
  happy: false
  birth: 2000/01/01
  maps: {k1: v1,k2: v2}
  lists:
    - code
    - girl
    - music
  dog:
#    如果person.hello就用person.hello的值 否则填充默认值:你好
    name: ${person.hello:你好}旺财
    age: 1

person:
  name: 天骄
  age: 3
  happy: false
  birth: 2000/01/01
  hello: Hello
  maps: {k1: v1,k2: v2}
  lists:
    - code
    - girl
    - music
  dog:
    #    如果person.hello就用person.hello的值 否则填充默认值:你好
    name: ${person.hello:你好}旺财
    age: 1

---

---