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

Relax @ConstructorBinding member class requirement

Browse Source 
Update `@ConfigurationProperties` so that `@ConstructorBinding` classes
no longer need to repeat the annotation for their members.

Closes gh-18481
This commit is contained in:
Phillip Webb
2019-10-02 14:59:37 -07:00
parent e6bb7a0a6f
commit 386c0a60a7
6 changed files with 174 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -881,7 +881,6 @@ The example in the previous section can be rewritten in an immutable fashion as
private final List<String> roles;
@ConstructorBinding
public Security(String username, String password,
@DefaultValue("USER") List<String> roles) {
this.username = username;
@@ -903,16 +902,16 @@ The example in the previous section can be rewritten in an immutable fashion as
In this setup, the `@ImmutableConfigurationProperties` annotation is used to indicate that constructor binding should be used.
This means that the binder will expect to find a constructor with the parameters that you wish to have bound.
Nested classes that also require constructor binding (such as `Security` in the example above) should use the `@ConstructorBinding` annotation.
Nested members of a `@ImmutableConfigurationProperties` class (such as `Security` in the example above) will also be bound via their constructor.
Default values can be specified using `@DefaultValue` and the same conversion service will be applied to coerce the `String` value to the target type of a missing property.
TIP: You can also use `@ConstructorBinding` on the actual constructor that should be bound.
This is required if you have more than one constructor for your class.
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 (e.g. `@Component` beans, beans created via `@Bean` methods or beans loaded using `@Import`)
TIP: `@ImmutableConfigurationProperties` is actually a meta-annotation composed of `@ConfigurationProperties` and `@ConstructorBinding`.
If you have more than one constructor for your class you can also use `@ConstructorBinding` directly on actual constructor that should be bound.
[[boot-features-external-config-enabling]]