SPR-5682:
* polishing for ConfigurationClassApplicationContext & tests * added ConfigurationClassWebApplicationContext & tests * next: refactoring out duplications between ConfigurationClassApplicationContext & ConfigurationClassWebApplicationContext
This commit is contained in:
@@ -53,13 +53,13 @@ public class ConfigurationClassApplicationContext extends AbstractRefreshableApp
|
||||
private final Set<Class<?>> configClasses = new LinkedHashSet<Class<?>>();
|
||||
|
||||
/**
|
||||
* Create a new {@link ConfigurationClassApplicationContext}, loading bean
|
||||
* Create a new {@link ConfigurationClassApplicationContext}, loading bean
|
||||
* definitions from the given {@literal configClasses} and automatically
|
||||
* refreshing the context. <p>Note: if zero classes are specified, the
|
||||
* context will <b>not</b> be refreshed automatically, assuming that
|
||||
* the user will subsequently call {@link #addConfigurationClass(Class)}
|
||||
* and then manually refresh.
|
||||
*
|
||||
*
|
||||
* @param configClasses zero or more {@link Configuration} classes
|
||||
* @see #addConfigurationClass(Class)
|
||||
* @see #refresh()
|
||||
@@ -68,14 +68,14 @@ public class ConfigurationClassApplicationContext extends AbstractRefreshableApp
|
||||
if (configClasses.length == 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
for (Class<?> configClass : configClasses) {
|
||||
addConfigurationClass(configClass);
|
||||
}
|
||||
|
||||
|
||||
this.refresh();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Add a {@link Configuration} class to be processed. Allows for programmatically
|
||||
* building a {@link ConfigurationClassApplicationContext}. Note that
|
||||
@@ -99,22 +99,22 @@ public class ConfigurationClassApplicationContext extends AbstractRefreshableApp
|
||||
* class specified. Enables the default set of annotation configuration post
|
||||
* processors, such that {@literal @Autowired}, {@literal @Required}, and associated
|
||||
* annotations can be used within Configuration classes.
|
||||
*
|
||||
*
|
||||
* <p>Configuration class bean definitions are registered with generated bean definition names.
|
||||
*
|
||||
*
|
||||
* @see AnnotationConfigUtils#registerAnnotationConfigProcessors(org.springframework.beans.factory.support.BeanDefinitionRegistry)
|
||||
* @see ConfigurationClassPostProcessor
|
||||
*/
|
||||
@Override
|
||||
protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory)
|
||||
throws IOException, BeansException {
|
||||
|
||||
|
||||
// @Autowired and friends must be enabled by default when processing @Configuration classes
|
||||
AnnotationConfigUtils.registerAnnotationConfigProcessors(beanFactory);
|
||||
|
||||
|
||||
for (Class<?> configClass : configClasses) {
|
||||
AbstractBeanDefinition def = BeanDefinitionBuilder.rootBeanDefinition(configClass).getBeanDefinition();
|
||||
|
||||
|
||||
String name = AnnotationUtils.findAnnotation(configClass, Configuration.class).value();
|
||||
if (!StringUtils.hasLength(name)) {
|
||||
name = new DefaultBeanNameGenerator().generateBeanName(def, beanFactory);
|
||||
@@ -122,13 +122,13 @@ public class ConfigurationClassApplicationContext extends AbstractRefreshableApp
|
||||
|
||||
beanFactory.registerBeanDefinition(name, def);
|
||||
}
|
||||
|
||||
|
||||
new ConfigurationClassPostProcessor().postProcessBeanFactory(beanFactory);
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the bean instance that matches the given object type.
|
||||
*
|
||||
*
|
||||
* @param <T>
|
||||
* @param requiredType type the bean must match; can be an interface or superclass.
|
||||
* {@literal null} is disallowed.
|
||||
@@ -141,9 +141,9 @@ public class ConfigurationClassApplicationContext extends AbstractRefreshableApp
|
||||
@SuppressWarnings("unchecked")
|
||||
public <T> T getBean(Class<T> requiredType) {
|
||||
Assert.notNull(requiredType, "requiredType may not be null");
|
||||
|
||||
|
||||
Map<String, ?> beansOfType = this.getBeansOfType(requiredType);
|
||||
|
||||
|
||||
switch (beansOfType.size()) {
|
||||
case 0:
|
||||
throw new NoSuchBeanDefinitionException(requiredType);
|
||||
|
||||
@@ -28,7 +28,7 @@ import org.springframework.core.LocalVariableTableParameterNameDiscoverer;
|
||||
|
||||
/**
|
||||
* Base class for {@link org.springframework.context.ApplicationContext}
|
||||
* implementations which are supposed to support multiple refreshs,
|
||||
* implementations which are supposed to support multiple calls to {@literal refresh},
|
||||
* creating a new internal bean factory instance every time.
|
||||
* Typically (but not necessarily), such a context will be driven by
|
||||
* a set of config locations to load bean definitions from.
|
||||
@@ -48,7 +48,9 @@ import org.springframework.core.LocalVariableTableParameterNameDiscoverer;
|
||||
* <p>Concrete standalone subclasses of this base class, reading in a
|
||||
* specific bean definition format, are {@link ClassPathXmlApplicationContext}
|
||||
* and {@link FileSystemXmlApplicationContext}, which both derive from the
|
||||
* common {@link AbstractXmlApplicationContext} base class.
|
||||
* common {@link AbstractXmlApplicationContext} base class;
|
||||
* {@link org.springframework.context.annotation.ConfigurationClassApplicationContext}
|
||||
* supports {@literal @Configuration}-annotated classes as a source of bean definitions.
|
||||
*
|
||||
* @author Juergen Hoeller
|
||||
* @since 1.1.3
|
||||
@@ -58,6 +60,7 @@ import org.springframework.core.LocalVariableTableParameterNameDiscoverer;
|
||||
* @see AbstractXmlApplicationContext
|
||||
* @see ClassPathXmlApplicationContext
|
||||
* @see FileSystemXmlApplicationContext
|
||||
* @see org.springframework.context.annotation.ConfigurationClassApplicationContext
|
||||
*/
|
||||
public abstract class AbstractRefreshableApplicationContext extends AbstractApplicationContext {
|
||||
|
||||
@@ -130,7 +133,7 @@ public abstract class AbstractRefreshableApplicationContext extends AbstractAppl
|
||||
}
|
||||
}
|
||||
catch (IOException ex) {
|
||||
throw new ApplicationContextException("I/O error parsing XML document for " + getDisplayName(), ex);
|
||||
throw new ApplicationContextException("I/O error parsing bean definition source for " + getDisplayName(), ex);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -20,30 +20,28 @@ import static java.lang.String.format;
|
||||
|
||||
import static org.hamcrest.CoreMatchers.*;
|
||||
import static org.junit.matchers.JUnitMatchers.*;
|
||||
import static org.junit.Assert.assertNotNull;
|
||||
import static org.junit.Assert.assertThat;
|
||||
import static org.junit.Assert.fail;
|
||||
import static org.junit.Assert.*;
|
||||
|
||||
import org.junit.Test;
|
||||
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
|
||||
public class ConfigurationClassApplicationContextTests {
|
||||
|
||||
|
||||
@Test(expected=IllegalStateException.class)
|
||||
public void emptyConstructorRequiresManualRefresh() {
|
||||
ConfigurationClassApplicationContext context = new ConfigurationClassApplicationContext();
|
||||
context.getBean("foo");
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void classesMissingConfigurationAnnotationAddedToContextAreDisallowed() {
|
||||
ConfigurationClassApplicationContext ctx =
|
||||
new ConfigurationClassApplicationContext(Config.class);
|
||||
|
||||
|
||||
// should be fine
|
||||
ctx.addConfigurationClass(ConfigWithCustomName.class);
|
||||
|
||||
|
||||
// should cause immediate failure (no refresh necessary)
|
||||
try {
|
||||
ctx.addConfigurationClass(ConfigMissingAnnotation.class);
|
||||
@@ -54,19 +52,18 @@ public class ConfigurationClassApplicationContextTests {
|
||||
"is not annotated with @Configuration"));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@Test(expected=IllegalArgumentException.class)
|
||||
public void classesMissingConfigurationAnnotationSuppliedToConstructorAreDisallowed() {
|
||||
new ConfigurationClassApplicationContext(ConfigMissingAnnotation.class);
|
||||
}
|
||||
|
||||
|
||||
|
||||
@Test(expected=IllegalArgumentException.class)
|
||||
public void nullGetBeanParameterIsDisallowed() {
|
||||
ConfigurationClassApplicationContext context = new ConfigurationClassApplicationContext(Config.class);
|
||||
context.getBean((Class<?>)null);
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void addConfigurationClass() {
|
||||
ConfigurationClassApplicationContext context = new ConfigurationClassApplicationContext();
|
||||
@@ -77,7 +74,7 @@ public class ConfigurationClassApplicationContextTests {
|
||||
context.refresh();
|
||||
context.getBean("name");
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void getBeanByType() {
|
||||
ConfigurationClassApplicationContext context = new ConfigurationClassApplicationContext(Config.class);
|
||||
@@ -85,7 +82,7 @@ public class ConfigurationClassApplicationContextTests {
|
||||
assertNotNull("getBean() should not return null", testBean);
|
||||
assertThat(testBean.name, equalTo("foo"));
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Tests that Configuration classes are registered according to convention
|
||||
* @see org.springframework.beans.factory.support.DefaultBeanNameGenerator#generateBeanName
|
||||
@@ -93,12 +90,12 @@ public class ConfigurationClassApplicationContextTests {
|
||||
@Test
|
||||
public void defaultConfigClassBeanNameIsGeneratedProperly() {
|
||||
ConfigurationClassApplicationContext context = new ConfigurationClassApplicationContext(Config.class);
|
||||
|
||||
|
||||
// attempt to retrieve the instance by its generated bean name
|
||||
Config configObject = (Config) context.getBean(Config.class.getName() + "#0");
|
||||
assertNotNull(configObject);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Tests that specifying @Configuration(value="foo") results in registering
|
||||
* the configuration class with bean name 'foo'.
|
||||
@@ -107,17 +104,17 @@ public class ConfigurationClassApplicationContextTests {
|
||||
public void explicitConfigClassBeanNameIsRespected() {
|
||||
ConfigurationClassApplicationContext context =
|
||||
new ConfigurationClassApplicationContext(ConfigWithCustomName.class);
|
||||
|
||||
|
||||
// attempt to retrieve the instance by its specified name
|
||||
ConfigWithCustomName configObject =
|
||||
(ConfigWithCustomName) context.getBean("customConfigBeanName");
|
||||
assertNotNull(configObject);
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void getBeanByTypeRaisesNoSuchBeanDefinitionException() {
|
||||
ConfigurationClassApplicationContext context = new ConfigurationClassApplicationContext(Config.class);
|
||||
|
||||
|
||||
// attempt to retrieve a bean that does not exist
|
||||
Class<?> targetType = java.util.regex.Pattern.class;
|
||||
try {
|
||||
@@ -128,12 +125,12 @@ public class ConfigurationClassApplicationContextTests {
|
||||
format("No unique bean of type [%s] is defined", targetType.getName())));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
@Test
|
||||
public void getBeanByTypeAmbiguityRaisesException() {
|
||||
ConfigurationClassApplicationContext context = new ConfigurationClassApplicationContext(TwoTestBeanConfig.class);
|
||||
|
||||
|
||||
try {
|
||||
context.getBean(TestBean.class);
|
||||
} catch (RuntimeException ex) {
|
||||
@@ -148,14 +145,14 @@ public class ConfigurationClassApplicationContextTests {
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void autowiringIsEnabledByDefault() {
|
||||
ConfigurationClassApplicationContext context = new ConfigurationClassApplicationContext(AutowiredConfig.class);
|
||||
assertThat(context.getBean(TestBean.class).name, equalTo("foo"));
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
@Configuration
|
||||
static class Config {
|
||||
@Bean
|
||||
@@ -165,7 +162,7 @@ public class ConfigurationClassApplicationContextTests {
|
||||
return testBean;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@Configuration("customConfigBeanName")
|
||||
static class ConfigWithCustomName {
|
||||
@Bean
|
||||
@@ -173,37 +170,37 @@ public class ConfigurationClassApplicationContextTests {
|
||||
return new TestBean();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
static class ConfigMissingAnnotation {
|
||||
@Bean
|
||||
public TestBean testBean() {
|
||||
return new TestBean();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@Configuration
|
||||
static class TwoTestBeanConfig {
|
||||
@Bean TestBean tb1() { return new TestBean(); }
|
||||
@Bean TestBean tb2() { return new TestBean(); }
|
||||
}
|
||||
|
||||
|
||||
@Configuration
|
||||
static class NameConfig {
|
||||
@Bean String name() { return "foo"; }
|
||||
}
|
||||
|
||||
|
||||
@Configuration
|
||||
@Import(NameConfig.class)
|
||||
static class AutowiredConfig {
|
||||
@Autowired String autowiredName;
|
||||
|
||||
|
||||
@Bean TestBean testBean() {
|
||||
TestBean testBean = new TestBean();
|
||||
testBean.name = autowiredName;
|
||||
return testBean;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
||||
class TestBean {
|
||||
@@ -233,6 +230,5 @@ class TestBean {
|
||||
return false;
|
||||
return true;
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user