springboot的配置文件如何配置可以实现多个yml相互读取

梦里梦外; 2024-02-18 09:37 17阅读 0赞

在Spring Boot中，可以通过多种方式来实现配置文件的相互读取和组合。如果你想要在一个Spring Boot应用中使用多个YAML（`.yml`）配置文件，并且希望这些配置文件可以相互读取或者互相覆盖某些配置，你可以采用以下几种方法：

#### 1. 使用`spring.config.import`属性（Spring Boot 2.4及以上版本） ####

从Spring Boot 2.4开始，引入了`spring.config.import`属性，允许你导入其他配置文件。例如，在你的`application.yml`中，你可以这样做：

spring:
      config:
        import: classpath:additional-config.yml

这将会导入同一类路径下的`additional-config.yml`文件。

#### 2. 使用`@PropertySource`或`@PropertySources`注解 ####

虽然`@PropertySource`注解不支持YAML格式的文件，但你可以使用它来加载`.properties`格式的文件。如果你的配置可以转换为`.properties`格式，这是一个可行的选择。

@Configuration
    @PropertySource("classpath:additional-config.properties")
    public class AppConfig {
        
        // ...
    }

对于多个配置文件，可以使用`@PropertySources`注解。

#### 3. 使用`spring.profiles.include` ####

在你的主配置文件中，你可以指定要包含的其他配置文件的profiles。例如，在`application.yml`中：

spring:
      profiles:
        include: 
          - additional

然后，你可以有一个名为`application-additional.yml`的文件，它将被自动加载。

#### 4. 使用不同的配置文件名 ####

Spring Boot默认会读取`application.yml`或`application.properties`文件。你可以通过在启动时指定不同的配置文件名来加载不同的配置文件。例如：

java -jar yourapp.jar --spring.config.name=another-application

这将会加载`another-application.yml`而不是`application.yml`。

#### 5. 使用profiles ####

你可以在一个YAML文件中定义多个profiles，每个profile有不同的配置。然后，你可以在运行时通过设置`spring.profiles.active`来指定哪个profile是活跃的。

spring:
      profiles: dev
    ---
    spring:
      profiles: prod

然后通过命令行参数来激活特定的profile：

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

#### 结合使用 ####

这些方法可以根据需要组合使用，以实现更复杂的配置管理策略。例如，你可以在主配置文件中使用`spring.config.import`来导入其他配置文件，同时使用profiles来定义特定环境下的配置变量。

例如，如果你有一个名为 `application-local.yml` 的文件，它包含了专门为本地开发环境定制的配置，你可以通过设置 `spring.profiles.active` 为 `local` 来激活这个配置文件。

这可以通过多种方式实现：

#### 1. 在 `application.yml` 或 `application.properties` 中设置 ####

在你的主配置文件中，你可以设置：

spring:
      profiles:
        active: local

或者，如果你使用的是 `.properties` 格式：

spring.profiles.active=local

这将默认激活 `local` profile。

#### 2. 通过命令行参数 ####

当启动应用程序时，你可以通过命令行参数来指定活跃的 profile：

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

#### 3. 在环境变量中设置 ####

你也可以通过设置环境变量来指定活跃的 profile。这在某些部署环境中特别有用：

export SPRING_PROFILES_ACTIVE=local

然后启动你的应用程序。

#### 注意事项 ####

*  当 `spring.profiles.active` 被设置时，Spring Boot 会合并 `application.yml`（或 `application.properties`）和对应 profile 的配置文件（如 `application-local.yml`）。如果有任何冲突的配置，profile 特定的配置将覆盖主配置文件中的设置。
 *  你可以同时激活多个 profiles，只需在设置时用逗号分隔它们，例如 `local,dev`。
 *  使用 profile 时，确保你的配置文件命名遵循 `application-{profile}.yml` 的格式。例如，对于 `local` profile，文件应该命名为 `application-local.yml`。