springboot利用YamlPropertiesFactoryBean读取自定义yaml配置文件

最新推荐文章于 2025-10-31 11:10:04 发布

原创最新推荐文章于 2025-10-31 11:10:04 发布 · 3.3k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #yaml

笔记同时被 2 个专栏收录

15 篇文章

订阅专栏

springboot

10 篇文章

订阅专栏

本文详细介绍如何在SpringBoot项目中使用YAML格式的自定义配置文件，包括配置依赖、定义配置类、加载及装配YAML文件的具体步骤。

部署运行你感兴趣的模型镜像

首先确保依赖已被添加：

// https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-configuration-processor
implementation 'org.springframework.boot:spring-boot-configuration-processor:2.2.6.RELEASE'

定义自定义配置文件：

myyaml:
  str: 字符串可以不加引号
  specialStr: "双引号输出\n特殊字符"
  specialStr2: '单引号可转义\n特殊字符'
  flag: false
  num: 123
  Dnum: 3.14159
  list:
    - one
    - two
    - two
  set: [1,2,2,3]
  map: {k1: v1, k2: v2}
  positions:
    - name: zhangsan
      salary: 15000.00
    - name: lisi
      salary: 18888.88

编写对应该配置文件的配置类：

@Configuration
@ConfigurationProperties(prefix = "myyaml")
@Data
public class ConfigYML {

    private String str;
    private String specialStr;
    private String specialStr2;
    private Boolean flag;
    private Integer num;
    private Double dNum;

    private List<Object> list;
    private Set<Object> set;

    private Map<String, Object> map;
    private List<Person> positions;
}

加载并装配YML格式自定义配置文件(本测试文件存储在config目录下的myconfig目录下)，该方法可放在启动类中：

    @Bean
    public static PropertySourcesPlaceholderConfigurer properties() throws FileNotFoundException{

        try {
            PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer();
            YamlPropertiesFactoryBean yaml = new YamlPropertiesFactoryBean();
            //自定义yaml文件的存储路径
            yaml.setResources(new ClassPathResource("/myconfig/ymltest.yml"));
            configurer.setProperties(Objects.requireNonNull(yaml.getObject()));
            return configurer;
        } catch (IllegalStateException e) {
            // for ignoreResourceNotFound
            Throwable cause = e.getCause();
            if (cause instanceof FileNotFoundException){
                throw (FileNotFoundException) e.getCause();
            }
            throw e;
        }
    }