root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

SPR-6328: Rename @ImportXml -> @ImportResource and allow for usage of non-XML BeanDefinitionReader types

This commit is contained in:
Chris Beams 2009-11-11 00:48:30 +00:00
parent 81efd48352
commit ee553f7804
7 changed files with 83 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
org.springframework.context/src/main/java/org/springframework/context/annotation/ConfigurationClass.java
View File

@ -24,6 +24,7 @@ import java.util.Set;
import org.springframework.beans.factory.parsing.Location;
import org.springframework.beans.factory.parsing.Problem;
import org.springframework.beans.factory.parsing.ProblemReporter;
import org.springframework.beans.factory.support.BeanDefinitionReader;
import org.springframework.core.io.DescriptiveResource;
import org.springframework.core.io.Resource;
import org.springframework.core.type.AnnotationMetadata;
@ -50,7 +51,7 @@ final class ConfigurationClass {
private String beanName;
private final Set<String> xmlFilesToImport = new LinkedHashSet<String>();
private final Map<String, String> importedResources = new LinkedHashMap<String, String>();
private final Set<ConfigurationClassMethod> methods = new LinkedHashSet<ConfigurationClassMethod>();
@ -107,12 +108,12 @@ final class ConfigurationClass {
return this.methods;
}
public void addXmlImport(String xmlImport) {
this.xmlFilesToImport.add(xmlImport);
public void addImportedResource(String importedResource, String readerClassName) {
this.importedResources.put(importedResource, readerClassName);
}
public Set<String> getXmlImports() {
return this.xmlFilesToImport;
public Map<String, String> getImportedResources() {
return this.importedResources;
}

33
org.springframework.context/src/main/java/org/springframework/context/annotation/ConfigurationClassBeanDefinitionReader.java
View File

@ -19,6 +19,7 @@ package org.springframework.context.annotation;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
@ -36,11 +37,12 @@ import org.springframework.beans.factory.support.BeanDefinitionReaderUtils;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.GenericBeanDefinition;
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.beans.factory.xml.XmlBeanDefinitionReader;
import org.springframework.core.annotation.AnnotationUtils;
import org.springframework.core.io.Resource;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.core.type.MethodMetadata;
import org.springframework.util.ClassUtils;
import org.springframework.util.ReflectionUtils;
import org.springframework.util.StringUtils;
/**
@ -95,7 +97,7 @@ class ConfigurationClassBeanDefinitionReader {
loadBeanDefinitionsForModelMethod(method);
}
loadBeanDefinitionsFromXml(configClass.getXmlImports());
loadBeanDefinitionsFromImportedResources(configClass.getImportedResources());
}
/**
@ -212,10 +214,29 @@ class ConfigurationClassBeanDefinitionReader {
registry.registerBeanDefinition(beanName, beanDefToRegister);
}
private void loadBeanDefinitionsFromXml(Set<String> xmlImports) {
XmlBeanDefinitionReader reader = new XmlBeanDefinitionReader(this.registry);
// TODO SPR-6310: qualify relatively pathed locations as done in AbstractContextLoader.modifyLocations
reader.loadBeanDefinitions(xmlImports.toArray(new String[]{}));
private void loadBeanDefinitionsFromImportedResources(Map<String, String> importedResources) {
HashMap<String, BeanDefinitionReader> readerInstanceCache = new HashMap<String, BeanDefinitionReader>();
for (String resource : importedResources.keySet()) {
String readerClassName = importedResources.get(resource);
if (!readerInstanceCache.containsKey(readerClassName)) {
try {
@SuppressWarnings("unchecked")
Class<? extends BeanDefinitionReader> readerClass =
(Class<? extends BeanDefinitionReader>) ClassUtils.forName(readerClassName, ClassUtils.getDefaultClassLoader());
BeanDefinitionReader readerInstance = readerClass.getConstructor(BeanDefinitionRegistry.class).newInstance(this.registry);
readerInstanceCache.put(readerClassName, readerInstance);
} catch (Exception ex) {
ReflectionUtils.handleReflectionException(ex);
}
}
BeanDefinitionReader reader = readerInstanceCache.get(readerClassName);
// TODO SPR-6310: qualify relatively pathed locations as done in AbstractContextLoader.modifyLocations
reader.loadBeanDefinitions(importedResources.keySet().toArray(new String[]{}));
}
}
/**

9
org.springframework.context/src/main/java/org/springframework/context/annotation/ConfigurationClassParser.java
View File

@ -28,12 +28,14 @@ import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.parsing.Location;
import org.springframework.beans.factory.parsing.Problem;
import org.springframework.beans.factory.parsing.ProblemReporter;
import org.springframework.beans.factory.support.BeanDefinitionReader;
import org.springframework.core.io.Resource;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.core.type.MethodMetadata;
import org.springframework.core.type.StandardAnnotationMetadata;
import org.springframework.core.type.classreading.MetadataReader;
import org.springframework.core.type.classreading.MetadataReaderFactory;
import org.springframework.util.ClassUtils;
/**
* Parses a {@link Configuration} class definition, populating a model (collection) of
@ -128,9 +130,10 @@ class ConfigurationClassParser {
if (metadata.isAnnotated(Import.class.getName())) {
processImport(configClass, (String[]) metadata.getAnnotationAttributes(Import.class.getName()).get("value"));
}
if (metadata.isAnnotated(ImportXml.class.getName())) {
for (String xmlImport : (String[]) metadata.getAnnotationAttributes(ImportXml.class.getName()).get("value")) {
configClass.addXmlImport(xmlImport);
if (metadata.isAnnotated(ImportResource.class.getName())) {
String readerClassName = (String) metadata.getAnnotationAttributes(ImportResource.class.getName()).get("reader");
for (String importedResource : (String[]) metadata.getAnnotationAttributes(ImportResource.class.getName()).get("value")) {
configClass.addImportedResource(importedResource, readerClassName);
}
}
Set<MethodMetadata> methods = metadata.getAnnotatedMethods(Bean.class.getName());

8
org.springframework.context/src/main/java/org/springframework/context/annotation/ImportXml.java → org.springframework.context/src/main/java/org/springframework/context/annotation/ImportResource.java
View File

@ -23,12 +23,16 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.beans.factory.support.BeanDefinitionReader;
import org.springframework.beans.factory.xml.XmlBeanDefinitionReader;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Inherited
public @interface ImportXml {
public @interface ImportResource {
String[] value();
Class<? extends BeanDefinitionReader> reader() default XmlBeanDefinitionReader.class;
}

1
org.springframework.context/src/test/java/org/springframework/context/annotation/configuration/ImportNonXmlResourceConfig-context.properties Normal file
View File

@ -0,0 +1 @@
propertiesDeclaredBean.(class)=test.beans.TestBean

45
org.springframework.context/src/test/java/org/springframework/context/annotation/configuration/ImportXmlTests.java → org.springframework.context/src/test/java/org/springframework/context/annotation/configuration/ImportResourceTests.java
View File

@ -26,20 +26,22 @@ import org.junit.Ignore;
import org.junit.Test;
import org.springframework.aop.support.AopUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.support.PropertiesBeanDefinitionReader;
import org.springframework.beans.factory.xml.XmlBeanDefinitionReader;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.ImportXml;
import org.springframework.context.annotation.ImportResource;
import test.beans.TestBean;
/**
* Integration tests for {@link ImportXml} support.
* Integration tests for {@link ImportResource} support.
*
* @author Chris Beams
*/
public class ImportXmlTests {
public class ImportResourceTests {
@Test
public void testImportXml() {
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(ImportXmlConfig.class);
@ -48,7 +50,7 @@ public class ImportXmlTests {
}
@Configuration
@ImportXml("classpath:org/springframework/context/annotation/configuration/ImportXmlConfig-context.xml")
@ImportResource("classpath:org/springframework/context/annotation/configuration/ImportXmlConfig-context.xml")
static class ImportXmlConfig {
public @Bean TestBean javaDeclaredBean() {
return new TestBean("java.declared");
@ -64,7 +66,7 @@ public class ImportXmlTests {
}
@Configuration
@ImportXml("ImportXmlConfig-context.xml")
@ImportResource("ImportXmlConfig-context.xml")
static class ImportXmlWithRelativePathConfig {
public @Bean TestBean javaDeclaredBean() {
return new TestBean("java.declared");
@ -97,7 +99,7 @@ public class ImportXmlTests {
}
@Configuration
@ImportXml("classpath:org/springframework/context/annotation/configuration/ImportXmlConfig-context.xml")
@ImportResource("classpath:org/springframework/context/annotation/configuration/ImportXmlConfig-context.xml")
static class BaseConfig {
}
@ -106,7 +108,7 @@ public class ImportXmlTests {
}
@Configuration
@ImportXml("classpath:org/springframework/context/annotation/configuration/SecondLevelSubConfig-context.xml")
@ImportResource("classpath:org/springframework/context/annotation/configuration/SecondLevelSubConfig-context.xml")
static class SecondLevelSubConfig extends BaseConfig {
}
@ -118,7 +120,7 @@ public class ImportXmlTests {
}
@Configuration
@ImportXml("classpath:org/springframework/context/annotation/configuration/ImportXmlWithAopNamespace-context.xml")
@ImportResource("classpath:org/springframework/context/annotation/configuration/ImportXmlWithAopNamespace-context.xml")
static class ImportXmlWithAopNamespaceConfig {
}
@ -136,7 +138,7 @@ public class ImportXmlTests {
}
@Configuration
@ImportXml(value="classpath:org/springframework/context/annotation/configuration/ImportXmlConfig-context.xml")
@ImportResource(value="classpath:org/springframework/context/annotation/configuration/ImportXmlConfig-context.xml")
static class ImportXmlAutowiredConfig {
@Autowired TestBean xmlDeclaredBean;
@ -144,5 +146,30 @@ public class ImportXmlTests {
return xmlDeclaredBean.getName();
}
}
@Test
public void testImportNonXmlResource() {
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(ImportNonXmlResourceConfig.class);
assertTrue(ctx.containsBean("propertiesDeclaredBean"));
}
@Configuration
@ImportResource(value="classpath:org/springframework/context/annotation/configuration/ImportNonXmlResourceConfig-context.properties",
reader=PropertiesBeanDefinitionReader.class)
static class ImportNonXmlResourceConfig {
}
@Ignore // TODO: SPR-6327
@Test
public void testImportDifferentResourceTypes() {
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(SubResourceConfig.class);
assertTrue(ctx.containsBean("propertiesDeclaredBean"));
assertTrue(ctx.containsBean("xmlDeclaredBean"));
}
@Configuration
@ImportResource(value="classpath:org/springframework/context/annotation/configuration/ImportXmlConfig-context.xml",
reader=XmlBeanDefinitionReader.class)
static class SubResourceConfig extends ImportNonXmlResourceConfig {
}
}

2
org.springframework.context/src/test/java/org/springframework/context/annotation/configuration/ImportXmlWithAopNamespace-context.xml
View File

@ -7,7 +7,7 @@
<bean id="proxiedXmlBean" class="test.beans.TestBean"/>
<bean id="anAspect" class="org.springframework.context.annotation.configuration.ImportXmlTests$AnAspect"/>
<bean id="anAspect" class="org.springframework.context.annotation.configuration.ImportResourceTests$AnAspect"/>
<aop:aspectj-autoproxy>
<aop:include name="anAspect"/>