SpringBoot—03—yaml配置注入

Java架构师必看

发布于 2021-05-14 16:48:13

1.2K0

发布于 2021-05-14 16:48:13

文章被收录于专栏：Java架构师必看

SpringBoot03：yaml配置注入

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

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

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:
  port: 8088

yaml基础语法

说明:语法要求严格

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

创建:

yaml注入配置文件

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

2、编写一个实体类 Dog

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

package com.nie.pojo;/* * *@auth wenzhao *@date 2021/4/8 17:55 */

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

@Component
public class Dog {
   
    @Value("旺财")
    private String name;
    @Value("4")
    private Integer age;

   
}

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

@Value注入成功，这是我们原来的办法对吧。

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

package com.nie.pojo;/* * *@auth wenzhao *@date 2021/4/8 17:58 */

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;

import javax.validation.constraints.Email;
import java.util.List;


import java.util.Date;

import java.util.Map;

@Component
@ConfigurationProperties(prefix = "person")
@Validated//数据校验
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;

/......../
}

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

server:
  port: 8081


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

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

@ConfigurationProperties作用:

将配置文件种的每一个属性,映射到这个组件中,告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定

参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应

@ConfigurationProperties(prefix = "person")

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

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

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

加载指定的配置文件

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

@PropertySource(value = "classpath:person.properties")

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

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

`name=nie`

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

@PropertySource(value = "classpath:person.properties")
@Component //注册bean
public class Person {
   

    @Value("${name}")
    private String name;

    ......  
}

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

配置文件占位符

person:
    name: qinjiang${random.uuid} # 随机uuid
    age: ${random.int}  # 随机int
    happy: false
    birth: 2012/01/01
    person: hello11
    maps: {k1: v1,k2: v2}
    lists:
      - code
      - girl
      - music
    dog:
      name: ${person.hello:other}_旺旺  //占位符号如果person存在输出`hello11_旺旺`.如果不存在`hello`
      age: 1

springboot推荐yaml方法

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

小结

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