24.外化配置

Spring Boot允许将配置外部化（externalize），这样你就能够在不同的环境下使用相同的代码。你可以使用properties文件，YAML文件，环境变量和命令行参数来外部化配置。使用@Value注解，可以直接将属性值注入到beans中，然后通过Spring的Environment抽象或通过@ConfigurationProperties绑定到结构化对象来访问。

Spring Boot设计了一个非常特别的PropertySource顺序，以允许对属性值进行合理的覆盖，属性会以如下的顺序进行设值：

home目录下的devtools全局设置属性（~/.spring-boot-devtools.properties，如果devtools激活）。
测试用例上的@TestPropertySource注解。
测试用例上的@SpringBootTest#properties注解。
命令行参数
来自SPRING_APPLICATION_JSON的属性（环境变量或系统属性中内嵌的内联JSON）。
ServletConfig初始化参数。
ServletContext初始化参数。
来自于java:comp/env的JNDI属性。
Java系统属性（System.getProperties()）。
操作系统环境变量。
RandomValuePropertySource，只包含random.*中的属性。
没有打进jar包的Profile-specific应用属性（application-{profile}.properties和YAML变量）。
打进jar包中的Profile-specific应用属性（application-{profile}.properties和YAML变量）。
没有打进jar包的应用配置（application.properties和YAML变量）。
打进jar包中的应用配置（application.properties和YAML变量）。
@Configuration类上的@PropertySource注解。
默认属性（通过设置SpringApplication.setDefaultProperties指定）。

下面是具体的示例，假设你开发一个使用name属性的@Component：

import org.springframework.stereotype.*
import org.springframework.beans.factory.annotation.*

@Component
public class MyBean {
    @Value("${name}")
    private String name;
    // ...
}

你可以将一个application.properties放到应用的classpath下，为name提供一个合适的默认属性值。当在新的环境中运行时，可以在jar包外提供一个application.properties覆盖name属性。对于一次性的测试，你可以使用特定的命令行开关启动应用（比如，java -jar app.jar --name="Spring"）。

注 SPRING_APPLICATION_JSON属性可以通过命令行的环境变量设置，例如，在一个UNIX shell中可以这样：

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

在之前的例子里，如果是Spring Environment，你可以以acme.name=test结尾；如果在一个系统属性中，可以提供作为spring.application.json的JSON字符串：

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

或命令行参数：

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

或作为一个JNDI变量java:comp/env/spring.application.json。

上一页23.10. Admin特性下一页24.1. 配置随机值

最后更新于5年前