SpringBoot 配置篇 - 加载指定YML文件

最近工作中需要用到Security，在踩坑的过程中因为重写了AccessDecisionManager，所以想效仿原版实现security_whitelist.properties将白名单列表从主yml文件中分离出来。

在之前学习的@PropertySource 读取指定配置文件的文章中我们了解到使用PropertySource可以指定配置文件类去加载指定的properties文件，关于properties的配置可以参考一下这篇文章，本文将讲述yml的踩坑过程。

首先我创建了classpath:security-whitelist.yml

@PropertySource(value = {"classpath:security-whitelist.yml"})
@ConfigurationProperties(prefix = "security")

在debug过程中发现发现，配置中的value值为null，仔细排查后发现的确是PropertySource对yml没有生效。

在源码中可以看到PropertySource的factory默认的实现为DefaultPropertySourceFactory

阅读后发现默认只实现了properties的解析，所以我们需要写一个对yml的一个PropertySourceFactory实现

import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;
import org.springframework.core.env.PropertiesPropertySource;
import org.springframework.core.env.PropertySource;
import org.springframework.core.io.support.EncodedResource;
import org.springframework.core.io.support.PropertySourceFactory;

import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.Properties;

public class YamlPropertySourceFactory implements PropertySourceFactory {

    @Override
    public PropertySource<?> createPropertySource(String s, EncodedResource encodedResource) throws IOException {
        Properties propertiesFromYaml = loadYamlIntoProperties(encodedResource);
        String sourceName = s != null ? s : encodedResource.getResource().getFilename();
        return new PropertiesPropertySource(sourceName, propertiesFromYaml);
    }

    private Properties loadYamlIntoProperties(EncodedResource resource) throws FileNotFoundException {
        try {
            YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean();
            factory.setResources(resource.getResource());
            factory.afterPropertiesSet();
            return factory.getObject();
        } catch (IllegalStateException e) {
            // for ignoreResourceNotFound
            Throwable cause = e.getCause();
            if (cause instanceof FileNotFoundException) {
                throw (FileNotFoundException) e.getCause();
            }
            throw e;
        }
    }
}

在配置文件类中需要指定一下Factory

@PropertySource(value = {"classpath:security-whitelist.yml"}, factory = YamlPropertySourceFactory.class)
@ConfigurationProperties(prefix = "security")

测试一下，搞定！

本文参考：
https://www.cnblogs.com/huahua035/p/11272464.html
https://deinum.biz/2018-07-04-PropertySource-with-yaml-files/