如何在Spring Boot中加载多个YAML配置文件？

Question

**问题描述：** 在Spring Boot项目中，通常使用`application.yml`作为默认的配置文件。然而，在实际开发中，我们经常需要根据不同的模块或环境加载多个YAML配置文件以实现配置隔离和管理。例如，数据库配置、第三方服务配置等可能分别存放在不同的YAML文件中。那么，如何正确地在Spring Boot中加载并使用多个YAML配置文件？是否可以使用`@PropertySource`注解加载YAML文件？如果可以，需要注意哪些事项？此外，如何通过自定义配置类将这些外部YAML文件中的属性映射到Java Bean中？

Answer 1

一、Spring Boot 中多 YAML 配置文件的加载与管理

在 Spring Boot 项目中，application.yml 是默认的配置文件。然而，随着项目的复杂度提升，单一的配置文件会变得臃肿且难以维护。因此，开发者通常希望将不同模块或环境的配置拆分到多个 YAML 文件中，以实现更好的配置隔离和管理。

例如：

• database-config.yml：用于存放数据库相关配置。
• third-party-service.yml：用于配置第三方服务接口参数。
• dev-config.yml、prod-config.yml：用于区分开发与生产环境配置。

这种做法不仅提升了可读性，也增强了配置的灵活性和安全性。

二、是否可以使用 @PropertySource 加载 YAML 文件？

在 Spring 框架中，@PropertySource 注解主要用于加载 .properties 格式的配置文件。但在 Spring Boot 中，默认支持 YAML 配置文件，但 不能直接通过 @PropertySource 加载 YAML 文件。

原因在于，@PropertySource 默认使用的 PropertiesLoaderSupport 不支持 YAML 格式解析。

解决方法

如果需要加载 YAML 文件并将其注入到 Spring 容器中，可以通过以下方式实现：

1. 自定义一个 PropertySourceFactory 实现类，支持 YAML 的解析。
2. 结合 @PropertySource 使用该工厂类。

示例代码如下：

public class YamlPropertySourceFactory implements PropertySourceFactory {
    @Override
    public PropertySource<?> createPropertySource(String name, EncodedResource encodedResource) throws IOException {
        YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean();
        factory.setResources(encodedResource.getResource());
        Properties properties = factory.getObject();
        return new PropertiesPropertySource(encodedResource.getResource().getFilename(), properties);
    }
}

然后在配置类上使用：

@Configuration
@PropertySource(value = "classpath:custom-config.yml", factory = YamlPropertySourceFactory.class)
public class CustomConfig {}

三、如何将外部 YAML 属性映射为 Java Bean？

为了更方便地管理和使用 YAML 配置内容，通常会将 YAML 文件中的属性映射成 Java Bean 对象，便于在业务逻辑中使用。

1. 使用 @ConfigurationProperties 注解

这是最常见也是推荐的方式。通过 @ConfigurationProperties 注解可以将配置文件中的属性绑定到一个 Java 类中。

示例：

YAML 文件：third-party-service.yml

third-party:
  service:
    api-key: abc123
    timeout: 5000
    endpoint: https://api.example.com/v1

对应的 Java Bean：

@Data
@Component
@ConfigurationProperties(prefix = "third-party.service")
public class ThirdPartyServiceProperties {
    private String apiKey;
    private int timeout;
    private String endpoint;
}

2. 注意事项

• 确保开启了配置属性的支持（Spring Boot 2.4+ 默认开启）。
• 建议使用 Lombok 的 @Data 简化 getter/setter 编写。
• 若 YAML 文件未放在默认路径（如 src/main/resources），需手动注册为资源。

四、加载多个 YAML 文件的完整流程图

```mermaid graph TD A[Spring Boot 启动] --> B{是否存在多个YAML配置文件?} B -->|是| C[创建自定义PropertySourceFactory] C --> D[通过@PropertySource加载YAML] D --> E[使用@ConfigurationProperties映射Java Bean] E --> F[应用中注入并使用配置对象] B -->|否| G[使用默认application.yml] G --> H[通过@ConfigurationProperties映射配置] H --> I[正常使用配置数据] ```

五、总结性的技术选型建议

场景	推荐方案	说明
加载单个YAML	application.yml + @ConfigurationProperties	标准做法，简单高效
加载多个YAML	自定义PropertySourceFactory + @PropertySource	适用于非标准路径下的YAML文件
环境隔离配置	profiles + 多配置文件	如 application-dev.yml / application-prod.yml
集中管理配置	Spring Cloud Config / Nacos / Apollo	适用于微服务架构下的统一配置中心

以上方案可以根据实际项目规模和技术栈灵活选择。