|
对于最新稳定版本，请使用 Spring Boot 4.0.4！ |
属性与配置
本节包含有关设置和读取属性及配置项，以及它们与 Spring Boot 应用程序的交互等内容。
在构建时自动展开属性
与其硬编码一些已在项目构建配置中指定的属性，不如利用现有的构建配置自动展开这些属性。 这在 Maven 和 Gradle 中均可实现。
使用 Maven 自动扩展属性
你可以通过使用资源过滤（resource filtering）在 Maven 项目中自动展开属性。
如果你使用了 spring-boot-starter-parent，就可以使用 @..@ 占位符来引用你的 Maven “项目属性”，如下例所示：
-
Properties
-
YAML
app:
encoding: "@project.build.sourceEncoding@"
java:
version: "@java.version@"仅生产环境的配置会以这种方式进行过滤（换句话说，不会对 src/test/resources 应用任何过滤）。 |
如果启用 addResources 标志，spring-boot:run 目标可以直接将 src/main/resources 添加到类路径中（用于热重载）。
这样做会绕过资源过滤以及此功能。
作为替代方案，您可以使用 exec:java 目标，或自定义插件的配置。
更多详细信息，请参阅插件使用页面。 |
如果您不使用 starter parent，则需要在您的 <build/> 文件的 pom.xml 元素内包含以下元素：
<resources>
<resource>
<directory>src/main/resources</directory>
<filtering>true</filtering>
</resource>
</resources>你还需要在 <plugins/> 内部包含以下元素：
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>2.7</version>
<configuration>
<delimiters>
<delimiter>@</delimiter>
</delimiters>
<useDefaultDelimiters>false</useDefaultDelimiters>
</configuration>
</plugin>如果在配置中使用标准的 Spring 占位符（例如 useDefaultDelimiters），${placeholder} 属性就非常重要。
如果该属性未设置为 false，这些占位符可能会在构建过程中被展开。 |
使用 Gradle 自动扩展属性
您可以通过配置 Java 插件的 processResources 任务来自动展开 Gradle 项目中的属性，如下例所示：
tasks.named('processResources') {
expand(project.properties)
}然后，您可以使用占位符来引用 Gradle 项目的属性，如下例所示：
-
Properties
-
YAML
app.name=${name}
app.description=${description}app:
name: "${name}"
description: "${description}"Gradle 的 expand 方法使用 Groovy 的 SimpleTemplateEngine，该引擎会转换 ${..} 标记。
${..} 样式与 Spring 自身的属性占位符机制存在冲突。
若要将 Spring 属性占位符与自动展开功能一起使用，请按如下方式转义 Spring 属性占位符：\${..}。 |
外部化 SpringApplication 的配置
一个 SpringApplication 拥有 Bean 属性设置器，因此您可以在创建应用程序时使用其 Java API 来修改其行为。
或者，您可以通过在 spring.main.* 中设置属性来外部化配置。
例如，在 application.properties 中，您可能会有以下设置：
-
Properties
-
YAML
spring.main.web-application-type=none
spring.main.banner-mode=offspring:
main:
web-application-type: "none"
banner-mode: "off"随后，Spring Boot 的启动横幅在启动时不会打印，并且应用程序也不会启动内嵌的 Web 服务器。
外部配置中定义的属性会覆盖并替换通过 Java API 指定的值，但主要来源（primary sources）除外。
主要来源是指提供给 SpringApplication 构造函数的来源：
-
Java
-
Kotlin
import org.springframework.boot.Banner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class MyApplication {
public static void main(String[] args) {
SpringApplication application = new SpringApplication(MyApplication.class);
application.setBannerMode(Banner.Mode.OFF);
application.run(args);
}
}import org.springframework.boot.Banner
import org.springframework.boot.SpringApplication
import org.springframework.boot.autoconfigure.SpringBootApplication
@SpringBootApplication
object MyApplication {
@JvmStatic
fun main(args: Array<String>) {
val application = SpringApplication(MyApplication::class.java)
application.setBannerMode(Banner.Mode.OFF)
application.run(*args)
}
}或者到 sources(…) 方法，属于一个 SpringApplicationBuilder：
-
Java
-
Kotlin
import org.springframework.boot.Banner;
import org.springframework.boot.builder.SpringApplicationBuilder;
public class MyApplication {
public static void main(String[] args) {
new SpringApplicationBuilder()
.bannerMode(Banner.Mode.OFF)
.sources(MyApplication.class)
.run(args);
}
}import org.springframework.boot.Banner
import org.springframework.boot.builder.SpringApplicationBuilder
object MyApplication {
@JvmStatic
fun main(args: Array<String>) {
SpringApplicationBuilder()
.bannerMode(Banner.Mode.OFF)
.sources(MyApplication::class.java)
.run(*args)
}
}根据上面的示例，如果我们有以下配置：
-
Properties
-
YAML
spring.main.sources=com.example.MyDatabaseConfig,com.example.MyJmsConfig
spring.main.banner-mode=consolespring:
main:
sources: "com.example.MyDatabaseConfig,com.example.MyJmsConfig"
banner-mode: "console"实际应用程序将显示横幅（由配置覆盖），并使用三个来源来获取 ApplicationContext。
应用程序来源包括：
-
MyApplication（来自代码） -
MyDatabaseConfig（来自外部配置） -
MyJmsConfig（来自外部配置）
更改应用程序外部属性的位置
默认情况下，来自不同源的属性会按定义的顺序添加到 Spring Environment 中（确切顺序请参阅
您还可以提供以下系统属性（或环境变量）来更改行为：
-
spring.config.name（SPRING_CONFIG_NAME）：默认以application作为文件名的根。 -
spring.config.location(SPRING_CONFIG_LOCATION): 要加载的文件（例如类路径资源或 URL）。 为此文档设置了一个独立的Environment属性源，它可以被系统属性、环境变量或命令行覆盖。
无论你在环境中设置什么，Spring Boot 始终会按照上述方式加载 application.properties 文件。
默认情况下，如果使用 YAML，则扩展名为 ‘.yaml’ 和 ‘.yml’ 的文件也会被添加到列表中。
如果你想获取有关正在加载的文件的详细信息，可以将 xref page 的日志级别设置为 trace。 |
使用“短”命令行参数
有些人喜欢在命令行中使用（例如）--port=9000 而不是 --server.port=9000 来设置配置属性。
你可以通过在 application.properties 中使用占位符来启用此行为，如下例所示：
-
Properties
-
YAML
server.port=${port:8080}server:
port: "${port:8080}"如果你继承了 spring-boot-starter-parent POM，maven-resources-plugins 的默认过滤器标记已从 ${*} 更改为 @（即使用 @maven.token@ 而不是 ${maven.token}），以避免与 Spring 风格的占位符发生冲突。
如果你已为 application.properties 直接启用了 Maven 过滤，你可能也想将默认的过滤器标记更改为使用其他分隔符。 |
在这种特定情况下，端口绑定在如 Heroku 或 Cloud Foundry 等 PaaS 环境中有效。
在这两个平台上，PORT 环境变量会自动设置，Spring 可以绑定到 Environment 属性的大写同义词。 |
使用 YAML 配置外部属性
YAML 是 JSON 的超集，因此它是一种便捷的语法，可用于以分层格式存储外部属性，如下例所示：
spring:
application:
name: "cruncher"
datasource:
driver-class-name: "com.mysql.jdbc.Driver"
url: "jdbc:mysql://localhost/test"
server:
port: 9000创建一个名为 application.yaml 的文件，并将其放置在类路径的根目录下。
然后将 snakeyaml 添加到您的依赖项中（Maven 坐标为 org.yaml:snakeyaml，如果您使用 spring-boot-starter，则已包含）。
YAML 文件会被解析为一个 Java Map<String,Object>（类似于 JSON 对象），Spring Boot 会将该映射展平为单层结构，并使用句点分隔的键，这与许多人在 Java 中使用 Properties 文件的习惯一致。
前面的 YAML 示例对应于以下 application.properties 文件：
spring.application.name=cruncher
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost/test
server.port=9000有关 YAML 的更多信息，请参阅“Spring Boot 功能”部分中的使用 YAML。
设置活跃的 Spring 配置文件
Spring Environment 为此提供了 API，但您通常可以设置系统属性（spring.profiles.active）或操作系统环境变量（SPRING_PROFILES_ACTIVE）。
此外，您可以使用 -D 参数启动应用程序（请记住将其放在主类或 JAR 归档文件之前），如下所示：
$ java -jar -Dspring.profiles.active=production demo-0.0.1-SNAPSHOT.jar在 Spring Boot 中，你也可以在 application.properties 中设置激活的配置文件，如下例所示：
-
Properties
-
YAML
spring.profiles.active=productionspring:
profiles:
active: "production"以这种方式设置的值会被系统属性或环境变量的设置所覆盖，但不会被 SpringApplicationBuilder.profiles() 方法覆盖。
因此，可以使用后者的 Java API 来扩充配置文件，而无需更改默认值。
有关更多信息，请参见“Spring Boot 功能”部分中的配置文件（Profiles）。
设置默认配置文件名称
默认配置文件（default profile）是指在没有任何配置文件处于激活状态时被启用的配置文件。
默认情况下，默认配置文件的名称为 default，但可以通过系统属性（spring.profiles.default）或操作系统环境变量（SPRING_PROFILES_DEFAULT）进行更改。
在 Spring Boot 中，你也可以在 application.properties 中设置默认的配置文件名称，如下例所示：
-
Properties
-
YAML
spring.profiles.default=devspring:
profiles:
default: "dev"有关更多信息，请参见“Spring Boot 功能”部分中的配置文件（Profiles）。
根据环境更改配置
Spring Boot 支持多文档的 YAML 和 Properties 文件（详见 使用多文档文件），这些文件可以根据激活的配置文件（profiles）有条件地启用。
如果一个文档包含 spring.config.activate.on-profile 键，那么其 profiles 值（一个以逗号分隔的 profile 列表或 profile 表达式）将被传入 Spring 的 Environment.acceptsProfiles() 方法。
如果该 profile 表达式匹配，则该文档将被包含在最终的合并结果中（否则将被排除），如下例所示：
-
Properties
-
YAML
server.port=9000
#---
spring.config.activate.on-profile=development
server.port=9001
#---
spring.config.activate.on-profile=production
server.port=0server:
port: 9000
---
spring:
config:
activate:
on-profile: "development"
server:
port: 9001
---
spring:
config:
activate:
on-profile: "production"
server:
port: 0在前面的示例中，默认端口为 9000。 但是，如果名为“development”的 Spring 配置文件处于激活状态，则端口为 9001。 如果“production”处于激活状态，则端口为 0。
| 文档按照它们被遇到的顺序进行合并。 后面的值会覆盖前面的值。 |
探索外部属性的内置选项
Spring Boot 在运行时将来自 application.properties（或 YAML 文件及其他位置）的外部属性绑定到应用程序中。
由于支持的属性可能来自类路径上的额外 JAR 文件，因此无法（从技术上讲也不可能）在单一位置提供一份详尽无遗的所有受支持属性的列表。
运行中的具备 Actuator 功能的应用程序拥有一个 configprops 端点，该端点通过 @ConfigurationProperties 显示所有已绑定和可绑定的属性。
附录包含一个带有 Spring Boot 支持的最常用属性列表的 application.properties 示例。
权威列表源自对源代码中 @ConfigurationProperties 和 @Value 注解以及偶尔使用的 Binder 的搜索。
有关加载属性的确切顺序的更多信息，请参阅 外部化配置。