Clarify requirements for -parameters and constructor binding

See gh-40157
This commit is contained in:
Stéphane Nicoll 2024-04-03 14:30:23 +02:00 committed by Scott Frederick
parent 9d9ea5cf66
commit ab22b15535

View File

@ -742,7 +742,7 @@ include::code:nonnull/MyProperties[tag=*]
NOTE: To use constructor binding the class must be enabled using `@EnableConfigurationProperties` or configuration property scanning.
You cannot use constructor binding with beans that are created by the regular Spring mechanisms (for example `@Component` beans, beans created by using `@Bean` methods or beans loaded by using `@Import`)
NOTE: To use constructor binding in a native image the class must be compiled with `-parameters`.
NOTE: To use constructor binding the class must be compiled with `-parameters`.
This will happen automatically if you use Spring Boot's Gradle plugin or if you use Maven and `spring-boot-starter-parent`.
NOTE: The use of `java.util.Optional` with `@ConfigurationProperties` is not recommended as it is primarily intended for use as a return type.