Support constructor injection for @Import classes
Allow `ImportBeanDefinitionRegistrar`, `ImportSelector`, `DeferredImportSelector.Group` and `TypeFilter` to use constructor parameters as an alternative to `*Aware` callbacks. In order to remain backwards compatible, injection only occurs when there is a single constructor with one or more parameters. The following parameter types are supported: * `Environment` * `BeanFactory` * `ClassLoader` * `ResourceLoader` In order to keep the algorithm simple, subclass parameter types are not supported. For example, you cannot use `ConfigurableEnvironment` instead of `Environment`. Closes gh-23637
This commit is contained in:
Phillip Webb
@@ -0,0 +1,264 @@
|
||||
/*
|
||||
* Copyright 2002-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.context.annotation;
|
||||
|
||||
import java.io.InputStream;
|
||||
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.mockito.Mock;
|
||||
import org.mockito.MockitoAnnotations;
|
||||
|
||||
import org.springframework.beans.BeanInstantiationException;
|
||||
import org.springframework.beans.BeansException;
|
||||
import org.springframework.beans.factory.BeanClassLoaderAware;
|
||||
import org.springframework.beans.factory.BeanFactory;
|
||||
import org.springframework.beans.factory.BeanFactoryAware;
|
||||
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
|
||||
import org.springframework.context.EnvironmentAware;
|
||||
import org.springframework.context.ResourceLoaderAware;
|
||||
import org.springframework.core.env.ConfigurableEnvironment;
|
||||
import org.springframework.core.env.Environment;
|
||||
import org.springframework.core.io.ResourceLoader;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
|
||||
import static org.mockito.BDDMockito.given;
|
||||
import static org.mockito.Mockito.reset;
|
||||
|
||||
/**
|
||||
* Tests for {@link ParserStrategyUtils}.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
public class ParserStrategyUtilsTests {
|
||||
|
||||
@Mock
|
||||
private Environment environment;
|
||||
|
||||
@Mock(extraInterfaces = BeanFactory.class)
|
||||
private BeanDefinitionRegistry registry;
|
||||
|
||||
@Mock
|
||||
private ClassLoader beanClassLoader;
|
||||
|
||||
@Mock
|
||||
private ResourceLoader resourceLoader;
|
||||
|
||||
@BeforeEach
|
||||
void setup() {
|
||||
MockitoAnnotations.initMocks(this);
|
||||
given(this.resourceLoader.getClassLoader()).willReturn(this.beanClassLoader);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void instantiateClassWhenHasNoArgsConstructorCallsAware() {
|
||||
NoArgsConstructor instance = instantiateClass(NoArgsConstructor.class);
|
||||
assertThat(instance.setEnvironment).isSameAs(this.environment);
|
||||
assertThat(instance.setBeanFactory).isSameAs(this.registry);
|
||||
assertThat(instance.setBeanClassLoader).isSameAs(this.beanClassLoader);
|
||||
assertThat(instance.setResourceLoader).isSameAs(this.resourceLoader);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void instantiateClassWhenHasSingleContructorInjectsParams() {
|
||||
ArgsConstructor instance = instantiateClass(ArgsConstructor.class);
|
||||
assertThat(instance.environment).isSameAs(this.environment);
|
||||
assertThat(instance.beanFactory).isSameAs(this.registry);
|
||||
assertThat(instance.beanClassLoader).isSameAs(this.beanClassLoader);
|
||||
assertThat(instance.resourceLoader).isSameAs(this.resourceLoader);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void instantiateClassWhenHasSingleContructorAndAwareInjectsParamsAndCallsAware() {
|
||||
ArgsConstructorAndAware instance = instantiateClass(ArgsConstructorAndAware.class);
|
||||
assertThat(instance.environment).isSameAs(this.environment);
|
||||
assertThat(instance.setEnvironment).isSameAs(this.environment);
|
||||
assertThat(instance.beanFactory).isSameAs(this.registry);
|
||||
assertThat(instance.setBeanFactory).isSameAs(this.registry);
|
||||
assertThat(instance.beanClassLoader).isSameAs(this.beanClassLoader);
|
||||
assertThat(instance.setBeanClassLoader).isSameAs(this.beanClassLoader);
|
||||
assertThat(instance.resourceLoader).isSameAs(this.resourceLoader);
|
||||
assertThat(instance.setResourceLoader).isSameAs(this.resourceLoader);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void instantiateClassWhenHasMultipleConstructorsUsesNoArgsConstructor() {
|
||||
// Remain back-compatible by using the default constructor if there's more then one
|
||||
MultipleConstructors instance = instantiateClass(MultipleConstructors.class);
|
||||
assertThat(instance.usedDefaultConstructor).isTrue();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void instantiateClassWhenHasMutlipleConstructorsAndNotDefaultThrowsException() {
|
||||
assertThatExceptionOfType(BeanInstantiationException.class).isThrownBy(() ->
|
||||
instantiateClass(MultipleConstructorsWithNoDefault.class));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void instantiateClassWhenHasUnsupportedParameterThrowsException() {
|
||||
assertThatExceptionOfType(BeanInstantiationException.class).isThrownBy(() ->
|
||||
instantiateClass(InvalidConstructorParameterType.class))
|
||||
.withCauseInstanceOf(IllegalStateException.class)
|
||||
.withMessageContaining("No suitable constructor found");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void instantiateClassHasSubclassParameterThrowsException() {
|
||||
// To keep the algorithm simple we don't support subtypes
|
||||
assertThatExceptionOfType(BeanInstantiationException.class).isThrownBy(() ->
|
||||
instantiateClass(InvalidConstructorParameterSubType.class))
|
||||
.withCauseInstanceOf(IllegalStateException.class)
|
||||
.withMessageContaining("No suitable constructor found");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void instantiateClassWhenHasNoBeanClassLoaderInjectsNull() {
|
||||
reset(this.resourceLoader);
|
||||
ArgsConstructor instance = instantiateClass(ArgsConstructor.class);
|
||||
assertThat(instance.beanClassLoader).isNull();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void instantiateClassWhenHasNoBeanClassLoaderDoesNotCallAware() {
|
||||
reset(this.resourceLoader);
|
||||
NoArgsConstructor instance = instantiateClass(NoArgsConstructor.class);
|
||||
assertThat(instance.setBeanClassLoader).isNull();
|
||||
assertThat(instance.setBeanClassLoaderCalled).isFalse();
|
||||
}
|
||||
|
||||
private <T> T instantiateClass(Class<T> clazz) {
|
||||
return ParserStrategyUtils.instantiateClass(clazz, clazz, this.environment,
|
||||
this.resourceLoader, this.registry);
|
||||
}
|
||||
|
||||
static class NoArgsConstructor implements BeanClassLoaderAware,
|
||||
BeanFactoryAware, EnvironmentAware, ResourceLoaderAware {
|
||||
|
||||
Environment setEnvironment;
|
||||
|
||||
BeanFactory setBeanFactory;
|
||||
|
||||
ClassLoader setBeanClassLoader;
|
||||
|
||||
boolean setBeanClassLoaderCalled;
|
||||
|
||||
ResourceLoader setResourceLoader;
|
||||
|
||||
@Override
|
||||
public void setEnvironment(Environment environment) {
|
||||
this.setEnvironment = environment;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
|
||||
this.setBeanFactory = beanFactory;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void setBeanClassLoader(ClassLoader classLoader) {
|
||||
this.setBeanClassLoader = classLoader;
|
||||
this.setBeanClassLoaderCalled = true;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void setResourceLoader(ResourceLoader resourceLoader) {
|
||||
this.setResourceLoader = resourceLoader;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
static class ArgsConstructor {
|
||||
|
||||
final Environment environment;
|
||||
|
||||
final BeanFactory beanFactory;
|
||||
|
||||
final ClassLoader beanClassLoader;
|
||||
|
||||
final ResourceLoader resourceLoader;
|
||||
|
||||
ArgsConstructor(Environment environment, BeanFactory beanFactory,
|
||||
ClassLoader beanClassLoader, ResourceLoader resourceLoader) {
|
||||
this.environment = environment;
|
||||
this.beanFactory = beanFactory;
|
||||
this.beanClassLoader = beanClassLoader;
|
||||
this.resourceLoader = resourceLoader;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
static class ArgsConstructorAndAware extends NoArgsConstructor {
|
||||
|
||||
final Environment environment;
|
||||
|
||||
final BeanFactory beanFactory;
|
||||
|
||||
final ClassLoader beanClassLoader;
|
||||
|
||||
final ResourceLoader resourceLoader;
|
||||
|
||||
ArgsConstructorAndAware(Environment environment, BeanFactory beanFactory,
|
||||
ClassLoader beanClassLoader, ResourceLoader resourceLoader) {
|
||||
this.environment = environment;
|
||||
this.beanFactory = beanFactory;
|
||||
this.beanClassLoader = beanClassLoader;
|
||||
this.resourceLoader = resourceLoader;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
static class MultipleConstructors {
|
||||
|
||||
final boolean usedDefaultConstructor;
|
||||
|
||||
MultipleConstructors() {
|
||||
this.usedDefaultConstructor = true;
|
||||
}
|
||||
|
||||
MultipleConstructors(Environment environment) {
|
||||
this.usedDefaultConstructor = false;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
static class MultipleConstructorsWithNoDefault {
|
||||
|
||||
MultipleConstructorsWithNoDefault(Environment environment, BeanFactory beanFactory) {
|
||||
}
|
||||
|
||||
MultipleConstructorsWithNoDefault(Environment environment) {
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
static class InvalidConstructorParameterType {
|
||||
|
||||
InvalidConstructorParameterType(Environment environment, InputStream inputStream) {
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
static class InvalidConstructorParameterSubType {
|
||||
|
||||
InvalidConstructorParameterSubType(ConfigurableEnvironment environment) {
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user