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

Rename @ImportConfigurationPropertiesBean 

Rename `@ImportConfigurationPropertiesBean` to
`@ConfigurationPropertiesImport`.

Closes gh-23172
This commit is contained in:
Phillip Webb 2020-09-14 19:30:24 -07:00
parent 433b357423
commit c857a743a0
18 changed files with 97 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1227,7 +1227,7 @@ Spring Boot provides infrastructure to bind `@ConfigurationProperties` types and
You can either enable configuration properties on a class-by-class basis or enable configuration property scanning that works in a similar manner to component scanning.
Sometimes, classes annotated with `@ConfigurationProperties` might not be suitable for scanning, for example, if you're developing your own auto-configuration or you want to enable them conditionally.
In these cases, specify the list of types to process using the `@EnableConfigurationProperties` or `@ImportConfigurationPropertiesBean` annotations.
In these cases, specify the list of types to process using the `@EnableConfigurationProperties` or `@ConfigurationPropertiesImport` annotations.
This can be done on any `@Configuration` class, as shown in the following example:
[source,java,indent=0]
@ -1253,7 +1253,7 @@ If you want to define specific packages to scan, you can do so as shown in the f
[NOTE]
====
When the `@ConfigurationProperties` bean is registered using configuration property scanning or via `@EnableConfigurationProperties` or `@ImportConfigurationPropertiesBean`, the bean has a conventional name: `<prefix>-<fqn>`, where `<prefix>` is the environment key prefix specified in the `@ConfigurationProperties` annotation and `<fqn>` is the fully qualified name of the bean.
When the `@ConfigurationProperties` bean is registered using configuration property scanning or via `@EnableConfigurationProperties` or `@ConfigurationPropertiesImport`, the bean has a conventional name: `<prefix>-<fqn>`, where `<prefix>` is the environment key prefix specified in the `@ConfigurationProperties` annotation and `<fqn>` is the fully qualified name of the bean.
If the annotation does not provide any prefix, only the fully qualified name of the bean is used.
The bean name in the example above is `acme-com.example.AcmeProperties`.
@ -1333,18 +1333,18 @@ To configure a bean from the `Environment` properties, add `@ConfigurationProper
Any JavaBean property defined with the `another` prefix is mapped onto that `ExampleItem` bean in manner similar to the preceding `AcmeProperties` example.
If you want to use constructor binding with a third-party class, you can't use a `@Bean` method since Spring will need to create the object instance.
For those situations, you can use an `@ImportConfigurationPropertiesBean` annotation on your `@Configuration` or `@SpringBootApplication` class.
For those situations, you can use an `@ConfigurationPropertiesImport` annotation on your `@Configuration` or `@SpringBootApplication` class.
[source,java,indent=0]
----
@SpringBootApplication
@ImportConfigurationPropertiesBean(type = ExampleItem.class, prefix = "another")
@ConfigurationPropertiesImport(type = ExampleItem.class, prefix = "another")
public class MyApp {
...
}
----
TIP: `@ImportConfigurationPropertiesBean` also works for JavaBean bindings as long as the type has a single no-arg constructor
TIP: `@ConfigurationPropertiesImport` also works for JavaBean bindings as long as the type has a single no-arg constructor

48
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/ConfigurationMetadataAnnotationProcessor.java
View File

@ -80,9 +80,9 @@ public class ConfigurationMetadataAnnotationProcessor extends AbstractProcessor
static final String NAME_ANNOTATION = "org.springframework.boot.context.properties.bind.Name";
static final String IMPORT_CONFIGURATION_PROPERTIES_BEAN_ANNOATION = "org.springframework.boot.context.properties.ImportConfigurationPropertiesBean";
static final String CONFIGURATION_PROPERTIES_IMPORT_ANNOATION = "org.springframework.boot.context.properties.ConfigurationPropertiesImport";
static final String IMPORT_CONFIGURATION_PROPERTIES_BEANS_ANNOATION = "org.springframework.boot.context.properties.ImportConfigurationPropertiesBeans";
static final String CONFIGURATION_PROPERTIES_IMPORTS_ANNOATION = "org.springframework.boot.context.properties.ConfigurationPropertiesImports";
private static final Set<String> SUPPORTED_OPTIONS = Collections
.unmodifiableSet(Collections.singleton(ADDITIONAL_METADATA_LOCATIONS_OPTION));
@ -125,12 +125,12 @@ public class ConfigurationMetadataAnnotationProcessor extends AbstractProcessor
return NAME_ANNOTATION;
}
protected String importConfigurationPropertiesBeanAnnotation() {
return IMPORT_CONFIGURATION_PROPERTIES_BEAN_ANNOATION;
protected String configurationPropertiesImportAnnotation() {
return CONFIGURATION_PROPERTIES_IMPORT_ANNOATION;
}
protected String importConfigurationPropertiesBeansAnnotation() {
return IMPORT_CONFIGURATION_PROPERTIES_BEANS_ANNOATION;
protected String configurationPropertiesImportsAnnotation() {
return CONFIGURATION_PROPERTIES_IMPORTS_ANNOATION;
}
@Override
@ -151,8 +151,8 @@ public class ConfigurationMetadataAnnotationProcessor extends AbstractProcessor
this.metadataEnv = new MetadataGenerationEnvironment(env, configurationPropertiesAnnotation(),
nestedConfigurationPropertyAnnotation(), deprecatedConfigurationPropertyAnnotation(),
constructorBindingAnnotation(), defaultValueAnnotation(), endpointAnnotation(),
readOperationAnnotation(), nameAnnotation(), importConfigurationPropertiesBeanAnnotation(),
importConfigurationPropertiesBeansAnnotation());
readOperationAnnotation(), nameAnnotation(), configurationPropertiesImportAnnotation(),
configurationPropertiesImportsAnnotation());
}
@Override
@ -160,7 +160,7 @@ public class ConfigurationMetadataAnnotationProcessor extends AbstractProcessor
this.metadataCollector.processing(roundEnv);
processConfigurationProperties(roundEnv);
processEndpoint(roundEnv);
processImportConfigurationPropertiesBean(roundEnv);
processConfigurationPropertiesImport(roundEnv);
if (roundEnv.processingOver()) {
try {
writeMetaData();
@ -188,22 +188,22 @@ public class ConfigurationMetadataAnnotationProcessor extends AbstractProcessor
}
}
private void processImportConfigurationPropertiesBean(RoundEnvironment roundEnv) {
TypeElement importConfigurationPropertiesBeanType = this.metadataEnv
.getImportConfigurationPropertiesBeanAnnotationElement();
TypeElement importConfigurationPropertiesBeansType = this.metadataEnv
.getImportConfigurationPropertiesBeansAnnotationElement();
if (importConfigurationPropertiesBeanType == null && importConfigurationPropertiesBeansType == null) {
private void processConfigurationPropertiesImport(RoundEnvironment roundEnv) {
TypeElement configurationPropertiesImportType = this.metadataEnv
.getConfigurationPropertiesImportAnnotationElement();
TypeElement configurationPropertiesImportsType = this.metadataEnv
.getConfigurationPropertiesImportsAnnotationElement();
if (configurationPropertiesImportType == null && configurationPropertiesImportsType == null) {
return;
}
Set<Element> elements = new LinkedHashSet<>();
if (importConfigurationPropertiesBeanType != null) {
elements.addAll(roundEnv.getElementsAnnotatedWith(importConfigurationPropertiesBeanType));
if (configurationPropertiesImportType != null) {
elements.addAll(roundEnv.getElementsAnnotatedWith(configurationPropertiesImportType));
}
if (importConfigurationPropertiesBeansType != null) {
elements.addAll(roundEnv.getElementsAnnotatedWith(importConfigurationPropertiesBeansType));
if (configurationPropertiesImportsType != null) {
elements.addAll(roundEnv.getElementsAnnotatedWith(configurationPropertiesImportsType));
}
elements.forEach(this::processImportConfigurationPropertiesBean);
elements.forEach(this::processConfigurationPropertiesImport);
}
private Map<Element, List<Element>> getElementsAnnotatedOrMetaAnnotatedWith(RoundEnvironment roundEnv,
@ -314,13 +314,13 @@ public class ConfigurationMetadataAnnotationProcessor extends AbstractProcessor
}
}
private void processImportConfigurationPropertiesBean(Element element) {
this.metadataEnv.getImportConfigurationPropertiesBeanAnnotations(element)
.forEach(this::processImportConfigurationPropertiesBean);
private void processConfigurationPropertiesImport(Element element) {
this.metadataEnv.getConfigurationPropertiesImportAnnotations(element)
.forEach(this::processConfigurationPropertiesImport);
}
@SuppressWarnings("unchecked")
private void processImportConfigurationPropertiesBean(AnnotationMirror annotation) {
private void processConfigurationPropertiesImport(AnnotationMirror annotation) {
String prefix = getPrefix(annotation);
List<TypeMirror> types = (List<TypeMirror>) this.metadataEnv.getAnnotationElementValues(annotation).get("type");
for (TypeMirror type : types) {

26
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/MetadataGenerationEnvironment.java
View File

@ -97,15 +97,15 @@ class MetadataGenerationEnvironment {
private final String nameAnnotation;
private final String importConfigurationPropertiesBeanAnnotation;
private final String configurationPropertiesImportAnnotation;
private final String importConfigurationPropertiesBeansAnnotation;
private final String configurationPropertiesImportsAnnotation;
MetadataGenerationEnvironment(ProcessingEnvironment environment, String configurationPropertiesAnnotation,
String nestedConfigurationPropertyAnnotation, String deprecatedConfigurationPropertyAnnotation,
String constructorBindingAnnotation, String defaultValueAnnotation, String endpointAnnotation,
String readOperationAnnotation, String nameAnnotation, String importConfigurationPropertiesBeanAnnotation,
String importConfigurationPropertiesBeansAnnotation) {
String readOperationAnnotation, String nameAnnotation, String configurationPropertiesImportAnnotation,
String configurationPropertiesImportsAnnotation) {
this.typeUtils = new TypeUtils(environment);
this.elements = environment.getElementUtils();
this.messager = environment.getMessager();
@ -118,8 +118,8 @@ class MetadataGenerationEnvironment {
this.endpointAnnotation = endpointAnnotation;
this.readOperationAnnotation = readOperationAnnotation;
this.nameAnnotation = nameAnnotation;
this.importConfigurationPropertiesBeanAnnotation = importConfigurationPropertiesBeanAnnotation;
this.importConfigurationPropertiesBeansAnnotation = importConfigurationPropertiesBeansAnnotation;
this.configurationPropertiesImportAnnotation = configurationPropertiesImportAnnotation;
this.configurationPropertiesImportsAnnotation = configurationPropertiesImportsAnnotation;
}
private static FieldValuesParser resolveFieldValuesParser(ProcessingEnvironment env) {
@ -265,12 +265,12 @@ class MetadataGenerationEnvironment {
return this.elements.getTypeElement(this.configurationPropertiesAnnotation);
}
TypeElement getImportConfigurationPropertiesBeanAnnotationElement() {
return this.elements.getTypeElement(this.importConfigurationPropertiesBeanAnnotation);
TypeElement getConfigurationPropertiesImportAnnotationElement() {
return this.elements.getTypeElement(this.configurationPropertiesImportAnnotation);
}
TypeElement getImportConfigurationPropertiesBeansAnnotationElement() {
return this.elements.getTypeElement(this.importConfigurationPropertiesBeansAnnotation);
TypeElement getConfigurationPropertiesImportsAnnotationElement() {
return this.elements.getTypeElement(this.configurationPropertiesImportsAnnotation);
}
AnnotationMirror getConfigurationPropertiesAnnotation(Element element) {
@ -297,13 +297,13 @@ class MetadataGenerationEnvironment {
return getAnnotation(element, this.nameAnnotation);
}
List<AnnotationMirror> getImportConfigurationPropertiesBeanAnnotations(Element element) {
List<AnnotationMirror> getConfigurationPropertiesImportAnnotations(Element element) {
List<AnnotationMirror> annotations = new ArrayList<>();
AnnotationMirror importBean = getAnnotation(element, this.importConfigurationPropertiesBeanAnnotation);
AnnotationMirror importBean = getAnnotation(element, this.configurationPropertiesImportAnnotation);
if (importBean != null) {
annotations.add(importBean);
}
AnnotationMirror importBeans = getAnnotation(element, this.importConfigurationPropertiesBeansAnnotation);
AnnotationMirror importBeans = getAnnotation(element, this.configurationPropertiesImportsAnnotation);
if (importBeans != null) {
AnnotationValue value = importBeans.getElementValues().values().iterator().next();
for (Object contained : (List<?>) value.getValue()) {

2
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/PropertyDescriptorResolver.java
View File

@ -50,7 +50,7 @@ class PropertyDescriptorResolver {
* factory method}, if any.
* @param type the target type
* @param fromImport it the type was imported via a
* {@code @ImportConfigurationPropertiesBean}
* {@code @ConfigurationPropertiesImport}
* @param factoryMethod the method that triggered the metadata for that {@code type}
* or {@code null}
* @return the candidate properties for metadata generation

8
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/ImportBeanTests.java
View File

@ -20,8 +20,8 @@ import org.junit.jupiter.api.Test;
import org.springframework.boot.configurationprocessor.metadata.ConfigurationMetadata;
import org.springframework.boot.configurationprocessor.metadata.Metadata;
import org.springframework.boot.configurationsample.ImportConfigurationPropertiesBean;
import org.springframework.boot.configurationsample.ImportConfigurationPropertiesBeans;
import org.springframework.boot.configurationsample.ConfigurationPropertiesImport;
import org.springframework.boot.configurationsample.ConfigurationPropertiesImports;
import org.springframework.boot.configurationsample.importbean.ImportJavaBeanConfigurationPropertiesBean;
import org.springframework.boot.configurationsample.importbean.ImportMultipleTypeConfigurationPropertiesBean;
import org.springframework.boot.configurationsample.importbean.ImportRepeatedConfigurationPropertiesBean;
@ -32,8 +32,8 @@ import org.springframework.boot.configurationsample.importbean.ImportedValueObje
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link ImportConfigurationPropertiesBean} and
* {@link ImportConfigurationPropertiesBeans}.
* Tests for {@link ConfigurationPropertiesImport} and
* {@link ConfigurationPropertiesImports}.
*
* @author Phillip Webb
*/

4
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/MetadataGenerationEnvironmentFactory.java
View File

@ -40,8 +40,8 @@ class MetadataGenerationEnvironmentFactory implements Function<ProcessingEnviron
TestConfigurationMetadataAnnotationProcessor.ENDPOINT_ANNOTATION,
TestConfigurationMetadataAnnotationProcessor.READ_OPERATION_ANNOTATION,
TestConfigurationMetadataAnnotationProcessor.NAME_ANNOTATION,
TestConfigurationMetadataAnnotationProcessor.IMPORT_CONFIGURATION_PROPERTIES_BEAN_ANNOATION,
TestConfigurationMetadataAnnotationProcessor.IMPORT_CONFIGURATION_PROPERTIES_BEANS_ANNOATION);
TestConfigurationMetadataAnnotationProcessor.CONFIGURATION_PROPERTIES_IMPORT_ANNOATION,
TestConfigurationMetadataAnnotationProcessor.CONFIGURATION_PROPERTIES_IMPORTS_ANNOATION);
}
}

12
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/test/TestConfigurationMetadataAnnotationProcessor.java
View File

@ -57,9 +57,9 @@ public class TestConfigurationMetadataAnnotationProcessor extends ConfigurationM
public static final String NAME_ANNOTATION = "org.springframework.boot.configurationsample.Name";
public static final String IMPORT_CONFIGURATION_PROPERTIES_BEAN_ANNOATION = "org.springframework.boot.configurationsample.ImportConfigurationPropertiesBean";
public static final String CONFIGURATION_PROPERTIES_IMPORT_ANNOATION = "org.springframework.boot.configurationsample.ConfigurationPropertiesImport";
public static final String IMPORT_CONFIGURATION_PROPERTIES_BEANS_ANNOATION = "org.springframework.boot.configurationsample.ImportConfigurationPropertiesBeans";
public static final String CONFIGURATION_PROPERTIES_IMPORTS_ANNOATION = "org.springframework.boot.configurationsample.ConfigurationPropertiesImports";
private ConfigurationMetadata metadata;
@ -110,13 +110,13 @@ public class TestConfigurationMetadataAnnotationProcessor extends ConfigurationM
}
@Override
protected String importConfigurationPropertiesBeanAnnotation() {
return IMPORT_CONFIGURATION_PROPERTIES_BEAN_ANNOATION;
protected String configurationPropertiesImportAnnotation() {
return CONFIGURATION_PROPERTIES_IMPORT_ANNOATION;
}
@Override
protected String importConfigurationPropertiesBeansAnnotation() {
return IMPORT_CONFIGURATION_PROPERTIES_BEANS_ANNOATION;
protected String configurationPropertiesImportsAnnotation() {
return CONFIGURATION_PROPERTIES_IMPORTS_ANNOATION;
}
@Override

8
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/ImportConfigurationPropertiesBean.java → spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/ConfigurationPropertiesImport.java
View File

@ -26,8 +26,8 @@ import java.lang.annotation.Target;
import org.springframework.core.annotation.AliasFor;
/**
* Alternative to Spring Boot's {@code ImportConfigurationPropertiesBean} for testing
* (removes the need for a dependency on the real annotation).
* Alternative to Spring Boot's {@code ConfigurationPropertiesImport} for testing (removes
* the need for a dependency on the real annotation).
*
* @author Phillip Webb
*/
@ -35,8 +35,8 @@ import org.springframework.core.annotation.AliasFor;
@Retention(RetentionPolicy.RUNTIME)
@Documented
@ConfigurationProperties
@Repeatable(ImportConfigurationPropertiesBeans.class)
public @interface ImportConfigurationPropertiesBean {
@Repeatable(ConfigurationPropertiesImports.class)
public @interface ConfigurationPropertiesImport {
Class<?>[] type();

6
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/ImportConfigurationPropertiesBeans.java → spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/ConfigurationPropertiesImports.java
View File

@ -23,7 +23,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Alternative to Spring Boot's {@code ImportConfigurationPropertiesBeans} for testing
* Alternative to Spring Boot's {@code ConfigurationPropertiesImports} for testing
* (removes the need for a dependency on the real annotation).
*
* @author Phillip Webb
@ -31,8 +31,8 @@ import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ImportConfigurationPropertiesBeans {
public @interface ConfigurationPropertiesImports {
ImportConfigurationPropertiesBean[] value();
ConfigurationPropertiesImport[] value();
}

4
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/importbean/ImportJavaBeanConfigurationPropertiesBean.java
View File

@ -16,14 +16,14 @@
package org.springframework.boot.configurationsample.importbean;
import org.springframework.boot.configurationsample.ImportConfigurationPropertiesBean;
import org.springframework.boot.configurationsample.ConfigurationPropertiesImport;
/**
* An import of a java bean.
*
* @author Phillip Webb
*/
@ImportConfigurationPropertiesBean(type = ImportedJavaBean.class, prefix = "importbean")
@ConfigurationPropertiesImport(type = ImportedJavaBean.class, prefix = "importbean")
public class ImportJavaBeanConfigurationPropertiesBean {
}

4
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/importbean/ImportMultipleTypeConfigurationPropertiesBean.java
View File

@ -16,14 +16,14 @@
package org.springframework.boot.configurationsample.importbean;
import org.springframework.boot.configurationsample.ImportConfigurationPropertiesBean;
import org.springframework.boot.configurationsample.ConfigurationPropertiesImport;
/**
* An import of a java bean and a value object.
*
* @author Phillip Webb
*/
@ImportConfigurationPropertiesBean(type = { ImportedJavaBean.class, ImportedValueObject.class }, prefix = "importbean")
@ConfigurationPropertiesImport(type = { ImportedJavaBean.class, ImportedValueObject.class }, prefix = "importbean")
public class ImportMultipleTypeConfigurationPropertiesBean {
}

6
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/importbean/ImportRepeatedConfigurationPropertiesBean.java
View File

@ -16,15 +16,15 @@
package org.springframework.boot.configurationsample.importbean;
import org.springframework.boot.configurationsample.ImportConfigurationPropertiesBean;
import org.springframework.boot.configurationsample.ConfigurationPropertiesImport;
/**
* An import of a java bean and a value object.
*
* @author Phillip Webb
*/
@ImportConfigurationPropertiesBean(type = ImportedJavaBean.class, prefix = "jb")
@ImportConfigurationPropertiesBean(type = ImportedValueObject.class, prefix = "vo")
@ConfigurationPropertiesImport(type = ImportedJavaBean.class, prefix = "jb")
@ConfigurationPropertiesImport(type = ImportedValueObject.class, prefix = "vo")
public class ImportRepeatedConfigurationPropertiesBean {
}

4
spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/importbean/ImportValueObjectConfigurationPropertiesBean.java
View File

@ -16,14 +16,14 @@
package org.springframework.boot.configurationsample.importbean;
import org.springframework.boot.configurationsample.ImportConfigurationPropertiesBean;
import org.springframework.boot.configurationsample.ConfigurationPropertiesImport;
/**
* An import of a value object.
*
* @author Phillip Webb
*/
@ImportConfigurationPropertiesBean(type = ImportedValueObject.class, prefix = "importbean")
@ConfigurationPropertiesImport(type = ImportedValueObject.class, prefix = "importbean")
public class ImportValueObjectConfigurationPropertiesBean {
}

6
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/ImportConfigurationPropertiesBean.java → spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/ConfigurationPropertiesImport.java
View File

@ -46,9 +46,9 @@ import org.springframework.core.annotation.AliasFor;
@Documented
@EnableConfigurationProperties
@ConfigurationProperties
@Repeatable(ImportConfigurationPropertiesBeans.class)
@Import(ImportConfigurationPropertiesBeanRegistrar.class)
public @interface ImportConfigurationPropertiesBean {
@Repeatable(ConfigurationPropertiesImports.class)
@Import(ConfigurationPropertiesImportRegistrar.class)
public @interface ConfigurationPropertiesImport {
/**
* One or more types that should be imported as a bean.

16
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/ImportConfigurationPropertiesBeanRegistrar.java → spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/ConfigurationPropertiesImportRegistrar.java
View File

@ -25,34 +25,34 @@ import org.springframework.core.type.AnnotationMetadata;
/**
* {@link ImportBeanDefinitionRegistrar} for
* {@link ImportConfigurationPropertiesBean @ImportConfigurationPropertiesBean}.
* {@link ConfigurationPropertiesImport @ConfigurationPropertiesImport}.
*
* @author Phillip Webb
*/
class ImportConfigurationPropertiesBeanRegistrar implements ImportBeanDefinitionRegistrar {
class ConfigurationPropertiesImportRegistrar implements ImportBeanDefinitionRegistrar {
@Override
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry,
BeanNameGenerator importBeanNameGenerator) {
ConfigurationPropertiesBeanRegistrar registrar = new ConfigurationPropertiesBeanRegistrar(registry);
MergedAnnotations annotations = importingClassMetadata.getAnnotations();
registerBeans(registrar, annotations.get(ImportConfigurationPropertiesBeans.class));
registerBean(registrar, annotations.get(ImportConfigurationPropertiesBean.class));
registerBeans(registrar, annotations.get(ConfigurationPropertiesImports.class));
registerBean(registrar, annotations.get(ConfigurationPropertiesImport.class));
}
private void registerBeans(ConfigurationPropertiesBeanRegistrar registrar,
MergedAnnotation<ImportConfigurationPropertiesBeans> annotation) {
MergedAnnotation<ConfigurationPropertiesImports> annotation) {
if (!annotation.isPresent()) {
return;
}
for (MergedAnnotation<ImportConfigurationPropertiesBean> containedAnnotation : annotation
.getAnnotationArray(MergedAnnotation.VALUE, ImportConfigurationPropertiesBean.class)) {
for (MergedAnnotation<ConfigurationPropertiesImport> containedAnnotation : annotation
.getAnnotationArray(MergedAnnotation.VALUE, ConfigurationPropertiesImport.class)) {
registerBean(registrar, containedAnnotation);
}
}
private void registerBean(ConfigurationPropertiesBeanRegistrar registrar,
MergedAnnotation<ImportConfigurationPropertiesBean> annotation) {
MergedAnnotation<ConfigurationPropertiesImport> annotation) {
if (!annotation.isPresent()) {
return;
}

12
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/ImportConfigurationPropertiesBeans.java → spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/ConfigurationPropertiesImports.java
View File

@ -25,24 +25,24 @@ import java.lang.annotation.Target;
import org.springframework.context.annotation.Import;
/**
* Container annotation that aggregates several {@link ImportConfigurationPropertiesBean}
* Container annotation that aggregates several {@link ConfigurationPropertiesImport}
* annotations.
*
* @author Phillip Webb
* @since 2.4.0
* @see ImportConfigurationPropertiesBean
* @see ConfigurationPropertiesImport
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@EnableConfigurationProperties
@Import(ImportConfigurationPropertiesBeanRegistrar.class)
public @interface ImportConfigurationPropertiesBeans {
@Import(ConfigurationPropertiesImportRegistrar.class)
public @interface ConfigurationPropertiesImports {
/**
* The contained {@link ImportConfigurationPropertiesBean} annotations.
* The contained {@link ConfigurationPropertiesImport} annotations.
* @return the contained annotations
*/
ImportConfigurationPropertiesBean[] value();
ConfigurationPropertiesImport[] value();
}

2
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/EnableConfigurationProperties.java
View File

@ -51,7 +51,7 @@ public @interface EnableConfigurationProperties {
* {@link ConfigurationProperties @ConfigurationProperties} annotated beans with
* Spring. Standard Spring Beans will also be scanned regardless of this value.
* @return {@code @ConfigurationProperties} annotated beans to register
* @see ImportConfigurationPropertiesBean
* @see ConfigurationPropertiesImport
*/
Class<?>[] value() default {};

16
spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/ImportConfigurationPropertiesBeanTests.java → spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/ConfigurationPropertiesImportTests.java
View File

@ -26,11 +26,11 @@ import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
/**
* Tests for {@link ImportConfigurationPropertiesBean}.
* Tests for {@link ConfigurationPropertiesImport}.
*
* @author Phillip Webb
*/
class ImportConfigurationPropertiesBeanTests {
class ConfigurationPropertiesImportTests {
@Test
void importJavaBean() {
@ -86,7 +86,7 @@ class ImportConfigurationPropertiesBeanTests {
}
@Configuration
@ImportConfigurationPropertiesBean(prefix = "test", type = JavaBean.class)
@ConfigurationPropertiesImport(prefix = "test", type = JavaBean.class)
static class JavaBeanConfig {
}
@ -106,7 +106,7 @@ class ImportConfigurationPropertiesBeanTests {
}
@Configuration
@ImportConfigurationPropertiesBean(prefix = "test", type = ValueObject.class)
@ConfigurationPropertiesImport(prefix = "test", type = ValueObject.class)
static class ValueObjectConfig {
}
@ -126,7 +126,7 @@ class ImportConfigurationPropertiesBeanTests {
}
@Configuration
@ImportConfigurationPropertiesBean(prefix = "test", type = MultiConstructorValueObject.class)
@ConfigurationPropertiesImport(prefix = "test", type = MultiConstructorValueObject.class)
static class MultiConstructorValueObjectConfig {
}
@ -145,14 +145,14 @@ class ImportConfigurationPropertiesBeanTests {
}
@Configuration
@ImportConfigurationPropertiesBean(type = { ValueObject.class, JavaBean.class }, prefix = "test")
@ConfigurationPropertiesImport(type = { ValueObject.class, JavaBean.class }, prefix = "test")
static class ImportMultipleTypesConfig {
}
@Configuration
@ImportConfigurationPropertiesBean(type = ValueObject.class, prefix = "vo")
@ImportConfigurationPropertiesBean(type = JavaBean.class, prefix = "jb")
@ConfigurationPropertiesImport(type = ValueObject.class, prefix = "vo")
@ConfigurationPropertiesImport(type = JavaBean.class, prefix = "jb")
static class ImportRepeatedAnnotationsConfig {
}