root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch '2.4.x' 

Closes gh-25065
This commit is contained in:
Phillip Webb 2021-01-30 17:46:25 -08:00
parent 99d400f302 9ac5151932
commit d6eb1eb5ae
1 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1489,9 +1489,10 @@ TIP: We recommend that, when possible, properties are stored in lower-case kebab
[[boot-features-external-config-relaxed-binding-maps]]
===== Binding Maps
When binding to `Map` properties, if the `key` contains anything other than lowercase alpha-numeric characters or `-`, you need to use the bracket notation so that the original value is preserved.
If the key is not surrounded by `[]`, any characters that are not alpha-numeric or `-` are removed.
For example, consider binding the following properties to a `Map`:
When binding to `Map` properties you may need to use a special bracket notation so that the original `key` value is preserved.
If the key is not surrounded by `[]`, any characters that are not alpha-numeric, `-` or `.` are removed.
For example, consider binding the following properties to a `Map<String,String>`:
[source,properties,indent=0,role="primary"]
@ -1507,15 +1508,19 @@ For example, consider binding the following properties to a `Map`:
----
acme:
map:
"[/key1]": value1
"[/key2]": value2
"/key3": value3
"[/key1]": "value1"
"[/key2]": "value2"
"/key3": "value3"
----
The properties above will bind to a `Map` with `/key1`, `/key2` and `key3` as the keys in the map.
NOTE: For YAML files, the brackets need to be surrounded by quotes for the keys to be parsed properly.
The properties above will bind to a `Map` with `/key1`, `/key2` and `key3` as the keys in the map.
The slash has been removed from `key3` because it wasn't surrounded by square brackets.
You may also occasionally need to use the bracket notation if your `key` contains a `.` and you are binding to non-scalar value.
For example, binding `a.b=c` to `Map<String, Object>` will return a Map with the entry `{"a"={"b"="c"}}` where as `[a.b]=c` will return a Map with the entry `{"a.b"="c"}`.
[[boot-features-external-config-relaxed-binding-from-environment-variables]]