spring boot配置文件之yaml

1、spring boot使用一个全局的配置文件，配置文件名是固定的

application.properties  或  application.yml/yaml

配置文件放在src/main/resources目录或者类路径/config下

2、.yml是YAML（YAML Ain't MarkUp Language标记语言）语言的文件，以数据为中心，比json、xml等更适合做配置文件

以前的配置文件大多使用的是xxx.xml文件

<server>

       <port>8081</port>

</server>

3、全局配置文件可以对一些spring boot自动配置的默认配置值进行修改

4、YAML配置例子

server:
  port: 8090

在resources下新建application.yml

编写格式如下：

删除application.properties内容后，重新运行

5、YAML基本语法

（1）使用缩进表示层级关系

（2）缩进时不允许使用Tab键，只允许使用空格

（3）缩进的空格数目不重要，只要相同层级的元素左侧对齐即可

（4）大小写敏感

格式：

k: v          表示一对键值对，“: ”后面一定要跟一个空格

6、YAML支持的三种数据结构

（1）字面量：普通的值（数字，字符串，布尔）

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

字符串加双引号，不会转义字符串里面的特殊字符，特殊字符会作为本身想表示的意思

字符串加单引号，会转义字符，字符串原样输出，特殊字符最终只是一个普通的字符串数据

name: "zhangsan \n lisi"                  输出：zhangsan 换行 lisi

name: 'zhangsan \n lisi'                   输出：zhangsan \n lisi

 

（2）对象、Map（属性和值）（键值对）：键值对的集合

friends: 

    lastName: zhangsan

    age: age

行内写法：

friends: {lastName: zhangsan,age: 18}

 

（3）数组（List、Set）：一组按次序排列的值

用- 值（-空格值）表示数组中的一个元素

pets: 

    - cat

    - dog

    - pig

行内写法：

pets: [cat,dog,pig]

（4）复杂类型

7、配置文件值注入

（1）yml文件：

server:
  port: 8090

person:
    lastName: zhangsan
    age: 18
    boss: false
    birth: 2017/12/12
    maps: {k1: v1,k2: 12}
    lists: [lisi,zhaoliu]
    dog:
      name: 小狗
      age: 2

 

如果编写的格式正确，点击属性或值会有对应的底部导航栏显示

（2）JavaBean

新建bean包编写Person类和Dog类

Person类：

package com.cnstrong.springboot.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;

/**
 * 将配置文件中配置的每一个属性的值映射到这个组件中
 * @ConfigurationProperties : 告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
 *                  prefix = ""，配置文件中哪个下面的所有属性进行一一映射
 */
//只有这个组件是容器中的组件，才能使用容器提供的@ConfigurationProperties功能
@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;

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

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    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 getBirth() {
        return birth;
    }

    public void setBirth(Date birth) {
        this.birth = birth;
    }

    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.cnstrong.springboot.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;
    }

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

（3）可以导入配置和文件处理器，以后编写配置文件就有提示了
 

pom.xml中加入此配置，获得@ConfigurationProperties内提示

重新运行main方法

虽然re-run提示未消失，但是有提示了

last-name            ==>lastName

（4）找到

编写

package com.cnstrong.springboot;

import com.cnstrong.springboot.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;

/**
 * Springboot单元测试
 * 可以在测试期间很方便的类似编码一样进行自动注入等容器的功能
 */
@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBoot01HelloworldQuickApplicationTests {

    @Autowired
    Person person;

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

}
运行此方法

Person{lastName='zhangsan', age=18, boss=false, birth=Tue Dec 12 00:00:00 CST 2017, maps={k1=v1, k2=12}, lists=[lisi, zhaoliu], dog=Dog{name='小狗', age=2}}