Spring Boot之yaml配置注入基本使用

文章目录

• 1. 配置文件
• 2. yaml概述
• • 1. yaml基础语法
  • 2. 对象、Map（键值对）
  • 3. 数组（ List、set ）
  • 4. 注入配置文件
  • 5. yaml注入配置文件
• 3. 加载指定的配置文件
• 4. 配置文件占位符
• 5. 回顾properties配置
• 6. @Value获取值和@ConfigurationProperties获取值比较
• 7. 结论：

1. 配置文件

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

1. application.properties 语法结构 ：key=value

2. 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

1. 传统xml配置：

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

2. yaml配置：

server：
  prot: 8080

1. yaml基础语法

• 说明：语法要求严格！

1、空格不能省略

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

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

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

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

k: v

• 注意：

1. “ ” 双引号，不会转义字符串里面的特殊字符 ， 特殊字符会作为本身想表示的意思；
   比如 ：name: “xdr \n 630” 输出 ：xdr 换行 630

2. '' 单引号，会转义特殊字符 ， 特殊字符最终会变成和普通字符一样输出
   比如 ：name: ‘xdr \n630’ 输出 ：xdr \n 630

2. 对象、Map（键值对）

#对象、Map格式
k: 
    v1:
    v2:

• 在下一行来写对象的属性和值得关系，注意缩进；比如：

student:
    name: xdr630
    age: 20

• 行内写法

student: {name: xdr630,age: 20}

3. 数组（ List、set ）

• 用 - 值表示数组中的一个元素,比如：

pets:
 - cat
 - dog
 - pig

• 行内写法

pets: [cat,dog,pig]

• 修改SpringBoot的默认端口号
  配置文件中添加，端口号的参数，就可以切换端口；

server:
  port: 8082

4. 注入配置文件

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

5. yaml注入配置文件

1、在springboot项目中的resources目录下新建一个文件 application.yml
2、编写一个实体类 Dog；

package com.xdr630.pojo;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component	//注册bean到容器中
public class Dog {

    private String name;

    private Integer age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
    public Dog(){

    }

    public Dog(String name, Integer age) {
        this.name = name;
        this.age = age;
    }

    @Override
    public String toString() {
        return "Dog{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

3、思考，我们原来是如何给bean注入属性值的！@Value，给狗狗类测试一下：

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

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

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

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

}

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

5、我们在编写一个复杂一点的实体类：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()方法  
}

6、我们来使用yaml配置的方式进行注入，大家写的时候注意区别和优势，我们编写一个yaml配置！

person:
  name: 兮动人
  age: 22
  happy: true
  birth: 2021/1/28
  maps: {k1: v1,k2: v2}
  lists:
    - code
    - music
    - sports
  dog:
    name: 旺财
    age: 1

7、我们刚才已经把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 birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
}
//后面 有参无参构造、get、set方法、toString()方法  

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

• 进行Spring Boot配置文件部署时，发出警告Spring Boot Configuration Annotation Processor not configured，但是不影响运行。

问题解决方案：

• 在pom.xml文件中引入依赖

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

• 如果引入的依赖报红，那就下载没有引入的资源，maven下载完成后点击下刷新即可。Spring Boot Configuration Annotation Processor not configured 就会消失。
• 重启idea
  

问题分析：

• 它的意思是“Spring Boot配置注解执行器没有配置”，配置注解执行器的好处是什么。
• 配置注解执行器配置完成后，当执行类中已经定义了对象和该对象的字段后，在配置文件中对该类赋值时，便会非常方便的弹出提示信息。
• 如：
  
  
  9、确认以上配置都OK之后，我们去测试类中测试一下：

SpringBootTest
class DemoApplicationTests {

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

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

}

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

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

3. 加载指定的配置文件

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

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

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

name=xdr630

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

//加载指定的配置文件
@PropertySource(value = "classpath:person.properties")
@Component //注册bean
public class Person {
	//SPEL表达式取出配置文件的值
    @Value("${name}")
    private String name;

    ......  
}

3、再次输出测试一下：指定配置文件绑定成功！

4. 配置文件占位符

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

person:
    name: xdr630${random.uuid} # 随机uuid
    age: ${random.int}  # 随机int
    happy: false
    birth: 2021/01/30
    maps: {k1: v1,k2: v2}
    lists:
      - code
      - music
      - sports
    dog:
      name: ${person.hello:other}_旺财
      age: 1

5. 回顾properties配置

• 我们上面采用的yaml方法都是最简单的方式，开发中最常用的；也是springboot所推荐的！那我们来唠唠其他的实现方式，道理都是相同的；写还是那样写；配置文件除了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

user.name=xdr
user.age=18
user.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);
    }

}

结果正常输出：

6. @Value获取值和@ConfigurationProperties获取值比较

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

	@ConfigurationProperties	@Value
功能	批量注入配置文件中的属性	一个个指定
松散绑定（松散语法）	支持	不支持
SpEL	不支持	支持
JSR303数据校验	支持	不支持
复杂类型封装	支持	不支持

1、@ConfigurationProperties只需要写一次即可 ， @Value则需要每个字段都添加

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

3、JSR303数据校验 ， 这个就是我们可以在字段是增加一层过滤器验证 ， 可以保证数据的合法性

4、复杂类型封装，yml中可以封装对象 ， 使用@value就不支持

7. 结论：

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

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

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