Spring Boot中使用自定义YAML文件初始化对象的问题

你遇到的核心问题是Spring Boot的@PropertySource注解默认不支持加载YAML格式的配置文件，它只认.properties和.xml。所以直接用@PropertySource("classpath:/metrics.yml")是没法把YAML里的属性绑定到你的ActiveMetrics类上的，得做一点小改造。

下面是完整的解决方案，一步步来：

1. 自定义YAML属性源工厂 #

首先需要写一个实现PropertySourceFactory的类，用来告诉Spring怎么解析YAML文件：

import org.springframework.core.env.PropertySource;
import org.springframework.core.io.support.EncodedResource;
import org.springframework.core.io.support.PropertySourceFactory;
import org.springframework.boot.env.YamlPropertiesFactoryBean;

import java.util.Properties;

public class YamlPropertySourceFactory implements PropertySourceFactory {

    @Override
    public PropertySource<?> createPropertySource(String name, EncodedResource resource) {
        YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean();
        factory.setResources(resource.getResource());
        Properties properties = factory.getObject();
        // 生成Properties类型的PropertySource，Spring就能识别了
        return new org.springframework.core.env.PropertiesPropertySource(
            name != null ? name : resource.getResource().getFilename(),
            properties
        );
    }
}

2. 调整配置类和属性源注解 #

接下来修改你的ActiveMetrics配置类，指定用上面的工厂类来加载YAML文件，同时确保内部的Metric类有正确的属性访问器（用Lombok的@Data最方便）：

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

import java.util.ArrayList;
import java.util.List;

@Data
@Component
@ConfigurationProperties(prefix = "metrics") // 绑定yaml里的根节点"metrics"
@PropertySource(value = "classpath:/metrics.yml", factory = YamlPropertySourceFactory.class)
public class ActiveMetrics {
    private final List<Metric> activeMetrics = new ArrayList<>();

    // 内部类用来映射yaml里的每个metric节点
    @Data
    public static class Metric {
        private String type;
        private Integer value;
    }
}

3. 调整主类的注解（可选） #

如果你的主类里用了@PropertySources，也要给加载metrics.yml的那个@PropertySource加上factory属性，不然还是会失效：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.PropertySource;
import org.springframework.context.annotation.PropertySources;

@SpringBootApplication
@PropertySources({
    @PropertySource(value = "classpath:/metrics.yml", factory = YamlPropertySourceFactory.class),
    @PropertySource("classpath:/application.yml") // 其他配置文件正常写
})
public class YourSpringBootApplication {
    public static void main(String[] args) {
        SpringApplication.run(YourSpringBootApplication.class, args);
    }
}

4. 验证配置是否生效 #

可以写一个简单的验证组件，启动时打印加载的metrics，确认是否初始化成功：

import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

@Component
public class MetricsLoaderVerifier implements CommandLineRunner {

    private final ActiveMetrics activeMetrics;

    // 构造注入配置类
    public MetricsLoaderVerifier(ActiveMetrics activeMetrics) {
        this.activeMetrics = activeMetrics;
    }

    @Override
    public void run(String... args) {
        System.out.println("=== 加载的Metrics信息 ===");
        activeMetrics.getActiveMetrics().forEach(metric -> 
            System.out.printf("类型: %s, 值: %d%n", metric.getType(), metric.getValue())
        );
    }
}

启动项目后，控制台应该会输出：

=== 加载的Metrics信息 ===
类型: TYPE_A, 值: 10
类型: TYPE_B, 值: 5

关键注意点 #

• 一定要确保Metric类有public的getter和setter，Spring需要通过这些方法来绑定属性，用Lombok的@Data能自动生成，省得手写。
• @ConfigurationProperties的prefix要和YAML里的根节点完全对应（这里是metrics），不然属性绑定会失败。
• 如果你的Spring Boot版本是2.4及以上，也可以配合@ConfigurationPropertiesScan注解来自动扫描配置类，不过核心还是要解决YAML文件的加载问题。

内容的提问来源于stack exchange，提问作者Leonid Bor