Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document how Map properties are bound from environment variables

Browse Source 
Closes gh-40936
This commit is contained in:
Moritz Halbritter
2024-10-14 15:12:00 +02:00
parent 1ad959215c
commit 0a3418cd40
5 changed files with 66 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/external-config.adoc
View File

@@ -943,6 +943,24 @@ For example, the configuration property `my.service[0].other` would use an envir
Support for binding from environment variables is applied to the `systemEnvironment` property source and to any additional property source whose name ends with `-systemEnvironment`.
[[features.external-config.typesafe-configuration-properties.relaxed-binding.maps-from-environment-variables]]
===== Binding Maps from environment variables
When Spring Boot binds an environment variable to a property class, it lowercases the environment variable name before binding.
Most of the time this detail isn't important, except when binding to `Map` properties.
The keys in the `Map` are always in lowercase, as seen in the following example:
include::code:MyMapsProperties[]
When setting `MY_PROPS_VALUES_KEY=value`, the `values` `Map` contains a `{"key"="value"}` entry.
Only the environment variable *name* is lower-cased, not the value.
When setting `MY_PROPS_VALUES_KEY=VALUE`, the `values` `Map` contains a `{"key"="VALUE"}` entry.
[[features.external-config.typesafe-configuration-properties.relaxed-binding.caching]]
===== Caching
Relaxed binding uses a cache to improve performance. By default, this caching is only applied to immutable property sources.

2
spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/logging.adoc
View File

@@ -218,7 +218,7 @@ It is also possible to set logging levels using environment variables.
For example, `LOGGING_LEVEL_ORG_SPRINGFRAMEWORK_WEB=DEBUG` will set `org.springframework.web` to `DEBUG`.
NOTE: The above approach will only work for package level logging.
Since relaxed binding always converts environment variables to lowercase, it is not possible to configure logging for an individual class in this way.
Since relaxed binding <<features#features.external-config.typesafe-configuration-properties.relaxed-binding.maps-from-environment-variables, always converts environment variables to lowercase>>, it is not possible to configure logging for an individual class in this way.
If you need to configure logging for a class, you can use <<features#features.external-config.application-json, the `SPRING_APPLICATION_JSON`>> variable.

4
spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/ssl.adoc
View File

@@ -43,6 +43,8 @@ When used to secure a client-side connection, a `truststore` is typically config
See {spring-boot-autoconfigure-module-code}/ssl/JksSslBundleProperties.java[JksSslBundleProperties] for the full set of supported properties.
NOTE: If you're using environment variables to configure the bundle, the name of the bundle is <<features#features.external-config.typesafe-configuration-properties.relaxed-binding.maps-from-environment-variables, always converted to lowercase>>.
[[features.ssl.pem]]
@@ -106,6 +108,8 @@ The following example shows how a truststore certificate can be defined:
See {spring-boot-autoconfigure-module-code}/ssl/PemSslBundleProperties.java[PemSslBundleProperties] for the full set of supported properties.
NOTE: If you're using environment variables to configure the bundle, the name of the bundle is <<features#features.external-config.typesafe-configuration-properties.relaxed-binding.maps-from-environment-variables, always converted to lowercase>>.
[[features.ssl.applying]]