【2020.06.22】Springboot 加载其它 yml 配置文件使用 @PropertySource 和 @ConfigurationProperties 注解

最新推荐文章于 2022-09-19 11:36:12 发布

耳森Paulson

最新推荐文章于 2022-09-19 11:36:12 发布

阅读量359

点赞数

分类专栏： Spring 文章标签： springboot yml 旁加载其它配置文件

本文链接：https://blog.youkuaiyun.com/qq_38534107/article/details/106901622

版权

Spring 专栏收录该内容

10 篇文章

订阅专栏

本文介绍如何在SpringBoot中使用@PropertySource和@ConfigurationProperties注解加载YML配置文件，通过自定义MixPropertySourceFactory实现YAMLPropertySourceLoader加载yml配置。提供了完整的代码示例，包括配置类和测试方法。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

yml 文档如下

active:
  author: weiyuanbao
  envList:
    - acc: 10766
      a: 10.11
      erl: 10.167

    - acance: 10.8766
      accier: 10.101

使用 @PropertySource 和 @ConfigurationProperties 注解将配置加载为一个 Bean


import com.manhattan.autotest.config.MixPropertySourceFactory;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

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

/**
 * @author weiyuanbao
 * @email weiyuanbao@didiglobal.com
 * @date 2020/6/22 上午10:37
 * @description:
 */
@Data
@Configuration
@PropertySource(value = {"classpath:active.yml"}, factory = MixPropertySourceFactory.class)
@ConfigurationProperties(prefix = "active")
public class EnvUrl {
    public String author;
    public List<Map<String, String>> envList;
    // public Map<String, String> env1;
    // public Map<String, String> env2;

}

Springboot @PropertySource 不支持加载 yml 配置文件，所以需要自定义一个配置类


import org.springframework.boot.env.YamlPropertySourceLoader;
import org.springframework.core.env.PropertySource;
import org.springframework.core.io.support.DefaultPropertySourceFactory;
import org.springframework.core.io.support.EncodedResource;
import org.springframework.lang.Nullable;

import java.io.IOException;
import java.util.List;
import java.util.Optional;

public class MixPropertySourceFactory extends DefaultPropertySourceFactory {
    /**
     * Create a {@link PropertySource} that wraps the given resource.
     *
     * @param name     the name of the property source
     * @param resource the resource (potentially encoded) to wrap
     * @return the new {@link PropertySource} (never {@code null})
     * @throws IOException if resource resolution failed
     */
    @Override
    public PropertySource<?> createPropertySource(@Nullable String name, EncodedResource resource) throws IOException {
        String resourceName = Optional.ofNullable(name).orElse(resource.getResource().getFilename());
        if (resourceName.endsWith(".yml") || resourceName.endsWith(".yaml")) {
            List<PropertySource<?>> yamlSources = new YamlPropertySourceLoader().load(resourceName, resource.getResource());
            return yamlSources.get(0);
        } else {
            return new DefaultPropertySourceFactory().createPropertySource(name, resource);
        }
    }
}

测试

@Autowired
EnvUrl envUrl;

@Test
    void test() {
        System.out.println(envUrl.toString());
        System.out.println(envUrl.author);
        System.out.println(envUrl.envList.toString());
    }