Class AbstractAutoProxyCreator
- All Implemented Interfaces:
Serializable
,AopInfrastructureBean
,org.springframework.beans.factory.Aware
,org.springframework.beans.factory.BeanClassLoaderAware
,org.springframework.beans.factory.BeanFactoryAware
,org.springframework.beans.factory.config.BeanPostProcessor
,org.springframework.beans.factory.config.InstantiationAwareBeanPostProcessor
,org.springframework.beans.factory.config.SmartInstantiationAwareBeanPostProcessor
,org.springframework.core.Ordered
- Direct Known Subclasses:
AbstractAdvisorAutoProxyCreator
,BeanNameAutoProxyCreator
BeanPostProcessor
implementation
that wraps each eligible bean with an AOP proxy, delegating to specified interceptors
before invoking the bean itself.
This class distinguishes between "common" interceptors: shared for all proxies it
creates, and "specific" interceptors: unique per bean instance. There need not be any
common interceptors. If there are, they are set using the interceptorNames property.
As with ProxyFactoryBean
, interceptors names
in the current factory are used rather than bean references to allow correct handling
of prototype advisors and interceptors: for example, to support stateful mixins.
Any advice type is supported for "interceptorNames"
entries.
Such auto-proxying is particularly useful if there's a large number of beans that need to be wrapped with similar proxies, i.e. delegating to the same interceptors. Instead of x repetitive proxy definitions for x target beans, you can register one single such post processor with the bean factory to achieve the same effect.
Subclasses can apply any strategy to decide if a bean is to be proxied, e.g. by type,
by name, by definition details, etc. They can also return additional interceptors that
should just be applied to the specific bean instance. A simple concrete implementation is
BeanNameAutoProxyCreator
, identifying the beans to be proxied via given names.
Any number of TargetSourceCreator
implementations can be used to create
a custom target source: for example, to pool prototype objects. Auto-proxying will
occur even if there is no advice, as long as a TargetSourceCreator specifies a custom
TargetSource
. If there are no TargetSourceCreators set,
or if none matches, a SingletonTargetSource
will be used by default to wrap the target bean instance.
- Since:
- 13.10.2003
- Author:
- Juergen Hoeller, Rod Johnson, Rob Harrop, Sam Brannen
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected static final Object[]
Convenience constant for subclasses: Return value for "do not proxy".protected final org.apache.commons.logging.Log
Logger available to subclasses.protected static final Object[]
Convenience constant for subclasses: Return value for "proxy without additional interceptors, just the common ones".Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
Return whether the Advisors returned by the subclass are pre-filtered to match the bean's target class already, allowing the ClassFilter check to be skipped when building advisors chains for AOP invocations.protected Advisor[]
buildAdvisors
(String beanName, Object[] specificInterceptors) Determine the advisors for the given bean, including the specific interceptors as well as the common interceptor, all adapted to the Advisor interface.protected Object
createProxy
(Class<?> beanClass, String beanName, Object[] specificInterceptors, TargetSource targetSource) Create an AOP proxy for the given bean.protected void
customizeProxyFactory
(ProxyFactory proxyFactory) Subclasses may choose to implement this: for example, to change the interfaces exposed.Class<?>
determineBeanType
(Class<?> beanClass, String beanName) Constructor<?>[]
determineCandidateConstructors
(Class<?> beanClass, String beanName) protected abstract Object[]
getAdvicesAndAdvisorsForBean
(Class<?> beanClass, String beanName, TargetSource customTargetSource) Return whether the given bean is to be proxied, what additional advices (e.g.protected org.springframework.beans.factory.BeanFactory
Return the owningBeanFactory
.protected Object
getCacheKey
(Class<?> beanClass, String beanName) Build a cache key for the given bean class and bean name.protected TargetSource
getCustomTargetSource
(Class<?> beanClass, String beanName) Create a target source for bean instances.getEarlyBeanReference
(Object bean, String beanName) boolean
isFrozen()
Return whether the config is frozen, and no advice changes can be made.protected boolean
isInfrastructureClass
(Class<?> beanClass) Return whether the given bean class represents an infrastructure class that should never be proxied.postProcessAfterInitialization
(Object bean, String beanName) Create a proxy with the configured interceptors if the bean is identified as one to proxy by the subclass.postProcessBeforeInstantiation
(Class<?> beanClass, String beanName) org.springframework.beans.PropertyValues
postProcessProperties
(org.springframework.beans.PropertyValues pvs, Object bean, String beanName) Class<?>
predictBeanType
(Class<?> beanClass, String beanName) void
setAdvisorAdapterRegistry
(AdvisorAdapterRegistry advisorAdapterRegistry) Specify theAdvisorAdapterRegistry
to use.void
setApplyCommonInterceptorsFirst
(boolean applyCommonInterceptorsFirst) Set whether the common interceptors should be applied before bean-specific ones.void
setBeanFactory
(org.springframework.beans.factory.BeanFactory beanFactory) void
setCustomTargetSourceCreators
(TargetSourceCreator... targetSourceCreators) Set customTargetSourceCreators
to be applied in this order.void
setFrozen
(boolean frozen) Set whether the proxy should be frozen, preventing advice from being added to it once it is created.void
setInterceptorNames
(String... interceptorNames) Set the common interceptors.protected boolean
shouldProxyTargetClass
(Class<?> beanClass, String beanName) Determine whether the given bean should be proxied with its target class rather than its interfaces.protected boolean
shouldSkip
(Class<?> beanClass, String beanName) Subclasses should override this method to returntrue
if the given bean should not be considered for auto-proxying by this post-processor.protected Object
wrapIfNecessary
(Object bean, String beanName, Object cacheKey) Wrap the given bean if necessary, i.e.Methods inherited from class org.springframework.aop.framework.ProxyProcessorSupport
evaluateProxyInterfaces, getOrder, getProxyClassLoader, isConfigurationCallbackInterface, isInternalLanguageInterface, setBeanClassLoader, setOrder, setProxyClassLoader
Methods inherited from class org.springframework.aop.framework.ProxyConfig
copyFrom, isExposeProxy, isOpaque, isOptimize, isProxyTargetClass, setExposeProxy, setOpaque, setOptimize, setProxyTargetClass, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.springframework.beans.factory.config.BeanPostProcessor
postProcessBeforeInitialization
Methods inherited from interface org.springframework.beans.factory.config.InstantiationAwareBeanPostProcessor
postProcessAfterInstantiation
-
Field Details
-
DO_NOT_PROXY
Convenience constant for subclasses: Return value for "do not proxy". -
PROXY_WITHOUT_ADDITIONAL_INTERCEPTORS
Convenience constant for subclasses: Return value for "proxy without additional interceptors, just the common ones". -
logger
protected final org.apache.commons.logging.Log loggerLogger available to subclasses.
-
-
Constructor Details
-
AbstractAutoProxyCreator
public AbstractAutoProxyCreator()
-
-
Method Details
-
setFrozen
public void setFrozen(boolean frozen) Set whether the proxy should be frozen, preventing advice from being added to it once it is created.Overridden from the superclass to prevent the proxy configuration from being frozen before the proxy is created.
- Overrides:
setFrozen
in classProxyConfig
-
isFrozen
public boolean isFrozen()Description copied from class:ProxyConfig
Return whether the config is frozen, and no advice changes can be made.- Overrides:
isFrozen
in classProxyConfig
-
setAdvisorAdapterRegistry
Specify theAdvisorAdapterRegistry
to use.Default is the global
AdvisorAdapterRegistry
.- See Also:
-
setCustomTargetSourceCreators
Set customTargetSourceCreators
to be applied in this order. If the list is empty, or they all return null, aSingletonTargetSource
will be created for each bean.Note that TargetSourceCreators will kick in even for target beans where no advices or advisors have been found. If a
TargetSourceCreator
returns aTargetSource
for a specific bean, that bean will be proxied in any case.TargetSourceCreators
can only be invoked if this post processor is used in aBeanFactory
and itsBeanFactoryAware
callback is triggered.- Parameters:
targetSourceCreators
- the list ofTargetSourceCreators
. Ordering is significant: TheTargetSource
returned from the first matchingTargetSourceCreator
(that is, the first that returns non-null) will be used.
-
setInterceptorNames
Set the common interceptors. These must be bean names in the current factory. They can be of any advice or advisor type Spring supports.If this property isn't set, there will be zero common interceptors. This is perfectly valid, if "specific" interceptors such as matching Advisors are all we want.
-
setApplyCommonInterceptorsFirst
public void setApplyCommonInterceptorsFirst(boolean applyCommonInterceptorsFirst) Set whether the common interceptors should be applied before bean-specific ones. Default is "true"; else, bean-specific interceptors will get applied first. -
setBeanFactory
public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory) - Specified by:
setBeanFactory
in interfaceorg.springframework.beans.factory.BeanFactoryAware
-
getBeanFactory
@Nullable protected org.springframework.beans.factory.BeanFactory getBeanFactory()Return the owningBeanFactory
. May benull
, as this post-processor doesn't need to belong to a bean factory. -
predictBeanType
- Specified by:
predictBeanType
in interfaceorg.springframework.beans.factory.config.SmartInstantiationAwareBeanPostProcessor
-
determineBeanType
- Specified by:
determineBeanType
in interfaceorg.springframework.beans.factory.config.SmartInstantiationAwareBeanPostProcessor
-
determineCandidateConstructors
@Nullable public Constructor<?>[] determineCandidateConstructors(Class<?> beanClass, String beanName) - Specified by:
determineCandidateConstructors
in interfaceorg.springframework.beans.factory.config.SmartInstantiationAwareBeanPostProcessor
-
getEarlyBeanReference
- Specified by:
getEarlyBeanReference
in interfaceorg.springframework.beans.factory.config.SmartInstantiationAwareBeanPostProcessor
-
postProcessBeforeInstantiation
- Specified by:
postProcessBeforeInstantiation
in interfaceorg.springframework.beans.factory.config.InstantiationAwareBeanPostProcessor
-
postProcessProperties
public org.springframework.beans.PropertyValues postProcessProperties(org.springframework.beans.PropertyValues pvs, Object bean, String beanName) - Specified by:
postProcessProperties
in interfaceorg.springframework.beans.factory.config.InstantiationAwareBeanPostProcessor
-
postProcessAfterInitialization
Create a proxy with the configured interceptors if the bean is identified as one to proxy by the subclass.- Specified by:
postProcessAfterInitialization
in interfaceorg.springframework.beans.factory.config.BeanPostProcessor
- See Also:
-
getCacheKey
Build a cache key for the given bean class and bean name.Note: As of 4.2.3, this implementation does not return a concatenated class/name String anymore but rather the most efficient cache key possible: a plain bean name, prepended with
BeanFactory.FACTORY_BEAN_PREFIX
in case of aFactoryBean
; or if no bean name specified, then the given beanClass
as-is.- Parameters:
beanClass
- the bean classbeanName
- the bean name- Returns:
- the cache key for the given class and name
-
wrapIfNecessary
Wrap the given bean if necessary, i.e. if it is eligible for being proxied.- Parameters:
bean
- the raw bean instancebeanName
- the name of the beancacheKey
- the cache key for metadata access- Returns:
- a proxy wrapping the bean, or the raw bean instance as-is
-
isInfrastructureClass
Return whether the given bean class represents an infrastructure class that should never be proxied.The default implementation considers Advices, Advisors and AopInfrastructureBeans as infrastructure classes.
- Parameters:
beanClass
- the class of the bean- Returns:
- whether the bean represents an infrastructure class
- See Also:
-
shouldSkip
Subclasses should override this method to returntrue
if the given bean should not be considered for auto-proxying by this post-processor.Sometimes we need to be able to avoid this happening, e.g. if it will lead to a circular reference or if the existing target instance needs to be preserved. This implementation returns
false
unless the bean name indicates an "original instance" according toAutowireCapableBeanFactory
conventions.- Parameters:
beanClass
- the class of the beanbeanName
- the name of the bean- Returns:
- whether to skip the given bean
- See Also:
-
AutowireCapableBeanFactory.ORIGINAL_INSTANCE_SUFFIX
-
getCustomTargetSource
Create a target source for bean instances. Uses any TargetSourceCreators if set. Returnsnull
if no custom TargetSource should be used.This implementation uses the "customTargetSourceCreators" property. Subclasses can override this method to use a different mechanism.
- Parameters:
beanClass
- the class of the bean to create a TargetSource forbeanName
- the name of the bean- Returns:
- a TargetSource for this bean
- See Also:
-
createProxy
protected Object createProxy(Class<?> beanClass, @Nullable String beanName, @Nullable Object[] specificInterceptors, TargetSource targetSource) Create an AOP proxy for the given bean.- Parameters:
beanClass
- the class of the beanbeanName
- the name of the beanspecificInterceptors
- the set of interceptors that is specific to this bean (may be empty, but not null)targetSource
- the TargetSource for the proxy, already pre-configured to access the bean- Returns:
- the AOP proxy for the bean
- See Also:
-
shouldProxyTargetClass
Determine whether the given bean should be proxied with its target class rather than its interfaces.Checks the
"preserveTargetClass" attribute
of the corresponding bean definition.- Parameters:
beanClass
- the class of the beanbeanName
- the name of the bean- Returns:
- whether the given bean should be proxied with its target class
- See Also:
-
advisorsPreFiltered
protected boolean advisorsPreFiltered()Return whether the Advisors returned by the subclass are pre-filtered to match the bean's target class already, allowing the ClassFilter check to be skipped when building advisors chains for AOP invocations.Default is
false
. Subclasses may override this if they will always return pre-filtered Advisors.- Returns:
- whether the Advisors are pre-filtered
- See Also:
-
buildAdvisors
protected Advisor[] buildAdvisors(@Nullable String beanName, @Nullable Object[] specificInterceptors) Determine the advisors for the given bean, including the specific interceptors as well as the common interceptor, all adapted to the Advisor interface.- Parameters:
beanName
- the name of the beanspecificInterceptors
- the set of interceptors that is specific to this bean (may be empty, but not null)- Returns:
- the list of Advisors for the given bean
-
customizeProxyFactory
Subclasses may choose to implement this: for example, to change the interfaces exposed.The default implementation is empty.
- Parameters:
proxyFactory
- a ProxyFactory that is already configured with TargetSource and interfaces and will be used to create the proxy immediately after this method returns
-
getAdvicesAndAdvisorsForBean
@Nullable protected abstract Object[] getAdvicesAndAdvisorsForBean(Class<?> beanClass, String beanName, @Nullable TargetSource customTargetSource) throws org.springframework.beans.BeansException Return whether the given bean is to be proxied, what additional advices (e.g. AOP Alliance interceptors) and advisors to apply.- Parameters:
beanClass
- the class of the bean to advisebeanName
- the name of the beancustomTargetSource
- the TargetSource returned by thegetCustomTargetSource(java.lang.Class<?>, java.lang.String)
method: may be ignored. Will benull
if no custom target source is in use.- Returns:
- an array of additional interceptors for the particular bean;
or an empty array if no additional interceptors but just the common ones;
or
null
if no proxy at all, not even with the common interceptors. See constants DO_NOT_PROXY and PROXY_WITHOUT_ADDITIONAL_INTERCEPTORS. - Throws:
org.springframework.beans.BeansException
- in case of errors- See Also:
-