springboot配置文件如何實現(xiàn)多個yml相互讀取問題

更新時間：2024年11月08日 09:56:02 作者：舒一笑不禿頭

在SpringBoot應用中,可以通過多種方式實現(xiàn)多個YAML配置文件的相互讀取和組合,SpringBoot2.4及以上版本可以使用spring.config.import屬性導入其他配置文件,@PropertySource注解雖不支持YAML

springboot配置文件實現(xiàn)多個yml相互讀取

在Spring Boot中，可以通過多種方式來實現(xiàn)配置文件的相互讀取和組合。

如果你想要在一個Spring Boot應用中使用多個YAML（.yml）配置文件，并且希望這些配置文件可以相互讀取或者互相覆蓋某些配置，你可以采用以下幾種方法：

從Spring Boot 2.4開始，引入了spring.config.import屬性，允許你導入其他配置文件。

例如，在你的application.yml中，你可以這樣做：

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

這將會導入同一類路徑下的additional-config.yml文件。

雖然@PropertySource注解不支持YAML格式的文件，但你可以使用它來加載.properties格式的文件。

如果你的配置可以轉換為.properties格式，這是一個可行的選擇。

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

對于多個配置文件，可以使用@PropertySources注解。

在你的主配置文件中，你可以指定要包含的其他配置文件的profiles。

例如，在application.yml中：

spring:
  profiles:
    include: 
      - additional

然后，你可以有一個名為application-additional.yml的文件，它將被自動加載。

Spring Boot默認會讀取application.yml或application.properties文件。

你可以通過在啟動時指定不同的配置文件名來加載不同的配置文件。

例如：

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

這將會加載another-application.yml而不是application.yml。

你可以在一個YAML文件中定義多個profiles，每個profile有不同的配置。

然后，你可以在運行時通過設置spring.profiles.active來指定哪個profile是活躍的。

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

然后通過命令行參數(shù)來激活特定的profile：

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

這些方法可以根據(jù)需要組合使用，以實現(xiàn)更復雜的配置管理策略。

例如，你可以在主配置文件中使用spring.config.import來導入其他配置文件，同時使用profiles來定義特定環(huán)境下的配置變量。

例如，如果你有一個名為 application-local.yml 的文件，它包含了專門為本地開發(fā)環(huán)境定制的配置，你可以通過設置 spring.profiles.active 為 local 來激活這個配置文件。

這可以通過多種方式實現(xiàn)：

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

spring:
  profiles:
    active: local

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

spring.profiles.active=local

這將默認激活 local profile。

當啟動應用程序時，你可以通過命令行參數(shù)來指定活躍的 profile：

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

你也可以通過設置環(huán)境變量來指定活躍的 profile。

這在某些部署環(huán)境中特別有用：

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。