外部化配置

Spring Boot 允许你外部化你的配置,这样你就可以在不同的环境中使用相同的应用程序代码。你可以使用各种外部配置源,包括 Java properties 文件、YAML 文件、环境变量和命令行参数。

属性值可以通过使用 @Value 注解直接注入到你的 bean 中,通过 Spring 的 Environment 抽象来访问,或者通过 @ConfigurationProperties 绑定到结构化对象

Spring Boot 使用一种非常特殊的 PropertySource 顺序,旨在允许合理地覆盖值。后面的属性源可以覆盖前面定义的属性值。

来源按以下顺序考虑:

  1. 默认属性(通过设置 SpringApplication.setDefaultProperties(Map) 指定)。

  2. 你的 @Configuration 类上的 @PropertySource 注解。请注意,这些属性源在应用程序上下文刷新之前不会添加到 Environment 中。这对于配置某些属性(如 logging.*spring.main.*)来说太晚了,因为它们在刷新开始之前就被读取。

  3. 配置数据(例如 application.properties 文件)。

  4. 一个 RandomValuePropertySource,它只有 random.* 中的属性。

  5. 操作系统环境变量。

  6. Java 系统属性(System.getProperties())。

  7. 来自 java:comp/env 的 JNDI 属性。

  8. ServletContext 初始化参数。

  9. ServletConfig 初始化参数。

  10. 来自 SPRING_APPLICATION_JSON 的属性(嵌入在环境变量或系统属性中的内联 JSON)。

  11. 命令行参数。

  12. 你的测试上的 properties 属性。可在 @SpringBootTest用于测试应用程序特定部分的测试注解 上使用。

  13. 你的测试中的 @DynamicPropertySource 注解。

  14. 你的测试上的 @TestPropertySource 注解。

  15. 当 devtools 激活时,$HOME/.config/spring-boot 目录中的 Devtools 全局设置属性

配置文件按以下顺序考虑:

  1. 打包在你的 jar 中的 应用程序属性application.properties 和 YAML 变体)。

  2. 打包在你的 jar 中的 特定于配置文件的应用程序属性application-{profile}.properties 和 YAML 变体)。

  3. 打包在你的 jar 之外的 应用程序属性application.properties 和 YAML 变体)。

  4. 打包在你的 jar 之外的 特定于配置文件的应用程序属性application-{profile}.properties 和 YAML 变体)。

建议你的整个应用程序坚持使用一种格式。如果你在同一位置同时拥有 .properties 和 YAML 格式的配置文件,则 .properties 优先。
如果你使用环境变量而不是系统属性,大多数操作系统不允许使用句点分隔的键名,但你可以使用下划线代替(例如,SPRING_CONFIG_NAME 而不是 spring.config.name)。详情请参阅从环境变量绑定
如果你的应用程序在 Servlet 容器或应用服务器中运行,那么可以使用 JNDI 属性(在 java:comp/env 中)或 Servlet 上下文初始化参数,而不是或同时使用环境变量或系统属性。

举一个具体的例子,假设你开发了一个使用 name 属性的 @Component,如以下示例所示

  • Java

  • Kotlin

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

	@Value("${name}")
	private String name;

	// ...

}
import org.springframework.beans.factory.annotation.Value
import org.springframework.stereotype.Component

@Component
class MyBean {

	@Value("\${name}")
	private val name: String? = null

	// ...

}

在你的应用程序类路径中(例如,在你的 jar 内部),你可以有一个 application.properties 文件,为 name 提供一个合理的默认属性值。当在新环境中运行时,可以在你的 jar 外部提供一个 application.properties 文件来覆盖 name。对于一次性测试,你可以使用特定的命令行开关启动(例如,java -jar app.jar --name="Spring")。

envconfigprops 端点对于确定属性为何具有特定值非常有用。你可以使用这两个端点来诊断意外的属性值。有关详细信息,请参阅生产就绪功能部分。

访问命令行属性

默认情况下,SpringApplication 会将任何命令行选项参数(即以 -- 开头的参数,例如 --server.port=9000)转换为 property 并将其添加到 Spring Environment。如前所述,命令行属性始终优先于基于文件的属性源。

如果你不希望将命令行属性添加到 Environment 中,你可以通过使用 SpringApplication.setAddCommandLineProperties(false) 来禁用它们。

JSON 应用程序属性

环境变量和系统属性通常有严格的限制,这意味着有些属性名称无法使用。为了解决这个问题,Spring Boot 允许你将一个属性块编码成一个 JSON 结构。

当你的应用程序启动时,任何 spring.application.jsonSPRING_APPLICATION_JSON 属性将被解析并添加到 Environment 中。

例如,SPRING_APPLICATION_JSON 属性可以在 UN*X shell 的命令行中作为环境变量提供

$ SPRING_APPLICATION_JSON='{"my":{"name":"test"}}' java -jar myapp.jar

在前面的示例中,你在 Spring Environment 中得到 my.name=test

相同的 JSON 也可以作为系统属性提供

$ java -Dspring.application.json='{"my":{"name":"test"}}' -jar myapp.jar

或者,你可以使用命令行参数提供 JSON

$ java -jar myapp.jar --spring.application.json='{"my":{"name":"test"}}'

如果你正在部署到经典的应用程序服务器,你也可以使用名为 java:comp/env/spring.application.json 的 JNDI 变量。

尽管 JSON 中的 null 值将被添加到生成的属性源中,但 PropertySourcesPropertyResolver 会将 null 属性视为缺失值。这意味着 JSON 不能用 null 值覆盖来自较低优先级属性源的属性。

外部应用程序属性

当你的应用程序启动时,Spring Boot 会自动从以下位置查找并加载 application.propertiesapplication.yaml 文件

  1. 从类路径中

    1. 类路径根目录

    2. 类路径 /config

  2. 从当前目录中

    1. 当前目录

    2. 当前目录中的 config/ 子目录

    3. config/ 子目录的直接子目录

列表按优先级排序(后面项的值会覆盖前面项的值)。从加载的文件中提取的文档将作为 PropertySource 实例添加到 Spring Environment 中。

如果你不喜欢将 application 作为配置文件名,你可以通过指定 spring.config.name 环境变量来切换到另一个文件名。例如,要查找 myproject.propertiesmyproject.yaml 文件,你可以如下运行你的应用程序

$ java -jar myproject.jar --spring.config.name=myproject

你还可以通过使用 spring.config.location 环境变量来引用一个显式位置。此属性接受一个逗号分隔的一个或多个位置列表以进行检查。

以下示例显示了如何指定两个不同的文件

$ java -jar myproject.jar --spring.config.location=\
	optional:classpath:/default.properties,\
	optional:classpath:/override.properties
如果位置是可选的并且你不介意它们不存在,则使用前缀 optional:
spring.config.namespring.config.locationspring.config.additional-location 在很早的时候就被用于确定要加载哪些文件。它们必须定义为环境变量(通常是 OS 环境变量、系统属性或命令行参数)。

如果 spring.config.location 包含目录(而不是文件),它们应该以 / 结尾。在运行时,它们将在加载之前附加从 spring.config.name 生成的名称。在 spring.config.location 中指定的文件将直接导入。

目录和文件位置值也会展开以检查特定于配置文件的文件。例如,如果你的 spring.config.locationclasspath:myconfig.properties,你还会发现相应的 classpath:myconfig-<profile>.properties 文件也会被加载。

在大多数情况下,你添加的每个 spring.config.location 项都将引用单个文件或目录。位置按其定义的顺序处理,后面的位置可以覆盖前面位置的值。

如果你有一个复杂的 konum 设置,并且使用了特定于配置文件的配置文件,你可能需要提供进一步的提示,以便 Spring Boot 知道它们应该如何分组。位置组是所有被视为同一级别的位置的集合。例如,你可能希望对所有类路径位置进行分组,然后对所有外部位置进行分组。位置组中的项应该用 ; 分隔。有关详细信息,请参阅特定于配置文件的文件部分中的示例。

使用 spring.config.location 配置的位置会替换默认位置。例如,如果 spring.config.location 配置为 optional:classpath:/custom-config/,optional:file:./custom-config/,则考虑的完整位置集为

  1. optional:classpath:custom-config/

  2. optional:file:./custom-config/

如果你更喜欢添加额外的位置而不是替换它们,你可以使用 spring.config.additional-location。从额外位置加载的属性可以覆盖默认位置中的属性。例如,如果 spring.config.additional-location 配置为 optional:classpath:/custom-config/,optional:file:./custom-config/,则考虑的完整位置集为

  1. optional:classpath:/;optional:classpath:/config/

  2. optional:file:./;optional:file:./config/;optional:file:./config/*/

  3. optional:classpath:custom-config/

  4. optional:file:./custom-config/

这种搜索顺序允许你在一个配置文件中指定默认值,然后在另一个文件中选择性地覆盖这些值。你可以在默认位置之一的 application.properties(或你使用 spring.config.name 选择的任何其他基本名称)中为你的应用程序提供默认值。然后,这些默认值可以在运行时通过位于自定义位置之一的不同文件来覆盖。

可选位置

默认情况下,当指定的配置数据位置不存在时,Spring Boot 会抛出 ConfigDataLocationNotFoundException,你的应用程序将无法启动。

如果你想指定一个位置,但你不介意它不总是存在,你可以使用 optional: 前缀。你可以在 spring.config.locationspring.config.additional-location 属性以及 spring.config.import 声明中使用此前缀。

例如,optional:file:./myconfig.propertiesspring.config.import 值允许你的应用程序启动,即使 myconfig.properties 文件缺失。

如果你想忽略所有 ConfigDataLocationNotFoundException 错误并始终继续启动应用程序,你可以使用 spring.config.on-not-found 属性。使用 SpringApplication.setDefaultProperties(…​) 或使用系统/环境变量将其值设置为 ignore

通配符位置

如果配置文件位置的最后一个路径段包含 * 字符,则它被视为通配符位置。加载配置时会展开通配符,以便也检查直接子目录。通配符位置在 Kubernetes 等环境中特别有用,因为存在多个配置属性源。

例如,如果你有一些 Redis 配置和一些 MySQL 配置,你可能希望将这两个配置块分开,同时要求它们都存在于 application.properties 文件中。这可能会导致两个单独的 application.properties 文件挂载在不同的位置,例如 /config/redis/application.properties/config/mysql/application.properties。在这种情况下,具有 config/*/ 的通配符位置将导致这两个文件都被处理。

默认情况下,Spring Boot 在默认搜索位置中包含 config/*/。这意味着将搜索你的 jar 之外的 /config 目录的所有子目录。

你可以在 spring.config.locationspring.config.additional-location 属性中自己使用通配符位置。

通配符位置必须只包含一个 *,并且对于目录搜索位置以 */ 结尾,对于文件搜索位置以 */<filename> 结尾。包含通配符的位置按文件名的绝对路径按字母顺序排序。
通配符位置仅适用于外部目录。你不能在 classpath: 位置中使用通配符。

特定于配置文件的文件

除了 application 属性文件之外,Spring Boot 还会尝试使用命名约定 application-{profile} 来加载特定于配置文件的文件。例如,如果你的应用程序激活了一个名为 prod 的配置文件并使用 YAML 文件,那么 application.yamlapplication-prod.yaml 都将被考虑。

特定于配置文件的属性从与标准 application.properties 相同的位置加载,特定于配置文件的文件总是覆盖非特定文件。如果指定了多个配置文件,则采用“后胜”策略。例如,如果 spring.profiles.active 属性指定了 prod,live 配置文件,则 application-prod.properties 中的值可能会被 application-live.properties 中的值覆盖。

“后胜”策略适用于位置组级别。classpath:/cfg/,classpath:/ext/spring.config.location 将不会与 classpath:/cfg/;classpath:/ext/ 具有相同的覆盖规则。

例如,继续上面的 prod,live 示例,我们可能有以下文件

/cfg
  application-live.properties
/ext
  application-live.properties
  application-prod.properties

当我们的 spring.config.locationclasspath:/cfg/,classpath:/ext/ 时,我们会在处理所有 /ext 文件之前处理所有 /cfg 文件

  1. /cfg/application-live.properties

  2. /ext/application-prod.properties

  3. /ext/application-live.properties

当我们改为使用 classpath:/cfg/;classpath:/ext/(使用 ; 分隔符)时,我们会在同一级别处理 /cfg/ext

  1. /ext/application-prod.properties

  2. /cfg/application-live.properties

  3. /ext/application-live.properties

如果未设置活动配置文件,Environment 将有一组默认配置文件(默认情况下为 [default])。换句话说,如果没有明确激活配置文件,则会考虑 application-default 中的属性。

属性文件只会加载一次。如果你已经直接导入了一个特定于配置文件的属性文件,那么它将不会第二次导入。

导入额外数据

应用程序属性可以使用 spring.config.import 属性从其他位置导入更多配置数据。导入会在发现时进行处理,并被视为紧接在声明导入的文档下方插入的额外文档。

例如,你的类路径 application.properties 文件中可能有以下内容

  • 属性

  • YAML

spring.application.name=myapp
spring.config.import=optional:file:./dev.properties
spring:
  application:
    name: "myapp"
  config:
    import: "optional:file:./dev.properties"

这将触发导入当前目录中的 dev.properties 文件(如果此类文件存在)。从导入的 dev.properties 中获取的值将优先于触发导入的文件。在上面的示例中,dev.properties 可以将 spring.application.name 重新定义为不同的值。

无论声明多少次,导入只会导入一次。

使用“固定”和“导入相对”位置

导入可以指定为固定导入相对位置。固定位置总是解析为相同的底层资源,无论 spring.config.import 属性在哪里声明。导入相对位置解析为相对于声明 spring.config.import 属性的文件。

以斜杠 (/) 或 URL 样式前缀 (file:, classpath: 等) 开头的位置被认为是固定的。所有其他位置都被认为是导入相对的。

在确定位置是固定还是导入相对时,不考虑 optional: 前缀。

举个例子,假设我们有一个 /demo 目录,其中包含我们的 application.jar 文件。我们可能会添加一个包含以下内容的 /demo/application.properties 文件

spring.config.import=optional:core/core.properties

这是一个导入相对位置,因此如果文件 /demo/core/core.properties 存在,它将尝试加载该文件。

如果 /demo/core/core.properties 包含以下内容

spring.config.import=optional:extra/extra.properties

它将尝试加载 /demo/core/extra/extra.propertiesoptional:extra/extra.properties 相对于 /demo/core/core.properties,因此完整目录是 /demo/core/ + extra/extra.properties

属性顺序

在属性/yaml 文件中单个文档内定义导入的顺序无关紧要。例如,以下两个示例产生相同的结果

  • 属性

  • YAML

spring.config.import=my.properties
my.property=value
spring:
  config:
    import: "my.properties"
my:
  property: "value"
  • 属性

  • YAML

my.property=value
spring.config.import=my.properties
my:
  property: "value"
spring:
  config:
    import: "my.properties"

在上述两个示例中,my.properties 文件中的值将优先于触发其导入的文件。

可以在单个 spring.config.import 键下指定多个位置。位置将按其定义的顺序进行处理,后导入的优先级更高。

在适当的情况下,还会考虑特定于配置文件的变体以进行导入。上面的示例将导入 my.properties 以及任何 my-<profile>.properties 变体。

Spring Boot 包含可插拔 API,允许支持各种不同的位置地址。默认情况下,你可以导入 Java Properties、YAML 和配置树

第三方 jar 可以为其他技术提供支持(文件不必是本地的)。例如,你可以想象配置数据来自外部存储,例如 Consul、Apache ZooKeeper 或 Netflix Archaius。

如果你想支持自己的位置,请参阅 org.springframework.boot.context.config 包中的 ConfigDataLocationResolverConfigDataLoader 类。

导入无扩展名的文件

一些云平台无法为卷挂载的文件添加文件扩展名。为了导入这些无扩展名的文件,你需要给 Spring Boot 一个提示,以便它知道如何加载它们。你可以通过在方括号中放置一个扩展名提示来实现这一点。

例如,假设你有一个 /etc/config/myconfig 文件,你想将其作为 yaml 导入。你可以从 application.properties 中使用以下内容导入它

  • 属性

  • YAML

spring.config.import=file:/etc/config/myconfig[.yaml]
spring:
  config:
    import: "file:/etc/config/myconfig[.yaml]"

使用环境变量

在云平台(如 Kubernetes)上运行应用程序时,你通常需要读取平台提供的配置值。你可以为此目的使用环境变量,或者使用配置树

你甚至可以将整个配置以属性或 yaml 格式存储在(多行)环境变量中,并使用 env: 前缀加载它们。假设有一个名为 MY_CONFIGURATION 的环境变量,其内容如下

my.name=Service1
my.cluster=Cluster1

使用 env: 前缀可以从这个变量中导入所有属性

  • 属性

  • YAML

spring.config.import=env:MY_CONFIGURATION
spring:
  config:
    import: "env:MY_CONFIGURATION"
此功能还支持指定扩展名。默认扩展名为 .properties

使用配置树

将配置值存储在环境变量中存在缺点,特别是当值需要保密时。

作为环境变量的替代方案,许多云平台现在允许你将配置映射到挂载的数据卷中。例如,Kubernetes 可以卷挂载 ConfigMapsSecrets

有两种常见的卷挂载模式可以使用

  1. 单个文件包含一整套属性(通常以 YAML 格式编写)。

  2. 多个文件写入目录树,文件名成为“键”,内容成为“值”。

对于第一种情况,你可以直接使用 spring.config.import 导入 YAML 或 Properties 文件,如上文所述。对于第二种情况,你需要使用 configtree: 前缀,以便 Spring Boot 知道它需要将所有文件公开为属性。

例如,假设 Kubernetes 挂载了以下卷

etc/
  config/
    myapp/
      username
      password

username 文件的内容将是配置值,而 password 的内容将是秘密。

要导入这些属性,你可以将以下内容添加到你的 application.propertiesapplication.yaml 文件中

  • 属性

  • YAML

spring.config.import=optional:configtree:/etc/config/
spring:
  config:
    import: "optional:configtree:/etc/config/"

然后,你可以像往常一样从 Environment 访问或注入 myapp.usernamemyapp.password 属性。

配置树下的文件夹和文件的名称构成了属性名。在上面的例子中,要将属性作为 usernamepassword 访问,你可以将 spring.config.import 设置为 optional:configtree:/etc/config/myapp
带点符号的文件名也能正确映射。例如,在上面的例子中,/etc/config 中名为 myapp.username 的文件将在 Environment 中产生 myapp.username 属性。
配置树值可以绑定到字符串 Stringbyte[] 类型,具体取决于预期的内容。

如果你有多个配置树要从同一个父文件夹导入,你可以使用通配符快捷方式。任何以 /*/ 结尾的 configtree: 位置都将把所有直接子项作为配置树导入。与非通配符导入一样,每个配置树下文件夹和文件的名称构成了属性名。

例如,给定以下卷

etc/
  config/
    dbconfig/
      db/
        username
        password
    mqconfig/
      mq/
        username
        password

你可以使用 configtree:/etc/config/*/ 作为导入位置

  • 属性

  • YAML

spring.config.import=optional:configtree:/etc/config/*/
spring:
  config:
    import: "optional:configtree:/etc/config/*/"

这将添加 db.usernamedb.passwordmq.usernamemq.password 属性。

使用通配符加载的目录按字母顺序排序。如果你需要不同的顺序,那么你应该将每个位置列为单独的导入

配置树也可用于 Docker 密钥。当 Docker swarm 服务被授予访问密钥的权限时,密钥会被挂载到容器中。例如,如果名为 db.password 的密钥挂载在 /run/secrets/ 位置,你可以使用以下方法使 db.password 对 Spring 环境可用

  • 属性

  • YAML

spring.config.import=optional:configtree:/run/secrets/
spring:
  config:
    import: "optional:configtree:/run/secrets/"

属性占位符

application.propertiesapplication.yaml 中的值在使用时会通过现有 Environment 进行过滤,因此你可以引用以前定义的值(例如,来自系统属性或环境变量)。标准的 ${name} 属性占位符语法可以在值的任何地方使用。属性占位符还可以使用 : 分隔符来指定默认值,例如 ${name:default}

以下示例显示了使用带和不带默认值的占位符的情况

  • 属性

  • YAML

app.name=MyApp
app.description=${app.name} is a Spring Boot application written by ${username:Unknown}
app:
  name: "MyApp"
  description: "${app.name} is a Spring Boot application written by ${username:Unknown}"

假设 username 属性没有在其他地方设置,则 app.description 的值将为 MyApp is a Spring Boot application written by Unknown

你应该始终以其规范形式(使用小写字母的烤肉串式)引用占位符中的属性名称。这将允许 Spring Boot 使用与 宽松绑定 @ConfigurationProperties 时相同的逻辑。

例如,${demo.item-price} 将从 application.properties 文件中获取 demo.item-pricedemo.itemPrice 形式,以及从系统环境中获取 DEMO_ITEMPRICE。如果你使用 ${demo.itemPrice},则不会考虑 demo.item-priceDEMO_ITEMPRICE

你也可以使用此技术创建现有 Spring Boot 属性的“短”变体。有关详细信息,请参阅“操作指南”中的使用“短”命令行参数部分。

处理多文档文件

Spring Boot 允许你将一个物理文件分割成多个逻辑文档,每个文档都独立添加。文档按从上到下的顺序处理。后面的文档可以覆盖前面文档中定义的属性。

对于 application.yaml 文件,使用标准的 YAML 多文档语法。三个连续的连字符表示一个文档的结束,以及下一个文档的开始。

例如,以下文件有两个逻辑文档

spring:
  application:
    name: "MyApp"
---
spring:
  application:
    name: "MyCloudApp"
  config:
    activate:
      on-cloud-platform: "kubernetes"

对于 application.properties 文件,使用特殊的 #---!--- 注释来标记文档分隔符

spring.application.name=MyApp
#---
spring.application.name=MyCloudApp
spring.config.activate.on-cloud-platform=kubernetes
属性文件分隔符不得有任何前导空格,并且必须正好有三个连字符。分隔符之前和之后的行不得具有相同的注释前缀。
多文档属性文件通常与激活属性(例如 spring.config.activate.on-profile)结合使用。有关详细信息,请参阅下一节
多文档属性文件不能通过使用 @PropertySource@TestPropertySource 注解加载。

激活属性

在满足特定条件时,有时只激活一组给定的属性很有用。例如,你可能有一些属性仅在特定配置文件处于活动状态时才相关。

你可以使用 spring.config.activate.* 条件性地激活属性文档。

以下激活属性可用

表1. 激活属性
财产 备注

on-profile

必须匹配才能使文档处于活动状态的配置文件表达式,或者必须至少匹配其中一个才能使文档处于活动状态的配置文件表达式列表。

on-cloud-platform

必须检测到才能使文档处于活动状态的 CloudPlatform

例如,以下内容指定第二个文档仅在 Kubernetes 上运行且同时“prod”或“staging”配置文件处于活动状态时才处于活动状态

  • 属性

  • YAML

myprop=always-set
#---
spring.config.activate.on-cloud-platform=kubernetes
spring.config.activate.on-profile=prod | staging
myotherprop=sometimes-set
myprop:
  "always-set"
---
spring:
  config:
    activate:
      on-cloud-platform: "kubernetes"
      on-profile: "prod | staging"
myotherprop: "sometimes-set"

加密属性

Spring Boot 不提供任何内置支持来加密属性值,但是,它提供了必要的挂钩点来修改 Spring Environment 中包含的值。EnvironmentPostProcessor 接口允许你在应用程序启动之前操作 Environment。有关详细信息,请参阅在应用程序启动之前自定义环境或应用程序上下文

如果你需要一种安全的方式来存储凭据和密码,Spring Cloud Vault 项目提供了对将外部化配置存储在 HashiCorp Vault 中的支持。

使用 YAML

YAML 是 JSON 的超集,因此是指定分层配置数据的便捷格式。只要你的类路径中包含 SnakeYAML 库,SpringApplication 类就会自动支持 YAML 作为属性的替代方案。

如果你使用 starter,SnakeYAML 会由 spring-boot-starter 自动提供。

将 YAML 映射到属性

YAML 文档需要从其分层格式转换为扁平结构,以便与 Spring Environment 一起使用。例如,考虑以下 YAML 文档

environments:
  dev:
    url: "https://dev.example.com"
    name: "Developer Setup"
  prod:
    url: "https://another.example.com"
    name: "My Cool App"

为了从 Environment 访问这些属性,它们将被扁平化,如下所示

environments.dev.url=https://dev.example.com
environments.dev.name=Developer Setup
environments.prod.url=https://another.example.com
environments.prod.name=My Cool App

同样,YAML 列表也需要扁平化。它们表示为带有 [index] 解引用器的属性键。例如,考虑以下 YAML

 my:
  servers:
  - "dev.example.com"
  - "another.example.com"

前面的示例将被转换为这些属性

my.servers[0]=dev.example.com
my.servers[1]=another.example.com
使用 [index] 表示法的属性可以通过 Spring Boot 的 Binder 类绑定到 Java ListSet 对象。有关更多详细信息,请参阅下面的类型安全配置属性部分。
YAML 文件不能通过使用 @PropertySource@TestPropertySource 注解加载。因此,如果你需要以这种方式加载值,则需要使用属性文件。

直接加载 YAML

Spring Framework 提供了两个方便的类,可用于加载 YAML 文档。YamlPropertiesFactoryBean 将 YAML 作为 Properties 加载,而 YamlMapFactoryBean 将 YAML 作为 Map 加载。

如果你想将 YAML 作为 Spring PropertySource 加载,你也可以使用 YamlPropertySourceLoader 类。

配置随机值

RandomValuePropertySource 对于注入随机值(例如,到秘密或测试用例中)很有用。它可以生成整数、长整数、UUID 或字符串,如以下示例所示

  • 属性

  • YAML

my.secret=${random.value}
my.number=${random.int}
my.bignumber=${random.long}
my.uuid=${random.uuid}
my.number-less-than-ten=${random.int(10)}
my.number-in-range=${random.int[1024,65536]}
my:
  secret: "${random.value}"
  number: "${random.int}"
  bignumber: "${random.long}"
  uuid: "${random.uuid}"
  number-less-than-ten: "${random.int(10)}"
  number-in-range: "${random.int[1024,65536]}"

random.int* 语法是 OPEN value (,max) CLOSE,其中 OPEN,CLOSE 是任意字符,value,max 是整数。如果提供了 max,则 value 是最小值,max 是最大值(不包括)。

配置系统环境变量

Spring Boot 支持为环境属性设置前缀。如果系统环境由多个具有不同配置需求的 Spring Boot 应用程序共享,这会很有用。系统环境属性的前缀可以在 SpringApplication 上直接设置,方法是在应用程序运行之前调用 setEnvironmentPrefix(…​) 方法。

例如,如果将前缀设置为 input,则 remote.timeout 等属性将在系统环境中解析为 INPUT_REMOTE_TIMEOUT

此前缀适用于系统环境变量。上述示例在从其他源读取属性时将继续使用 remote.timeout

类型安全配置属性

使用 @Value("${property}") 注解注入配置属性有时可能很麻烦,特别是当你处理多个属性或数据本质上是分层的时候。Spring Boot 提供了一种处理属性的替代方法,允许强类型 bean 管理和验证你的应用程序的配置。

另请参阅 @Value 和类型安全配置属性之间的差异

JavaBean 属性绑定

可以绑定声明标准 JavaBean 属性的 bean,如以下示例所示

  • Java

  • Kotlin

import java.net.InetAddress;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties("my.service")
public class MyProperties {

	private boolean enabled;

	private InetAddress remoteAddress;

	private final Security security = new Security();

	// getters / setters...

	public boolean isEnabled() {
		return this.enabled;
	}

	public void setEnabled(boolean enabled) {
		this.enabled = enabled;
	}

	public InetAddress getRemoteAddress() {
		return this.remoteAddress;
	}

	public void setRemoteAddress(InetAddress remoteAddress) {
		this.remoteAddress = remoteAddress;
	}

	public Security getSecurity() {
		return this.security;
	}

	public static class Security {

		private String username;

		private String password;

		private List<String> roles = new ArrayList<>(Collections.singleton("USER"));

		// getters / setters...

		public String getUsername() {
			return this.username;
		}

		public void setUsername(String username) {
			this.username = username;
		}

		public String getPassword() {
			return this.password;
		}

		public void setPassword(String password) {
			this.password = password;
		}

		public List<String> getRoles() {
			return this.roles;
		}

		public void setRoles(List<String> roles) {
			this.roles = roles;
		}

	}

}
import org.springframework.boot.context.properties.ConfigurationProperties
import java.net.InetAddress

@ConfigurationProperties("my.service")
class MyProperties {

	var isEnabled = false

	var remoteAddress: InetAddress? = null

	val security = Security()

	class Security {

		var username: String? = null

		var password: String? = null

		var roles: List<String> = ArrayList(setOf("USER"))

	}

}

前面的 POJO 定义了以下属性

  • my.service.enabled,默认值为 false

  • my.service.remote-address,其类型可以从 String 强制转换。

  • my.service.security.username,带有一个嵌套的“security”对象,其名称由属性名称决定。特别是,类型在那里根本没有使用,并且可以是 SecurityProperties

  • my.service.security.password.

  • my.service.security.roles,一个 String 集合,默认为 USER

要在属性名称中使用保留关键字,例如 my.service.import,请在该属性的字段上使用 @Name 注解。
映射到 Spring Boot 中可用的 @ConfigurationProperties 类的属性(通过属性文件、YAML 文件、环境变量和其他机制配置)是公共 API,但类本身的访问器(getter/setter)不应直接使用。

这种安排依赖于默认的空构造函数,并且 getter 和 setter 通常是强制性的,因为绑定是通过标准的 Java Beans 属性描述符进行的,就像在 Spring MVC 中一样。在以下情况下可以省略 setter

  • 预初始化的 Map 和 Collection,只要它们用可变实现(如前例中的 roles 字段)初始化。

  • 预初始化的嵌套 POJO(如前例中的 Security 字段)。如果你希望 binder 通过其默认构造函数即时创建实例,则需要一个 setter。

有些人使用 Project Lombok 自动添加 getter 和 setter。请确保 Lombok 不会为此类类型生成任何特定构造函数,因为它会自动被容器用于实例化对象。

最后,只考虑标准的 Java Bean 属性,不支持静态属性的绑定。

构造函数绑定

上一节中的示例可以以不可变的方式重写,如以下示例所示

  • Java

  • Kotlin

import java.net.InetAddress;
import java.util.List;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.bind.DefaultValue;

@ConfigurationProperties("my.service")
public class MyProperties {

	// fields...

	private final boolean enabled;

	private final InetAddress remoteAddress;

	private final Security security;


	public MyProperties(boolean enabled, InetAddress remoteAddress, Security security) {
		this.enabled = enabled;
		this.remoteAddress = remoteAddress;
		this.security = security;
	}

	// getters...

	public boolean isEnabled() {
		return this.enabled;
	}

	public InetAddress getRemoteAddress() {
		return this.remoteAddress;
	}

	public Security getSecurity() {
		return this.security;
	}

	public static class Security {

		// fields...

		private final String username;

		private final String password;

		private final List<String> roles;


		public Security(String username, String password, @DefaultValue("USER") List<String> roles) {
			this.username = username;
			this.password = password;
			this.roles = roles;
		}

		// getters...

		public String getUsername() {
			return this.username;
		}

		public String getPassword() {
			return this.password;
		}

		public List<String> getRoles() {
			return this.roles;
		}

	}

}
import org.springframework.boot.context.properties.ConfigurationProperties
import org.springframework.boot.context.properties.bind.DefaultValue
import java.net.InetAddress

@ConfigurationProperties("my.service")
class MyProperties(val enabled: Boolean, val remoteAddress: InetAddress,
		val security: Security) {

	class Security(val username: String, val password: String,
			@param:DefaultValue("USER") val roles: List<String>)

}

在这种设置中,存在单个参数化构造函数意味着应该使用构造函数绑定。这意味着绑定器将找到一个带有你希望绑定的参数的构造函数。如果你的类有多个构造函数,可以使用 @ConstructorBinding 注解来指定用于构造函数绑定的构造函数。

要选择退出类的构造函数绑定,参数化构造函数必须用 @Autowired 注解或设为 private。Kotlin 开发人员可以使用空的主构造函数来选择退出构造函数绑定。

例如:

  • Java

  • Kotlin

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties("my")
public class MyProperties {

	// fields...

	final MyBean myBean;

	private String name;


	@Autowired
	public MyProperties(MyBean myBean) {
		this.myBean = myBean;
	}

	// getters / setters...


	public String getName() {
		return this.name;
	}

	public void setName(String name) {
		this.name = name;
	}


}
import org.springframework.boot.context.properties.ConfigurationProperties

@ConfigurationProperties("my")
class MyProperties() {

	constructor(name: String) : this() {
		this.name = name
	}

	// vars...

	var name: String? = null

}

构造函数绑定可用于记录。除非你的记录有多个构造函数,否则无需使用 @ConstructorBinding

构造函数绑定类的嵌套成员(如上面示例中的 Security)也将通过其构造函数进行绑定。

默认值可以使用构造函数参数和记录组件上的 @DefaultValue 来指定。转换服务将应用于将注解的 String 值强制转换为缺失属性的目标类型。

参考前面的例子,如果没有属性绑定到 SecurityMyProperties 实例将包含 securitynull 值。为了使其包含非空 Security 实例,即使没有属性绑定到它(在使用 Kotlin 时,这将要求 Securityusernamepassword 参数声明为可空,因为它们没有默认值),请使用空的 @DefaultValue 注解

  • Java

  • Kotlin

	public MyProperties(boolean enabled, InetAddress remoteAddress, @DefaultValue Security security) {
		this.enabled = enabled;
		this.remoteAddress = remoteAddress;
		this.security = security;
	}
class MyProperties(val enabled: Boolean, val remoteAddress: InetAddress,
		@DefaultValue val security: Security) {

	class Security(val username: String?, val password: String?,
			@param:DefaultValue("USER") val roles: List<String>)

}
要使用构造函数绑定,该类必须通过 @EnableConfigurationProperties 或配置属性扫描启用。你不能将构造函数绑定与通过常规 Spring 机制创建的 bean(例如 @Component bean、通过使用 @Bean 方法创建的 bean 或通过使用 @Import 加载的 bean)一起使用
要使用构造函数绑定,该类必须使用 -parameters 进行编译。如果你使用 Spring Boot 的 Gradle 插件或使用 Maven 和 spring-boot-starter-parent,这将自动发生。
不建议将 Optional@ConfigurationProperties 一起使用,因为它主要旨在用作返回类型。因此,它不适合配置属性注入。为了与其他类型的属性保持一致,如果你确实声明了一个 Optional 属性但它没有值,则将绑定 null 而不是空的 Optional
要在属性名称中使用保留关键字,例如 my.service.import,请在构造函数参数上使用 @Name 注解。

启用 @ConfigurationProperties 注解的类型

Spring Boot 提供了绑定 @ConfigurationProperties 类型并将其注册为 bean 的基础设施。你可以逐类启用配置属性,或启用与组件扫描类似地工作的配置属性扫描。

有时,用 @ConfigurationProperties 注解的类可能不适合扫描,例如,如果你正在开发自己的自动配置或想有条件地启用它们。在这些情况下,使用 @EnableConfigurationProperties 注解指定要处理的类型列表。这可以在任何 @Configuration 类上完成,如以下示例所示

  • Java

  • Kotlin

import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Configuration;

@Configuration(proxyBeanMethods = false)
@EnableConfigurationProperties(SomeProperties.class)
public class MyConfiguration {

}
import org.springframework.boot.context.properties.EnableConfigurationProperties
import org.springframework.context.annotation.Configuration

@Configuration(proxyBeanMethods = false)
@EnableConfigurationProperties(SomeProperties::class)
class MyConfiguration
  • Java

  • Kotlin

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties("some.properties")
public class SomeProperties {

}
import org.springframework.boot.context.properties.ConfigurationProperties

@ConfigurationProperties("some.properties")
class SomeProperties

要使用配置属性扫描,请将 @ConfigurationPropertiesScan 注解添加到你的应用程序中。通常,它添加到用 @SpringBootApplication 注解的主应用程序类中,但也可以添加到任何 @Configuration 类中。默认情况下,扫描将从声明该注解的类的包开始。如果你想定义要扫描的特定包,可以像以下示例所示那样操作

  • Java

  • Kotlin

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.ConfigurationPropertiesScan;

@SpringBootApplication
@ConfigurationPropertiesScan({ "com.example.app", "com.example.another" })
public class MyApplication {

}
import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.context.properties.ConfigurationPropertiesScan

@SpringBootApplication
@ConfigurationPropertiesScan("com.example.app", "com.example.another")
class MyApplication

当使用配置属性扫描或通过 @EnableConfigurationProperties 注册 @ConfigurationProperties bean 时,该 bean 具有约定名称:<prefix>-<fqn>,其中 <prefix>@ConfigurationProperties 注解中指定的环境键前缀,<fqn> 是 bean 的完全限定名。如果注解未提供任何前缀,则仅使用 bean 的完全限定名。

假设它在 com.example.app 包中,上面的 SomeProperties 示例的 bean 名称是 some.properties-com.example.app.SomeProperties

我们建议 @ConfigurationProperties 只处理环境,特别是不要从上下文中注入其他 bean。对于特殊情况,可以使用 setter 注入或框架提供的任何 *Aware 接口(例如,如果你需要访问 Environment,则使用 EnvironmentAware)。如果你仍然希望使用构造函数注入其他 bean,则配置属性 bean 必须用 @Component 注解并使用基于 JavaBean 的属性绑定。

使用 @ConfigurationProperties 注解的类型

这种配置方式与 SpringApplication 外部 YAML 配置特别搭配,如以下示例所示

my:
  service:
    remote-address: 192.168.1.1
    security:
      username: "admin"
      roles:
      - "USER"
      - "ADMIN"

要使用 @ConfigurationProperties bean,你可以像注入任何其他 bean 一样注入它们,如以下示例所示

  • Java

  • Kotlin

import org.springframework.stereotype.Service;

@Service
public class MyService {

	private final MyProperties properties;

	public MyService(MyProperties properties) {
		this.properties = properties;
	}

	public void openConnection() {
		Server server = new Server(this.properties.getRemoteAddress());
		server.start();
		// ...
	}

	// ...

}
import org.springframework.stereotype.Service

@Service
class MyService(val properties: MyProperties) {

	fun openConnection() {
		val server = Server(properties.remoteAddress)
		server.start()
		// ...
	}

	// ...

}
使用 @ConfigurationProperties 还可以生成元数据文件,IDE 可以使用这些文件为你的自定义键提供自动补全。有关详细信息,请参阅附录

第三方配置

除了使用 @ConfigurationProperties 注解类之外,你还可以在公共 @Bean 方法上使用它。当你想将属性绑定到不受你控制的第三方组件时,这样做可能特别有用。

要从 Environment 属性配置 bean,请将其添加到其 bean 注册中,如以下示例所示

  • Java

  • Kotlin

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

@Configuration(proxyBeanMethods = false)
public class ThirdPartyConfiguration {

	@Bean
	@ConfigurationProperties("another")
	public AnotherComponent anotherComponent() {
		return new AnotherComponent();
	}

}
import org.springframework.boot.context.properties.ConfigurationProperties
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration

@Configuration(proxyBeanMethods = false)
class ThirdPartyConfiguration {

	@Bean
	@ConfigurationProperties("another")
	fun anotherComponent(): AnotherComponent = AnotherComponent()

}

任何以 another 前缀定义的 JavaBean 属性都将以类似于前面 SomeProperties 示例的方式映射到该 AnotherComponent bean。

宽松绑定

Spring Boot 采用一些宽松的规则将 Environment 属性绑定到 @ConfigurationProperties bean,因此 Environment 属性名和 bean 属性名之间不需要完全匹配。这在连字符分隔的环境属性(例如,context-path 绑定到 contextPath)和首字母大写的环境属性(例如,PORT 绑定到 port)等常见示例中很有用。

例如,考虑以下 @ConfigurationProperties

  • Java

  • Kotlin

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties("my.main-project.person")
public class MyPersonProperties {

	private String firstName;

	public String getFirstName() {
		return this.firstName;
	}

	public void setFirstName(String firstName) {
		this.firstName = firstName;
	}

}
import org.springframework.boot.context.properties.ConfigurationProperties

@ConfigurationProperties("my.main-project.person")
class MyPersonProperties {

	var firstName: String? = null

}

使用前面的代码,以下属性名称都可以使用

表2. 宽松绑定
财产 备注

my.main-project.person.first-name

烤肉串式命名,推荐用于 .properties 和 YAML 文件。

my.main-project.person.firstName

标准驼峰式命名语法。

my.main-project.person.first_name

下划线表示法,是 .properties 和 YAML 文件中使用的另一种格式。

MY_MAINPROJECT_PERSON_FIRSTNAME

大写格式,推荐在系统环境变量中使用。

注解的 prefix必须是 kebab-case(小写并用 - 分隔,例如 my.main-project.person)。
表3. 每个属性源的宽松绑定规则
属性源 简单 List

属性文件

驼峰式、烤肉串式或下划线表示法

使用 [ ] 或逗号分隔值的标准列表语法

YAML 文件

驼峰式、烤肉串式或下划线表示法

标准 YAML 列表语法或逗号分隔值

环境变量

大写格式,下划线作为分隔符(请参阅从环境变量绑定)。

用下划线包围的数字值(请参阅从环境变量绑定

系统属性

驼峰式、烤肉串式或下划线表示法

使用 [ ] 或逗号分隔值的标准列表语法

我们建议在可能的情况下,属性以小写烤肉串格式存储,例如 my.person.first-name=Rod

绑定 Map

绑定到 Map 属性时,你可能需要使用特殊的方括号表示法,以便保留原始 key 值。如果键未用 [] 括起来,则任何非字母数字、-. 的字符都将被移除。

例如,考虑将以下属性绑定到 Map<String,String>

  • 属性

  • YAML

my.map[/key1]=value1
my.map[/key2]=value2
my.map./key3=value3
my:
  map:
    "[/key1]": "value1"
    "[/key2]": "value2"
    "/key3": "value3"
对于 YAML 文件,键需要用引号括起来才能正确解析。

上面的属性将绑定到一个 Map,其中 /key1/key2key3 作为 Map 中的键。斜杠已从 key3 中移除,因为它没有用方括号括起来。

当绑定到标量值时,包含 . 的键不需要用 [] 括起来。标量值包括枚举和 java.lang 包中除 Object 之外的所有类型。将 a.b=c 绑定到 Map<String, String> 将保留键中的 . 并返回一个包含条目 {"a.b"="c"} 的 Map。对于任何其他类型,如果你的 key 包含 .,则需要使用方括号表示法。例如,将 a.b=c 绑定到 Map<String, Object> 将返回一个包含条目 {"a"={"b"="c"}} 的 Map,而 [a.b]=c 将返回一个包含条目 {"a.b"="c"} 的 Map。

从环境变量绑定

大多数操作系统对可用于环境变量的名称施加了严格的规则。例如,Linux shell 变量只能包含字母(azAZ)、数字(09)或下划线字符(_)。按照惯例,Unix shell 变量的名称也采用大写形式。

Spring Boot 的宽松绑定规则尽可能地旨在与这些命名限制兼容。

要将规范形式的属性名称转换为环境变量名称,你可以遵循以下规则

  • 将点号 (.) 替换为下划线 (_)。

  • 移除所有连字符 (-)。

  • 转换为大写。

例如,配置属性 spring.main.log-startup-info 将是名为 SPRING_MAIN_LOGSTARTUPINFO 的环境变量。

在绑定到对象列表时,也可以使用环境变量。要绑定到 List,元素编号应在变量名称中用下划线包围。

例如,配置属性 my.service[0].other 将使用名为 MY_SERVICE_0_OTHER 的环境变量。

从环境变量绑定的支持应用于 systemEnvironment 属性源和任何以 -systemEnvironment 结尾的附加属性源。

从环境变量绑定 Map

当 Spring Boot 将环境变量绑定到属性类时,它会在绑定之前将环境变量名称转换为小写。大多数时候,这个细节并不重要,除非绑定到 Map 属性。

Map 中的键始终是小写,如以下示例所示

  • Java

  • Kotlin

import java.util.HashMap;
import java.util.Map;

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties("my.props")
public class MyMapsProperties {

	private final Map<String, String> values = new HashMap<>();

	public Map<String, String> getValues() {
		return this.values;
	}

}
import org.springframework.boot.context.properties.ConfigurationProperties

@ConfigurationProperties("my.props")
class MyMapsProperties {

	val values: Map<String, String> = HashMap()

}

当设置 MY_PROPS_VALUES_KEY=value 时,values Map 包含一个 {"key"="value"} 条目。

只有环境变量名称被转换为小写,而不是值。当设置 MY_PROPS_VALUES_KEY=VALUE 时,values Map 包含一个 {"key"="VALUE"} 条目。

缓存

宽松绑定使用缓存来提高性能。默认情况下,此缓存仅应用于不可变属性源。要自定义此行为,例如为可变属性源启用缓存,请使用 ConfigurationPropertyCaching

合并复杂类型

当列表在多个地方配置时,覆盖机制会替换整个列表。

例如,假设一个 MyPojo 对象,其 namedescription 属性默认为空。以下示例从 MyProperties 暴露了一个 MyPojo 对象列表

  • Java

  • Kotlin

import java.util.ArrayList;
import java.util.List;

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties("my")
public class MyProperties {

	private final List<MyPojo> list = new ArrayList<>();

	public List<MyPojo> getList() {
		return this.list;
	}

}
import org.springframework.boot.context.properties.ConfigurationProperties

@ConfigurationProperties("my")
class MyProperties {

	val list: List<MyPojo> = ArrayList()

}

考虑以下配置

  • 属性

  • YAML

my.list[0].name=my name
my.list[0].description=my description
#---
spring.config.activate.on-profile=dev
my.list[0].name=my another name
my:
  list:
  - name: "my name"
    description: "my description"
---
spring:
  config:
    activate:
      on-profile: "dev"
my:
  list:
  - name: "my another name"

如果 dev 配置文件未激活,则 MyProperties.list 包含一个 MyPojo 条目,如先前定义。但是,如果 dev 配置文件已启用,则 list 仍然只包含一个条目(名称为 my another name,描述为 null)。此配置不会向列表中添加第二个 MyPojo 实例,也不会合并这些项。

当一个 List 在多个配置文件中指定时,仅使用优先级最高的那个(且仅使用那个)。考虑以下示例

  • 属性

  • YAML

my.list[0].name=my name
my.list[0].description=my description
my.list[1].name=another name
my.list[1].description=another description
#---
spring.config.activate.on-profile=dev
my.list[0].name=my another name
my:
  list:
  - name: "my name"
    description: "my description"
  - name: "another name"
    description: "another description"
---
spring:
  config:
    activate:
      on-profile: "dev"
my:
  list:
  - name: "my another name"

在前面的示例中,如果 dev 配置文件处于活动状态,则 MyProperties.list 包含一个 MyPojo 条目(名称为 my another name,描述为 null)。对于 YAML,逗号分隔列表和 YAML 列表都可以用于完全覆盖列表内容。

对于 Map 属性,你可以使用从多个源获取的属性值进行绑定。但是,对于多个源中的相同属性,将使用优先级最高的属性。以下示例从 MyProperties 暴露了一个 Map<String, MyPojo>

  • Java

  • Kotlin

import java.util.LinkedHashMap;
import java.util.Map;

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties("my")
public class MyProperties {

	private final Map<String, MyPojo> map = new LinkedHashMap<>();

	public Map<String, MyPojo> getMap() {
		return this.map;
	}

}
import org.springframework.boot.context.properties.ConfigurationProperties

@ConfigurationProperties("my")
class MyProperties {

	val map: Map<String, MyPojo> = LinkedHashMap()

}

考虑以下配置

  • 属性

  • YAML

my.map.key1.name=my name 1
my.map.key1.description=my description 1
#---
spring.config.activate.on-profile=dev
my.map.key1.name=dev name 1
my.map.key2.name=dev name 2
my.map.key2.description=dev description 2
my:
  map:
    key1:
      name: "my name 1"
      description: "my description 1"
---
spring:
  config:
    activate:
      on-profile: "dev"
my:
  map:
    key1:
      name: "dev name 1"
    key2:
      name: "dev name 2"
      description: "dev description 2"

如果 dev 配置文件未激活,MyProperties.map 包含一个键为 key1 的条目(名称为 my name 1,描述为 my description 1)。但是,如果 dev 配置文件已启用,map 将包含两个条目,键分别为 key1(名称为 dev name 1,描述为 my description 1)和 key2(名称为 dev name 2,描述为 dev description 2)。

前面的合并规则适用于所有属性源的属性,而不仅仅是文件。

属性转换

当 Spring Boot 绑定到 @ConfigurationProperties bean 时,它会尝试将外部应用程序属性强制转换为正确的类型。如果你需要自定义类型转换,可以提供一个 ConversionService bean(bean 名称为 conversionService)或自定义属性编辑器(通过 CustomEditorConfigurer bean)或自定义转换器(带有注解为 @ConfigurationPropertiesBinding 的 bean 定义)。

用于属性转换的 bean 在应用程序生命周期中很早就会被请求,因此请确保限制你的 ConversionService 所使用的依赖项。通常,你在创建时所需的任何依赖项可能尚未完全初始化。

如果你的自定义 ConversionService 不需要用于配置键强制转换,并且只依赖于用 @ConfigurationPropertiesBinding 限定的自定义转换器,你可能需要重命名它。当用 @ConfigurationPropertiesBinding 限定一个 @Bean 方法时,该方法应该是 static 的,以避免“bean 不适合被所有 BeanPostProcessors 处理”的警告。

转换持续时间

Spring Boot 专门支持表示持续时间。如果你暴露一个 Duration 属性,应用程序属性中提供以下格式

  • 一个常规的 long 表示(默认单位是毫秒,除非指定了 @DurationUnit

  • Duration 使用的标准 ISO-8601 格式

  • 一种更易读的格式,值和单位耦合在一起(10s 表示 10 秒)

考虑以下示例

  • Java

  • Kotlin

import java.time.Duration;
import java.time.temporal.ChronoUnit;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.convert.DurationUnit;

@ConfigurationProperties("my")
public class MyProperties {

	@DurationUnit(ChronoUnit.SECONDS)
	private Duration sessionTimeout = Duration.ofSeconds(30);

	private Duration readTimeout = Duration.ofMillis(1000);

	// getters / setters...

	public Duration getSessionTimeout() {
		return this.sessionTimeout;
	}

	public void setSessionTimeout(Duration sessionTimeout) {
		this.sessionTimeout = sessionTimeout;
	}

	public Duration getReadTimeout() {
		return this.readTimeout;
	}

	public void setReadTimeout(Duration readTimeout) {
		this.readTimeout = readTimeout;
	}

}
import org.springframework.boot.context.properties.ConfigurationProperties
import org.springframework.boot.convert.DurationUnit
import java.time.Duration
import java.time.temporal.ChronoUnit

@ConfigurationProperties("my")
class MyProperties {

	@DurationUnit(ChronoUnit.SECONDS)
	var sessionTimeout = Duration.ofSeconds(30)

	var readTimeout = Duration.ofMillis(1000)

}

要指定 30 秒的会话超时,30PT30S30s 都是等效的。500 毫秒的读取超时可以通过以下任何一种形式指定:500PT0.5S500ms

你也可以使用任何支持的单位。它们是

  • ns 表示纳秒

  • us 表示微秒

  • ms 表示毫秒

  • s 表示秒

  • m 表示分钟

  • h 表示小时

  • d 表示天

默认单位是毫秒,可以使用 @DurationUnit 覆盖,如上面的示例所示。

如果你更喜欢使用构造函数绑定,可以暴露相同的属性,如以下示例所示

  • Java

  • Kotlin

import java.time.Duration;
import java.time.temporal.ChronoUnit;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.bind.DefaultValue;
import org.springframework.boot.convert.DurationUnit;

@ConfigurationProperties("my")
public class MyProperties {

	// fields...
	private final Duration sessionTimeout;

	private final Duration readTimeout;

	public MyProperties(@DurationUnit(ChronoUnit.SECONDS) @DefaultValue("30s") Duration sessionTimeout,
			@DefaultValue("1000ms") Duration readTimeout) {
		this.sessionTimeout = sessionTimeout;
		this.readTimeout = readTimeout;
	}

	// getters...

	public Duration getSessionTimeout() {
		return this.sessionTimeout;
	}

	public Duration getReadTimeout() {
		return this.readTimeout;
	}

}
import org.springframework.boot.context.properties.ConfigurationProperties
import org.springframework.boot.context.properties.bind.DefaultValue
import org.springframework.boot.convert.DurationUnit
import java.time.Duration
import java.time.temporal.ChronoUnit

@ConfigurationProperties("my")
class MyProperties(@param:DurationUnit(ChronoUnit.SECONDS) @param:DefaultValue("30s") val sessionTimeout: Duration,
		@param:DefaultValue("1000ms") val readTimeout: Duration)
如果您正在升级 Long 属性,请确保定义单位(使用 @DurationUnit),如果它不是毫秒。这样做可以提供透明的升级路径,同时支持更丰富的格式。

转换周期

除了持续时间,Spring Boot 还可以处理 Period 类型。在应用程序属性中可以使用以下格式

  • 一个普通的 int 表示(使用天作为默认单位,除非指定了 @PeriodUnit

  • Period 使用的标准 ISO-8601 格式

  • 一种更简单的格式,其中值和单位对是耦合的(1y3d 表示 1 年零 3 天)

简单格式支持以下单位

  • y 表示年

  • m 表示月

  • w 表示周

  • d 表示天

Period 类型实际上从不存储周数,它是一个表示“7 天”的快捷方式。

转换数据大小

Spring Framework 有一个 DataSize 值类型,它表示以字节为单位的大小。如果公开 DataSize 属性,则应用程序属性中可以使用以下格式

  • 一个普通的 long 表示(使用字节作为默认单位,除非指定了 @DataSizeUnit

  • 一种更易读的格式,其中值和单位是耦合的(10MB 表示 10 兆字节)

考虑以下示例

  • Java

  • Kotlin

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.convert.DataSizeUnit;
import org.springframework.util.unit.DataSize;
import org.springframework.util.unit.DataUnit;

@ConfigurationProperties("my")
public class MyProperties {

	@DataSizeUnit(DataUnit.MEGABYTES)
	private DataSize bufferSize = DataSize.ofMegabytes(2);

	private DataSize sizeThreshold = DataSize.ofBytes(512);

	// getters/setters...

	public DataSize getBufferSize() {
		return this.bufferSize;
	}

	public void setBufferSize(DataSize bufferSize) {
		this.bufferSize = bufferSize;
	}

	public DataSize getSizeThreshold() {
		return this.sizeThreshold;
	}

	public void setSizeThreshold(DataSize sizeThreshold) {
		this.sizeThreshold = sizeThreshold;
	}

}
import org.springframework.boot.context.properties.ConfigurationProperties
import org.springframework.boot.convert.DataSizeUnit
import org.springframework.util.unit.DataSize
import org.springframework.util.unit.DataUnit

@ConfigurationProperties("my")
class MyProperties {

	@DataSizeUnit(DataUnit.MEGABYTES)
	var bufferSize = DataSize.ofMegabytes(2)

	var sizeThreshold = DataSize.ofBytes(512)

}

要指定 10 兆字节的缓冲区大小,1010MB 是等效的。256 字节的大小阈值可以指定为 256256B

你也可以使用任何支持的单位。它们是

  • B 表示字节

  • KB 表示千字节

  • MB 表示兆字节

  • GB 表示千兆字节

  • TB 表示万亿字节

默认单位是字节,可以使用 @DataSizeUnit 覆盖,如上面的示例所示。

如果你更喜欢使用构造函数绑定,可以暴露相同的属性,如以下示例所示

  • Java

  • Kotlin

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.bind.DefaultValue;
import org.springframework.boot.convert.DataSizeUnit;
import org.springframework.util.unit.DataSize;
import org.springframework.util.unit.DataUnit;

@ConfigurationProperties("my")
public class MyProperties {

	// fields...
	private final DataSize bufferSize;

	private final DataSize sizeThreshold;

	public MyProperties(@DataSizeUnit(DataUnit.MEGABYTES) @DefaultValue("2MB") DataSize bufferSize,
			@DefaultValue("512B") DataSize sizeThreshold) {
		this.bufferSize = bufferSize;
		this.sizeThreshold = sizeThreshold;
	}

	// getters...

	public DataSize getBufferSize() {
		return this.bufferSize;
	}

	public DataSize getSizeThreshold() {
		return this.sizeThreshold;
	}

}
import org.springframework.boot.context.properties.ConfigurationProperties
import org.springframework.boot.context.properties.bind.DefaultValue
import org.springframework.boot.convert.DataSizeUnit
import org.springframework.util.unit.DataSize
import org.springframework.util.unit.DataUnit

@ConfigurationProperties("my")
class MyProperties(@param:DataSizeUnit(DataUnit.MEGABYTES) @param:DefaultValue("2MB") val bufferSize: DataSize,
		@param:DefaultValue("512B") val sizeThreshold: DataSize)
如果您正在升级 Long 属性,请确保定义单位(使用 @DataSizeUnit),如果它不是字节。这样做可以提供透明的升级路径,同时支持更丰富的格式。

转换 Base64 数据

Spring Boot 支持解析已进行 Base64 编码的二进制数据。如果您公开 Resource 属性,可以提供以 base64: 为前缀的 Base64 编码文本作为值,如以下示例所示

  • 属性

  • YAML

my.property=base64:SGVsbG8gV29ybGQ=
my:
  property: base64:SGVsbG8gV29ybGQ=
Resource 属性也可以用来提供资源路径,使其更加通用。

@ConfigurationProperties 验证

只要 @ConfigurationProperties 类使用 Spring 的 @Validated 注解进行注解,Spring Boot 就会尝试验证它们。您可以在配置类上直接使用 JSR-303 jakarta.validation 约束注解。为此,请确保您的类路径中包含兼容的 JSR-303 实现,然后将约束注解添加到您的字段中,如以下示例所示

  • Java

  • Kotlin

import java.net.InetAddress;

import jakarta.validation.constraints.NotNull;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.validation.annotation.Validated;

@ConfigurationProperties("my.service")
@Validated
public class MyProperties {

	@NotNull
	private InetAddress remoteAddress;

	// getters/setters...

	public InetAddress getRemoteAddress() {
		return this.remoteAddress;
	}

	public void setRemoteAddress(InetAddress remoteAddress) {
		this.remoteAddress = remoteAddress;
	}

}
import jakarta.validation.constraints.NotNull
import org.springframework.boot.context.properties.ConfigurationProperties
import org.springframework.validation.annotation.Validated
import java.net.InetAddress

@ConfigurationProperties("my.service")
@Validated
class MyProperties {

	var remoteAddress: @NotNull InetAddress? = null

}
您还可以通过使用 @Validated 注解创建配置属性的 @Bean 方法来触发验证。

为了将验证级联到嵌套属性,关联字段必须使用 @Valid 进行注解。以下示例基于前面的 MyProperties 示例

  • Java

  • Kotlin

import java.net.InetAddress;

import jakarta.validation.Valid;
import jakarta.validation.constraints.NotEmpty;
import jakarta.validation.constraints.NotNull;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.validation.annotation.Validated;

@ConfigurationProperties("my.service")
@Validated
public class MyProperties {

	@NotNull
	private InetAddress remoteAddress;

	@Valid
	private final Security security = new Security();

	// getters/setters...

	public InetAddress getRemoteAddress() {
		return this.remoteAddress;
	}

	public void setRemoteAddress(InetAddress remoteAddress) {
		this.remoteAddress = remoteAddress;
	}

	public Security getSecurity() {
		return this.security;
	}

	public static class Security {

		@NotEmpty
		private String username;

		// getters/setters...

		public String getUsername() {
			return this.username;
		}

		public void setUsername(String username) {
			this.username = username;
		}

	}

}
import jakarta.validation.Valid
import jakarta.validation.constraints.NotEmpty
import jakarta.validation.constraints.NotNull
import org.springframework.boot.context.properties.ConfigurationProperties
import org.springframework.validation.annotation.Validated
import java.net.InetAddress

@ConfigurationProperties("my.service")
@Validated
class MyProperties {

	var remoteAddress: @NotNull InetAddress? = null

	@Valid
	val security = Security()

	class Security {

		@NotEmpty
		var username: String? = null

	}

}

您还可以通过创建名为 configurationPropertiesValidator 的 bean 定义来添加自定义 Spring Validator@Bean 方法应该声明为 static。配置属性验证器在应用程序生命周期的早期创建,将 @Bean 方法声明为静态允许在不实例化 @Configuration 类的情况下创建 bean。这样做可以避免早期实例化可能引起的任何问题。

spring-boot-actuator 模块包含一个暴露所有 @ConfigurationProperties bean 的端点。将您的网络浏览器指向 /actuator/configprops 或使用等效的 JMX 端点。有关详细信息,请参阅生产就绪功能部分。

@ConfigurationProperties 与 @Value

@Value 注解是核心容器功能,它不提供与类型安全配置属性相同的功能。下表总结了 @ConfigurationProperties@Value 支持的功能

功能 @ConfigurationProperties @Value

宽松绑定

有限(参见下面的注释

元数据支持

SpEL 评估

如果您确实想使用 @Value,我们建议您使用规范形式(仅使用小写字母的 kebab-case)引用属性名。这将允许 Spring Boot 使用与 宽松绑定 @ConfigurationProperties 时相同的逻辑。

例如,@Value("${demo.item-price}") 将从 application.properties 文件中获取 demo.item-pricedemo.itemPrice 形式,以及从系统环境中获取 DEMO_ITEMPRICE。如果您改用 @Value("${demo.itemPrice}"),则不会考虑 demo.item-priceDEMO_ITEMPRICE

如果您为自己的组件定义了一组配置键,我们建议您将它们分组到一个使用 @ConfigurationProperties 注解的 POJO 中。这样做将为您提供结构化、类型安全的对象,您可以将其注入到自己的 bean 中。

来自 应用程序属性文件SpEL 表达式在解析这些文件和填充环境时不会被处理。但是,可以在 @Value 中编写 SpEL 表达式。如果应用程序属性文件中的属性值是一个 SpEL 表达式,它将在通过 @Value 消费时进行评估。

© . This site is unofficial and not affiliated with VMware.