SpirngBoot配置文件YAML

我就是我 2022-05-14 04:25 266阅读 0赞

## 一、引言 ##

在使用**Spring Initializr**创建SpringBoot项目时，文件的目录结构如下图。  
![这里写图片描述][70]  
其中SpringBoot会生成一个全局的配置文件application.properties（配置文件名是固定的），该配置文件也还可以用application.yml替代。

对于application.properties格式的配置文件，我们在用spring时就使用这种，就不多做介绍，下面主要介绍application.yml文件格式。

## 二、YAML语法： ##

\#\#\#\#1、基本语法

k:(空格)v     //来表示一对键值对（空格必须有）

YAML语法以**空格**的缩进来控制层级关系，只要是左对齐的一列数据，都是属于同一个层级的。  
例子：

server:
        port: 8081
        path: /hello
    //表示访问路径为/hello，端口为8081

注意：属性和值也是大小写敏感

#### 2、各种值的写法 ####

###### （1）、 字面量：普通的值（包括：数字、字符串、布尔） ######

k: v   //字面量直接写，注意空格

其中，字符串默认不用加上单引号或者双引号

""：双引号不会转义字符串里面的特殊字符
    	name: "zhangsan \n lisi"
    	
    输出内容：	 
    	zhangsan
    	lisi
    	
    ''：单引号会转义特殊字符，特殊字符最终只是一个普通的字符串数据
    	name:   ‘zhangsan \n lisi’
    	
    输出内容：
    	zhangsan \n  lisi

###### （2）、对象、Map（键值对）： ######

k: v       //在下一行，写对象的属性和值的关系，注意缩进

例子：

friends:
    		lastName: zhangsan
    		age: 20

行内写法：

friends: {lastName: zhangsan,age: 18}

###### （3）、 数组（List、Set）： ######

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

pets:
     - cat
     - dog
     - pig

行内写法

pets: [cat,dog,pig]

## 三、使用@ConfigurationProperties注解，从配置文件中获取值注入Bean中 ##

（1）、在配置文件application.yml中，加上person的配置（注意冒号后面加空格）

person:
        lastName: Tom
        age: 11
        boss: false
        birth: 2018/9/2
        maps: {k1: v1,k2: 12}
        lists:
          - Jack
          - Rose
        dog:
          name: 阿花
          age: 3

（2）、新建一个Person实体类：

/**
     * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
     *      prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
     *
     * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能，所以加上@Component注解；
     */
    @Component
    @ConfigurationProperties(prefix = "person")
    public class Person {
    
        private String lastName;
        private Integer age;
        private Boolean boss;
        private Date birth;
    
        private Map<String,Object> maps;
        private List<Object> lists;
        private Dog dog;
    
    }

可以导入配置文件处理器，以后在编写配置时就有提示了

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

（3）、测试，输出配置文件中的person信息  
![这里写图片描述][70 1]

[70]: /images/20220514/aec430c57aee4980b6d135c3b8a2a42b.png
[70 1]: /images/20220514/2971c63d197d4e419a834609bc5283b3.png