Require annotation signal for constructor binding
Update `@ConfigurationProperties` constructor binding support to only apply when a `@ConstructorBinding` annotation is present on either the type or the specific constructor to use. Prior to this commit we didn't have a good way to tell when constructor binding should be used vs regular autowiring. For convenience, an `@ImmutableConfigurationProperties` meta-annotation has also been added which is composed of `@ConfigurationProperties` and `@ConstructorBinding`. Closes gh-18469pull/18477/head
Phillip Webb
5 years ago
parent
ecf751e7eb
commit
e41c5a4327
@ -0,0 +1,40 @@
|
||||
/*
|
||||
* Copyright 2012-2019 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.boot.context.properties;
|
||||
|
||||
import java.lang.annotation.Documented;
|
||||
import java.lang.annotation.ElementType;
|
||||
import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
/**
|
||||
* Annotation that can be used to indicate that configuration properties should be bound
|
||||
* using constructor arguments rather than by calling setters. Can be added at the type
|
||||
* level (if there is an unambiguous constructor) or on the actual constructor to use.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
* @since 2.2.0
|
||||
* @see ConfigurationProperties
|
||||
* @see ImmutableConfigurationProperties
|
||||
*/
|
||||
@Target({ ElementType.TYPE, ElementType.CONSTRUCTOR })
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@Documented
|
||||
public @interface ConstructorBinding {
|
||||
|
||||
}
|
||||
@ -0,0 +1,60 @@
|
||||
/*
|
||||
* Copyright 2012-2019 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.boot.context.properties;
|
||||
|
||||
import java.lang.annotation.Documented;
|
||||
import java.lang.annotation.ElementType;
|
||||
import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
import org.springframework.core.annotation.AliasFor;
|
||||
|
||||
/**
|
||||
* A convenience annotation that can be used for immutable
|
||||
* {@link ConfigurationProperties @ConfigurationProperties} that use
|
||||
* {@link ConstructorBinding @ConstructorBinding}.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
* @since 2.2.0
|
||||
*/
|
||||
@Target(ElementType.TYPE)
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
@Documented
|
||||
@ConfigurationProperties
|
||||
@ConstructorBinding
|
||||
public @interface ImmutableConfigurationProperties {
|
||||
|
||||
/**
|
||||
* The name prefix of the properties that are valid to bind to this object. Synonym
|
||||
* for {@link #prefix()}. A valid prefix is defined by one or more words separated
|
||||
* with dots (e.g. {@code "acme.system.feature"}).
|
||||
* @return the name prefix of the properties to bind
|
||||
*/
|
||||
@AliasFor(annotation = ConfigurationProperties.class)
|
||||
String value() default "";
|
||||
|
||||
/**
|
||||
* The name prefix of the properties that are valid to bind to this object. Synonym
|
||||
* for {@link #value()}. A valid prefix is defined by one or more words separated with
|
||||
* dots (e.g. {@code "acme.system.feature"}).
|
||||
* @return the name prefix of the properties to bind
|
||||
*/
|
||||
@AliasFor(annotation = ConfigurationProperties.class)
|
||||
String prefix() default "";
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue