25. Profiles

Spring Profiles 提供了一种分离应用程序配置的各个部分并使之仅在某些环境中可用的方法。任何@Component@Configuration都可以标记为@Profile以限制其加载时间:

@Configuration
@Profile("production")
public class ProductionConfiguration {

    // ...

}

以正常的 Spring 方式,您可以使用spring.profiles.active Environment属性来指定哪些配置文件处于 Active 状态。您可以通过任何常用方式指定属性,例如,可以将其包含在application.properties中:

spring.profiles.active=dev,hsqldb

或使用--spring.profiles.active=dev,hsqldb在命令行上指定。

25.1 添加 Active 配置文件

spring.profiles.active属性遵循与其他属性相同的排序规则,最高的PropertySource将获胜。这意味着您可以在application.properties中指定 Active 配置文件,然后使用命令行开关“替换”它们。

有时,将特定于配置文件的属性“添加”到 Active 配置文件而不是替换它们很有用。 spring.profiles.include属性可用于无条件添加 Active 配置文件。 SpringApplication入口点还具有 Java API,用于设置其他配置文件(即,在由spring.profiles.active属性激活的配置文件之上):请参见setAdditionalProfiles()方法。

例如,当使用开关--spring.profiles.active=prod运行具有以下属性的应用程序时,还将激活proddbprodmq配置文件:

---
my.property: fromyamlfile
---
spring.profiles: prod
spring.profiles.include:
  - proddb
  - prodmq

Note

请记住,可以在 YAML 文档中定义spring.profiles属性,以确定何时将该特定文档包括在配置中。有关更多详细信息,请参见第 72.7 节“根据环境更改配置”

25.2 以编程方式设置配置文件

您可以在应用程序运行之前通过调用SpringApplication.setAdditionalProfiles(…)以编程方式设置 Active 配置文件。也可以使用 Spring 的ConfigurableEnvironment界面激活配置文件。

25.3 特定于配置文件的配置文件

application.properties(或application.yml)和通过@ConfigurationProperties引用的文件的特定于配置文件的变体在加载文件时被视为。有关详细信息,请参见* 第 24.4 节“特定于配置文件的属性” *。