如何通过环境变量设置Spring Boot属性的名称中带有下划线？

Question

我想在Spring Boot应用程序中设置hibernate.format_sql。我想使用环境变量来设置它。

Spring Boot相当方便地将所有环境变量从foo_bar_baz转换为Spring上下文中称为foo.bar.baz的属性。

如何在Spring Boot中使用环境变量设置目标名称中有下划线的属性？大概hibernate_format_sql会被翻译成hibernate.format.sql？

Answer 1

这是一个老问题，但我会回答它，以防其他人（像我一样）到这里来寻找这些信息。

HIBERNATE_FORMAT_SQL应该能起到这个作用

实际上，“翻译”的不是OS环境变量，而是Spring属性名。

该名称以多种方式进行翻译，并根据可用的环境变量进行查找。例如。“hibernate.format.sql”向上查找为：

1. hibernate.format.sql（原样）
2. hibernate_format_sql（点替换为下划线）
3. hibernate_format_sql（破折号替换为下划线，与您的情况相同）
4. hibernate_format_sql（破折号和点号替换为下划线，与您的情况相同）

则大写相同：

虽然不能使用set或export命令设置名称中带有点的环境变量，但可以使用env命令。我暂缓判断这是不是一个好主意：

env "my.dotted.name=\"a value\"" the-command-you-want-to-run

有关详细信息，请查看SystemEnvironmentPropertySource.java。我链接到一个特定的版本，但您应该确保查看您正在使用的版本。

要在生产环境中解决这类问题,您可以尝试为属性解析代码打开调试日志记录：

logging:
  level:
    org.springframework.core.env: DEBUG

...或通过设置适当的环境变量：）

编辑：我强烈建议您熟悉相关的Spring Boot文档主题:https://docs.Spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config

对于这里注释中比较棘手的示例，例如spring.jpa.properties.hibernate.criteria.Literal_handling_mode，根据您启动应用程序的方式，可能有不同的解决方案。

您可以将该变量设置为JSON，嵌入到环境变量中。

env SPRING_APPLICATION_JSON='{"spring":{"jpa":{"properties":{"hibernate":{"criteria":{"literal_handling_mode":"BIND"}}}}}}' ./gradlew bootRun

简单地按原样设置变量也可能起作用：

env spring.jpa.properties.hibernate.criteria.literal_handling_mode=BIND ./gradlew bootRun

以上两种方法在我的设置中都起作用，因为我能够通过以下方式在运行的Spring Boot应用程序中获得值：

@Value("${spring.jpa.properties.hibernate.criteria.literal_handling_mode}")
private String testSettingThroughEnvVariable;

希望这有帮助！YMMV