SpringBoot学习(三)：springboot的yaml语法及读取yaml文件的内容

本文链接：https://blog.csdn.net/weixin_33446857/article/details/84932631

一：properties和yml语法

如果使用IDEA创建Springboot项目,默认会在resource目录下创建application.properties文件,在SpringBoot项目中,也可以使用yml类型的配置文件代替properties文件，其实说白了这两个都是SpringBoot留下的配置文件，都可以进行配置。

首先我们最关注的应该是格式问题，两个文件在进行配置的时候的格式是不一样的，properties文件在进行配置的时候一定是一个key对应一个value，对于这一条的解释就是一个可以对某配置完整解释的一定是在同一级别，如图所示：

然后我们再来看一下在yml文件中我们应该怎样进行配置达到相同的效果：

我们可以观察到的格式就是yml文件是梯级呈现的，其中，servlet和port属于同一阶经，所以是并列关系。

properties和yaml我们应该注意一下几个方面：

　　　　1>在properties文件里面的 “ .” 连接在yml文件里面全部换成 "：" 进行连接，并且每一级之间必须换行，在第二级开始应该进行一个Tab键的缩进，当然如果是同级的就不需要进行缩进

　　　　2>在yml文件里面如果是需要进行赋值那么必须是要在 "：" 后面进行一个空格键的缩进

　　　　3>在yml文件里面所有的配置，相同级别只能出现一次，比如我们使用了server这个级别，那么我们在后边进行server级别的配置的时候就必须在这个地方进行，不能在写一个server级别

二：读取yml文件内容

（1）：在yml文件中写上配置内容如：

wq:
  person:
    lastName: 吴
    age: 18
    boss: true
    birth: 2018/12/09
    maps: {key1:value1,key2:value2}
    list: [dog,cat,house]
    dog:
      name: 旺财
      age: 3

（2）：新建一个Model包，里面创建两个实体类，一个Dog,一个Person：

Dog:

package cn.wq.testproject.Model;

public class Dog {
    private String name;
    private int 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 int getAge() {
        return age;
    }

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

Person:

package cn.wq.testproject.Model;

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

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

@Component
//prefix前缀需要和yml配置文件里的匹配。
@ConfigurationProperties(prefix = "wq.person")
public class Person {
    private String lastName;
    private int age;
    private boolean boss;
    private Date birth;
    private Map<String,String> maps;
    private List<String> list;
    private Dog dog;

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

    //get set方法

    public Dog getDog() {
        return dog;
    }

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

    public String getLastName() {
        return lastName;
    }

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

    public int getAge() {
        return age;
    }

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

    public boolean isBoss() {
        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, String> getMaps() {
        return maps;
    }

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

    public List<String> getList() {
        return list;
    }

    public void setList(List<String> list) {
        this.list = list;
    }
}

(3)：在test包下有一个测试类

package cn.wq.testproject;

import cn.wq.testproject.Model.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 TestprojectApplicationTests {
@Autowired
	Person person;

	@Test
	public void contextLoads() {
		System.out.println("person===="+person);
		System.out.println("age======="+person.getAge());
		System.out.println("dog.name======="+person.getDog().getName()+" dog.age===="+person.getDog().getAge());
	}

}

（4）：输出日志：

三:Spring Boot 文件处理器 spring-boot-configuration-processor

在pom.xml 中加入 spring-boot-configuration-processor 的配置

<!-- 导入文件处理器，加上这个，以后编写配置就有提示了-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

加入这个，以后在写自定义配置时候就会有提示，如下图，当你准备输入dog时，刚输入了do，他就会有提示，很实用。

四：配置文件取值

当我们需要从配置文件里取值时，可以使用类似EL表达式的方法，新添加一个hello属性，value值是luky,这时dog属性的name值，我们可以这样取值

为了输出日志方法，我们在Person类中，添加hello属性，并给他get,set方法，重写toString方法。

这时我们再运行测试类，从输出日志以看到，dog的名字已经变成luck，而不是之前的自定义的旺财。

五：properties的语法及配置文件内容

现在再用properties的方法，配置下前面yaml文件的内容，properties和yaml是互相补充的，这时我们把风yaml里面的配置注释点，使用properties的配置，值的注意的是，在使用properties文件时，lastName这个属性原先我们是驼峰命令规范的，现在它把我们拆开了，好了，运行测试类。

server.servlet.context-path=/test
server.port=8088
#关闭模板缓存，避免页面更新无效。
spring.thymeleaf.cache=false

wq.person.hello=luky
wq.person.last-name=吴
wq.person.age=19
wq.person.birth=2018/12/11
wq.person.list=dog01,cat01,animal
wq.person.maps.key1=value1
wq.person.maps..key2=value2
wq.person.dog.name=${wq.person.hello}
wq.person.dog.age=5