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

Document when and how to use brackets when binding to maps 

Closes gh-13506
This commit is contained in:
Madhura Bhave 2018-07-19 16:29:30 -07:00
parent 56235187d0
commit 660d284f45
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1102,6 +1102,24 @@ property name
TIP: We recommend that, when possible, properties are stored in lower-case kebab format, TIP: We recommend that, when possible, properties are stored in lower-case kebab format,
such as `my.property-name=acme`. such as `my.property-name=acme`.
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`:
[source,yaml,indent=0]
----
acme:
map:
"[/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.
[[boot-features-external-config-complex-type-merge]] [[boot-features-external-config-complex-type-merge]]
==== Merging Complex Types ==== Merging Complex Types
When lists are configured in more than one place, overriding works by replacing the entire When lists are configured in more than one place, overriding works by replacing the entire