Browse Source
+ Eliminated BeanDefinitionRegistrar and BeanRegistrar types + Simplified ConfigurationEnhancer logic + Updated JavaDoc for ConfigurationModel and related classes + Updated JavaDoc for all ASM visitors git-svn-id: https://src.springframework.org/svn/spring-framework/trunk@779 50f2f4bb-b051-0410-bef5-90022cba6387pull/1/head
Chris Beams
17 years ago
18 changed files with 306 additions and 430 deletions
@ -1,50 +0,0 @@
@@ -1,50 +0,0 @@
|
||||
/* |
||||
* Copyright 2002-2009 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 |
||||
* |
||||
* http://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.config.java.support; |
||||
|
||||
import java.lang.reflect.Method; |
||||
|
||||
import org.springframework.beans.factory.support.BeanDefinitionRegistry; |
||||
|
||||
|
||||
/** |
||||
* Registers bean definition(s) for a particular method, usually based on its annotation |
||||
* metadata. |
||||
* |
||||
* <h3>Constraints</h3> Implementations must have only a default constructor, or explicitly |
||||
* declare a no-arg constructor. |
||||
* |
||||
* @see BeanMethod |
||||
* |
||||
* @author Chris Beams |
||||
*/ |
||||
// TODO: SJC-242 document FactoryMethodHandler
|
||||
// TODO: SJC-242 odd that the api here uses both ModelMethod and java.lang.reflect.Member
|
||||
// TODO: SJC-242 document that there must be a no-arg ctor
|
||||
interface BeanDefinitionRegistrar { |
||||
|
||||
/** |
||||
* Determines whether this registrar is capable of handling <var>method</var>. |
||||
*/ |
||||
// TODO: rename to supports() in alignment with Validator nomenclature
|
||||
boolean accepts(Method method); |
||||
|
||||
/** |
||||
* Registers any bean definitions for <var>method</var> with <var>registry</var>. |
||||
*/ |
||||
void register(BeanMethod method, BeanDefinitionRegistry registry); |
||||
|
||||
} |
||||
@ -1,234 +0,0 @@
@@ -1,234 +0,0 @@
|
||||
/* |
||||
* Copyright 2002-2009 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 |
||||
* |
||||
* http://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.config.java.support; |
||||
|
||||
import static java.lang.String.*; |
||||
import static org.springframework.util.StringUtils.*; |
||||
|
||||
import java.lang.reflect.Method; |
||||
import java.util.ArrayList; |
||||
import java.util.Arrays; |
||||
|
||||
import org.apache.commons.logging.Log; |
||||
import org.apache.commons.logging.LogFactory; |
||||
import org.springframework.aop.framework.autoproxy.AutoProxyUtils; |
||||
import org.springframework.aop.scope.ScopedProxyFactoryBean; |
||||
import org.springframework.beans.factory.BeanFactory; |
||||
import org.springframework.beans.factory.NoSuchBeanDefinitionException; |
||||
import org.springframework.beans.factory.config.BeanDefinition; |
||||
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory; |
||||
import org.springframework.beans.factory.support.BeanDefinitionRegistry; |
||||
import org.springframework.beans.factory.support.RootBeanDefinition; |
||||
import org.springframework.config.java.Bean; |
||||
import org.springframework.context.annotation.Scope; |
||||
import org.springframework.context.annotation.ScopedProxyMode; |
||||
import org.springframework.core.annotation.AnnotationUtils; |
||||
import org.springframework.util.Assert; |
||||
|
||||
|
||||
class BeanRegistrar implements BeanDefinitionRegistrar { |
||||
|
||||
private static final Log logger = LogFactory.getLog(BeanRegistrar.class); |
||||
|
||||
/** Prefix used when registering the target object for a scoped proxy. */ |
||||
private static final String TARGET_NAME_PREFIX = "scopedTarget."; |
||||
|
||||
/** |
||||
* Ensures that <var>member</var> is a method and is annotated (directly or indirectly) |
||||
* with {@link Bean @Bean}. |
||||
*/ |
||||
public boolean accepts(Method method) { |
||||
return AnnotationUtils.findAnnotation(method, Bean.class) != null; |
||||
} |
||||
|
||||
public void register(BeanMethod method, BeanDefinitionRegistry registry) { |
||||
RootBeanDefinition beanDef = new ConfigurationClassBeanDefinition(); |
||||
|
||||
ConfigurationClass configClass = method.getDeclaringClass(); |
||||
|
||||
beanDef.setFactoryBeanName(configClass.getBeanName()); |
||||
beanDef.setFactoryMethodName(method.getName()); |
||||
|
||||
Bean bean = method.getRequiredAnnotation(Bean.class); |
||||
|
||||
// TODO: prune defaults
|
||||
//Configuration defaults = configClass.getMetadata();
|
||||
|
||||
// consider scoping
|
||||
Scope scope = method.getAnnotation(Scope.class); |
||||
if(scope != null) |
||||
beanDef.setScope(scope.value()); |
||||
|
||||
// TODO: prune autowiring
|
||||
// // consider autowiring
|
||||
// if (bean.autowire() != AnnotationUtils.getDefaultValue(Bean.class, "autowire"))
|
||||
// beanDef.setAutowireMode(bean.autowire().value());
|
||||
// else if (defaults.defaultAutowire() != AnnotationUtils.getDefaultValue(Configuration.class,
|
||||
// "defaultAutowire"))
|
||||
// beanDef.setAutowireMode(defaults.defaultAutowire().value());
|
||||
|
||||
// consider name and any aliases
|
||||
ArrayList<String> names = new ArrayList<String>(Arrays.asList(bean.name())); |
||||
String beanName = (names.size() > 0) ? names.remove(0) : method.getName(); |
||||
for (String alias : bean.name()) |
||||
registry.registerAlias(beanName, alias); |
||||
|
||||
// has this already been overriden (i.e.: via XML)?
|
||||
if (containsBeanDefinitionIncludingAncestry(beanName, registry)) { |
||||
BeanDefinition existingBeanDef = getBeanDefinitionIncludingAncestry(beanName, registry); |
||||
|
||||
// is the existing bean definition one that was created by JavaConfig?
|
||||
if (!(existingBeanDef instanceof ConfigurationClassBeanDefinition)) { |
||||
// no -> then it's an external override, probably XML
|
||||
|
||||
// TODO: Prune this
|
||||
// // ensure that overriding is ok
|
||||
// if (bean.allowOverriding() == false) {
|
||||
// UsageError error = configClass.new IllegalBeanOverrideError(null, method);
|
||||
// throw new MalformedConfigurationException(error);
|
||||
// }
|
||||
|
||||
// overriding is legal, return immediately
|
||||
logger.info(format("Skipping loading bean definition for %s: a definition for bean " |
||||
+ "'%s' already exists. This is likely due to an override in XML.", method, beanName)); |
||||
return; |
||||
} |
||||
} |
||||
|
||||
// TODO: re-enable for Lazy support
|
||||
// // is this bean marked as primary for disambiguation?
|
||||
// if (bean.primary() == Primary.TRUE)
|
||||
// beanDef.setPrimary(true);
|
||||
//
|
||||
// // is this bean lazily instantiated?
|
||||
// if ((bean.lazy() == Lazy.TRUE)
|
||||
// || ((bean.lazy() == Lazy.UNSPECIFIED) && (defaults.defaultLazy() == Lazy.TRUE)))
|
||||
// beanDef.setLazyInit(true);
|
||||
|
||||
// does this bean have a custom init-method specified?
|
||||
String initMethodName = bean.initMethod(); |
||||
if (hasText(initMethodName)) |
||||
beanDef.setInitMethodName(initMethodName); |
||||
|
||||
// does this bean have a custom destroy-method specified?
|
||||
String destroyMethodName = bean.destroyMethod(); |
||||
if (hasText(destroyMethodName)) |
||||
beanDef.setDestroyMethodName(destroyMethodName); |
||||
|
||||
// is this method annotated with @Scope(scopedProxy=...)?
|
||||
if (scope != null && scope.proxyMode() != ScopedProxyMode.NO) { |
||||
RootBeanDefinition targetDef = beanDef; |
||||
|
||||
// Create a scoped proxy definition for the original bean name,
|
||||
// "hiding" the target bean in an internal target definition.
|
||||
String targetBeanName = resolveHiddenScopedProxyBeanName(beanName); |
||||
RootBeanDefinition scopedProxyDefinition = new RootBeanDefinition(ScopedProxyFactoryBean.class); |
||||
scopedProxyDefinition.getPropertyValues().addPropertyValue("targetBeanName", targetBeanName); |
||||
|
||||
if (scope.proxyMode() == ScopedProxyMode.TARGET_CLASS) |
||||
targetDef.setAttribute(AutoProxyUtils.PRESERVE_TARGET_CLASS_ATTRIBUTE, Boolean.TRUE); |
||||
// ScopedFactoryBean's "proxyTargetClass" default is TRUE, so we
|
||||
// don't need to set it explicitly here.
|
||||
else |
||||
scopedProxyDefinition.getPropertyValues().addPropertyValue("proxyTargetClass", Boolean.FALSE); |
||||
|
||||
// The target bean should be ignored in favor of the scoped proxy.
|
||||
targetDef.setAutowireCandidate(false); |
||||
|
||||
// Register the target bean as separate bean in the factory
|
||||
registry.registerBeanDefinition(targetBeanName, targetDef); |
||||
|
||||
// replace the original bean definition with the target one
|
||||
beanDef = scopedProxyDefinition; |
||||
} |
||||
|
||||
// TODO: re-enable for @Meta support
|
||||
// does this bean method have any @Meta annotations?
|
||||
// for (Meta meta : bean.meta())
|
||||
// beanDef.addMetadataAttribute(new BeanMetadataAttribute(meta.key(),
|
||||
// meta.value()));
|
||||
|
||||
if (bean.dependsOn().length > 0) |
||||
beanDef.setDependsOn(bean.dependsOn()); |
||||
|
||||
logger.info(format("Registering bean definition for @Bean method %s.%s()", |
||||
configClass.getName(), beanName)); |
||||
|
||||
registry.registerBeanDefinition(beanName, beanDef); |
||||
|
||||
} |
||||
|
||||
private boolean containsBeanDefinitionIncludingAncestry(String beanName, BeanDefinitionRegistry registry) { |
||||
try { |
||||
getBeanDefinitionIncludingAncestry(beanName, registry); |
||||
return true; |
||||
} catch (NoSuchBeanDefinitionException ex) { |
||||
return false; |
||||
} |
||||
} |
||||
|
||||
private BeanDefinition getBeanDefinitionIncludingAncestry(String beanName, BeanDefinitionRegistry registry) { |
||||
if(!(registry instanceof ConfigurableListableBeanFactory)) { |
||||
return registry.getBeanDefinition(beanName); |
||||
} |
||||
|
||||
ConfigurableListableBeanFactory clbf = (ConfigurableListableBeanFactory) registry; |
||||
|
||||
do { |
||||
if (clbf.containsBeanDefinition(beanName)) |
||||
return registry.getBeanDefinition(beanName); |
||||
|
||||
BeanFactory parent = clbf.getParentBeanFactory(); |
||||
if (parent == null) { |
||||
clbf = null; |
||||
} else if (parent instanceof ConfigurableListableBeanFactory) { |
||||
clbf = (ConfigurableListableBeanFactory) parent; |
||||
// TODO: re-enable
|
||||
// } else if (parent instanceof AbstractApplicationContext) {
|
||||
// clbf = ((AbstractApplicationContext) parent).getBeanFactory();
|
||||
} else { |
||||
throw new IllegalStateException("unknown parent type: " + parent.getClass().getName()); |
||||
} |
||||
} while (clbf != null); |
||||
|
||||
throw new NoSuchBeanDefinitionException(format("No bean definition matching name '%s' " |
||||
+ "could be found in %s or its ancestry", beanName, registry)); |
||||
} |
||||
|
||||
/** |
||||
* Return the <i>hidden</i> name based on a scoped proxy bean name. |
||||
* |
||||
* @param originalBeanName the scope proxy bean name as declared in the |
||||
* Configuration-annotated class
|
||||
* |
||||
* @return the internally-used <i>hidden</i> bean name |
||||
*/ |
||||
public static String resolveHiddenScopedProxyBeanName(String originalBeanName) { |
||||
Assert.hasText(originalBeanName); |
||||
return TARGET_NAME_PREFIX.concat(originalBeanName); |
||||
} |
||||
|
||||
} |
||||
|
||||
/** |
||||
* {@link RootBeanDefinition} marker subclass used to signify that a bean definition created |
||||
* by JavaConfig as opposed to any other configuration source. Used in bean overriding cases |
||||
* where it's necessary to determine whether the bean definition was created externally |
||||
* (e.g. via XML). |
||||
*/ |
||||
@SuppressWarnings("serial") |
||||
class ConfigurationClassBeanDefinition extends RootBeanDefinition { |
||||
} |
||||
Loading…
Reference in new issue