springboot外部配置

牧歌2023/7/3...大约 3 分钟

外部配置

Spring Boot 允许您将配置外部化，以便您可以在不同的环境中使用相同的应用程序代码。您可以使用各种外部配置源，包括 Java 属性文件、YAML 文件、环境变量和命令行参数。

属性值可以通过使用注解直接注入到你的 bean 中@Value，通过 Spring 的抽象Environment访问，或者通过.@ConfigurationProperties

Spring Boot 使用一种非常特殊的PropertySource顺序，旨在允许合理地覆盖值。属性按以下顺序考虑（较低项目的值覆盖较早的项目）：

默认属性（由设置SpringApplication.setDefalutProperties指定
@PropertySource注解在你的@Configuration类。请注意，Application Context刷新之前，这样的属性资源不会添加到Environment。对配置一些属性来说太晚（例如：logging.*和spring.main.*）他们读取在refresh之前
配置数据（例如：application.properties文件）
RandomValuePropertySource，仅在random.*中的属性
系统环境变量
Java系统属性（System.getProperties()）
来自java:comp/env下的 JNDI 属性
ServletContext初始化参数
ServletConfig初始化参数
属性来自SPRING_APPLICATION_JSON（嵌入的内联 JSON 在环境变量或系统属性）
命令行参数
properties属性在你的tests，可用于在@SpringBootTest 和应用程序的特定部分的测试注解
@TestPropertySource注解在你的tests
当devtools被激活时，Devtools全局设置属性在$HOME/.config/spring-boot目录

配置数据文件可以考虑如下顺序：

默认SpringApplication转换以--开头的命令行操作参数（--server.port=9000）为一个property并把它们添加到Spring的Environment

如上所述，命令行参数配置属性优先级高于以文件为基础的属性

如果不想使用命令行配置属性，可以通过SpringApplication.setAddCommandLineProperties(false)关闭他们

环境变量和系统属性通常有限制，一些属性名不能被使用。为了解决这个，SpringBoot 允许你使用编写一单个的 JSON 结构块的属性

当你的应用启动，任何spring.application.json或SPRING_APPLICATION_JSON属性将解析并添加到Environment

举例：

SPRING_APPLICATION_JSON属性能通过shell命令行提供一个环境变量

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

这样最终会在Spring环境中my.name=test使用

相同的 JSON 也能通过系统属性提供

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

或者能使用命令行参数提供

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

如果你部署一个经典的应用服务，你也可以使用 JNDI 变量名java:comp/env/spring.application.json

Spring Boot将自动发现和加载application.properties和application.yaml文件通过如下位置在你的应用启动时：

这个列表按优先级排序（后面的值覆盖前面的值）文档（从加载文件）作为PropertySources到Spring的Environment