Spring Boot（2）配置篇 - YAML

YAML(YAML Ain’t  Markup Language)已数据为中心，比JSON、XML更适合做配置文件。

 

基本语法

key:[空格]value ；表示一对键值，中间必须有空格

以空格缩进来控制层级关系，只要是左对齐的一列数据就是同一个层级的

server:
   port: 8080
   servlet-path: /

属性和值也是大小写敏感。

 

值的写法

字面量: 普通的值（数字、字符串、布尔值）

        字符串默认可以不加上单引号或双引号

         "" 双引号：不会转译字符串内的特殊字符，即特殊字符会做为本身想要表示的意思；

                   name: "xiaoming \n xiaohong"    输出   xiaoming  [换行] xiaohong

         ''  单引号：会转译字符串内的特殊字符，即特殊字符最终是一个普通的字符串；

                   name: "xiaoming \n xiaohong"    输出   xiaoming  \n xiaohong

对象、Map

         key: 在下一行来写对象的属性和值，注意缩进

friends: 
    name: xiaoming
    age: 6

         还可以写成行内写法

friends：{name: xiaoming,age: 6} 

数组、集合

         用- 值来代表数组中的元素

pets: 
    -dog
    -pig
    -cat

行内写法

pets: {dog,pig,cat}

 

读取配置文件值

下面我们来编写一个单元测试，用编码对上述语法做一个实现

首先我们在yml中添加

person:
    name: 小明
    age: 6
    boss: false
    dirth: 2025/01/01
    maps: {k1: v1,k2: v2}
    lists:
        - l1
        - l2
        - l3
    dog:
        name: 小白
        age: 2

然后我们来创建一个和yml文件中属性相对应的配置文件类

package com.lbee.bean;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

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

/**
 * @ClassName Person
 * @Description TODO
 * @Autchor lbee
 * @Date 2019/3/4 18:06
 * @Version 1.0
 */
@Component
@ConfigurationProperties(prefix = "person")
public class Person {

    private String name;
    private Integer age;
    private Boolean boss;
    private Date dirth;

    private Map<String, Object> maps;
    private List<Object> lists;
    private Dog dog;

    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", boss=" + boss +
                ", dirth=" + dirth +
                ", maps=" + maps +
                ", lists=" + lists +
                ", dog=" + dog +
                '}';
    }

    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 Boolean getBoss() {
        return boss;
    }

    public void setBoss(Boolean boss) {
        this.boss = boss;
    }

    public Date getDirth() {
        return dirth;
    }

    public void setDirth(Date dirth) {
        this.dirth = dirth;
    }

    public Map<String, Object> getMaps() {
        return maps;
    }

    public void setMaps(Map<String, Object> maps) {
        this.maps = maps;
    }

    public List<Object> getLists() {
        return lists;
    }

    public void setLists(List<Object> lists) {
        this.lists = lists;
    }

    public Dog getDog() {
        return dog;
    }

    public void setDog(Dog dog) {
        this.dog = dog;
    }
}

再创建一个Dog对象

package com.lbee.bean;

/**
 * @ClassName Dog
 * @Description TODO
 * @Autchor lbee
 * @Date 2019/3/4 18:09
 * @Version 1.0
 */
public class Dog {

    private String name;
    private Integer age;

    @Override
    public String toString() {
        return "Dog{" +
                "name='" + name + '\'' +
                ", age=" + 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;
    }
}

@ConfigurationProperties：将标注类的所有属性与配置文件中的相关属性绑定

    prefix = "person" 表示配置文件中的person.*属性与标注类的属性一一映射

这里Spring提供了一个用于配置文件处理器的依赖包

在pom添加依赖

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

根据提示，我们需要重新启动一下SpringBoot才可以使用configuration-processor提供的提示功能

重启后，再测试一下类与yml中做属性绑定就会有提示了，OK！

最后我们在单元测试中测试一下，Person有没有获取到yml配置文件中的值

package com.lbee;

import com.lbee.bean.Person;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest
public class HelloworldApplicationTests {

    @Autowired
    Person person;

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

}

结果输出：