Spring Boot 中加载多个 YAML 配置文件

在 Spring Boot 中加载多个 YAML 配置文件是一个常见的需求，通常用于将配置信息分离到多个文件中以便于管理和维护。Spring Boot 提供了灵活的方式来加载多个 YAML 配置文件。

以下是一些方法和步骤，用于在 Spring Boot 应用中加载多个 YAML 配置文件：

方法一：使用 spring.config.import 属性

Spring Boot 2.4 及以上版本引入了 spring.config.import 属性，使得加载多个配置文件变得更加方便。你可以在 application.yml 或 application.properties 文件中使用 spring.config.import 来引入其他 YAML 文件。

例如，假设你有以下两个 YAML 文件：

• application.yml
• config-part1.yml
• config-part2.yml

你可以在 application.yml 中这样配置：

spring:
  config:
    import:
      - classpath:config-part1.yml
      - classpath:config-part2.yml

方法二：使用 spring.profiles.active 和 spring.profiles.include

通过配置不同的 profiles，你可以在不同的环境下加载不同的配置文件。假设你有以下文件：

• application.yml
• application-dev.yml
• application-prod.yml

你可以在 application.yml 中定义一些通用配置，然后在 application-dev.yml 和 application-prod.yml 中定义特定环境的配置。

例如，application.yml：

server:
  port: 8080

application-dev.yml：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/devdb
    username: devuser
    password: devpassword

application-prod.yml：

spring:
  datasource:
    url: jdbc:mysql://prod-db-server:3306/proddb
    username: produser
    password: prodpassword

然后，你可以通过命令行参数或环境变量来指定活动的 profile，例如：

java -jar yourapp.jar --spring.profiles.active=dev

或者，使用 spring.profiles.include 在一个 profile 文件中包含其他 profile 文件：

# application-full.yml
spring:
  profiles:
    include: dev,custom

方法三：在 application.properties 中指定配置文件位置

你还可以在 application.properties 文件中通过 spring.config.location 属性指定 YAML 文件的位置。

例如：

spring.config.location=classpath:/default.yml,classpath:/override.yml

方法四：使用 @ConfigurationProperties 和 @PropertySource

虽然这不是直接加载多个 YAML 文件的方法，但你可以将 YAML 文件转换为 properties 文件，并使用 @PropertySource 注解来加载它们。然后，你可以使用 @ConfigurationProperties 将这些属性绑定到一个配置类。

例如，创建一个 custom.properties 文件：

custom.property1=value1
custom.property2=value2

然后，在你的配置类中使用 @PropertySource 和 @ConfigurationProperties：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

@Configuration
@PropertySource("classpath:custom.properties")
@ConfigurationProperties(prefix = "custom")
public class CustomProperties {
    private String property1;
    private String property2;

    // getters and setters
}

总结

Spring Boot 提供了多种方法来加载多个 YAML 配置文件，选择哪种方法取决于你的具体需求和应用场景。无论是使用 spring.config.import、profiles、spring.config.location 还是 @PropertySource，都可以帮助你有效地管理和加载配置信息。