学习笔记springboot ——yaml配置文件配置的获取

最新推荐文章于 2025-10-19 21:31:45 发布

原创最新推荐文章于 2025-10-19 21:31:45 发布 · 290 阅读

0 ·

CC 4.0 BY-SA版权

本文介绍YAML配置文件的基本格式与SpringBoot中如何使用@ConfigurationProperties进行属性绑定，包括基本类型、集合类型的绑定及自定义类的映射。

学习yaml配置文件的获取：

一、yaml文件的格式

key:空格value （value 的取值范围数字、字符串、boolean）

同一属性下等同缩进具有相同的等级

key: "value\n李氏" 双引号输出：value换行李氏

key: 'value' 单引号输出：value 李氏

person: #lastName,age,boss,birth在同一等级
  lastName: 张三
  age: 18
  boss: false
  birth: 2020/2/24
  maps: {name: kele,age: 23} #同一行书写需要大括号
  lists:
    - 李四
    - 赵六
  dog:
    name: 小狗
    age: 2

二、获取配置

将配置文件中的配置的每一个属性的值，映射到person组件中
1.@ConfigurationProperties：告诉springboot将本类中的所有属性与配置文件中的相关配置进行绑定
2. prfix = " " 将会与配置文件中的属性进行---映射
3. 组件必须在容器中，才能使用容器提供的@ConfigurationProperties功能,@Component

4.@Autowired 自动调用set/get方法

Dog.java

package com.zzsd.test2_demo.bean;

public class Dog {

    private String name;
    private Integer age;

    public 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;
    }

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

Person.java

package com.zzsd.test2_demo.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将本类中的所有属性与配置文件中的相关配置进行绑定
 * prfix = " " 将会与配置文件中的属性进行---映射
 *
 * 组件必须在容器中，才能使用容器提供的@ConfigurationProperties功能
 */
@Component
@ConfigurationProperties(prefix = "person")
public class Person {

    private  String lastName;
    private  Integer age;
    private  Boolean boos;
    private  Date birth;

    private Map<String,Object> maps;

    private List<Object> lists;

    private  Dog dog;

    public Person(){

    }

    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 getBoos() {
        return boos;
    }

    public void setBoos(Boolean boos) {
        this.boos = boos;
    }

    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;
    }

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

Test单元

import com.zzsd.test2_demo.bean.Person;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class Test2DemoApplicationTests {
	@Autowired//自动调用get/set
	Person person;

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


}

结果：