public interface InstantiationAwareBeanPostProcessor extends BeanPostProcessor
BeanPostProcessor
that adds a before-instantiation callback,
and a callback after instantiation but before explicit properties are set or
autowiring occurs.
Typically used to suppress default instantiation for specific target beans, for example to create proxies with special TargetSources (pooling targets, lazily initializing targets, etc), or to implement additional injection strategies such as field injection.
NOTE: This interface is a special purpose interface, mainly for
internal use within the framework. It is recommended to implement the plain
BeanPostProcessor
interface as far as possible.
AbstractAutoProxyCreator.setCustomTargetSourceCreators(org.springframework.aop.framework.autoproxy.TargetSourceCreator...)
,
LazyInitTargetSourceCreator
Modifier and Type | Method and Description |
---|---|
default boolean |
postProcessAfterInstantiation(Object bean,
String beanName)
Perform operations after the bean has been instantiated, via a constructor or factory method,
but before Spring property population (from explicit properties or autowiring) occurs.
|
default Object |
postProcessBeforeInstantiation(Class<?> beanClass,
String beanName)
Apply this BeanPostProcessor before the target bean gets instantiated.
|
default PropertyValues |
postProcessProperties(PropertyValues pvs,
Object bean,
String beanName)
Post-process the given property values before the factory applies them
to the given bean, without any need for property descriptors.
|
default PropertyValues |
postProcessPropertyValues(PropertyValues pvs,
PropertyDescriptor[] pds,
Object bean,
String beanName)
Deprecated.
as of 5.1, in favor of
postProcessProperties(PropertyValues, Object, String) |
postProcessAfterInitialization, postProcessBeforeInitialization
@Nullable default Object postProcessBeforeInstantiation(Class<?> beanClass, String beanName) throws BeansException
If a non-null object is returned by this method, the bean creation process
will be short-circuited. The only further processing applied is the
BeanPostProcessor.postProcessAfterInitialization(java.lang.Object, java.lang.String)
callback from the configured
BeanPostProcessors
.
This callback will be applied to bean definitions with their bean class, as well as to factory-method definitions in which case the returned bean type will be passed in here.
Post-processors may implement the extended
SmartInstantiationAwareBeanPostProcessor
interface in order
to predict the type of the bean object that they are going to return here.
The default implementation returns null
.
beanClass
- the class of the bean to be instantiatedbeanName
- the name of the beannull
to proceed with default instantiationBeansException
- in case of errorspostProcessAfterInstantiation(java.lang.Object, java.lang.String)
,
AbstractBeanDefinition.getBeanClass()
,
AbstractBeanDefinition.getFactoryMethodName()
default boolean postProcessAfterInstantiation(Object bean, String beanName) throws BeansException
This is the ideal callback for performing custom field injection on the given bean instance, right before Spring's autowiring kicks in.
The default implementation returns true
.
bean
- the bean instance created, with properties not having been set yetbeanName
- the name of the beantrue
if properties should be set on the bean; false
if property population should be skipped. Normal implementations should return true
.
Returning false
will also prevent any subsequent InstantiationAwareBeanPostProcessor
instances being invoked on this bean instance.BeansException
- in case of errorspostProcessBeforeInstantiation(java.lang.Class<?>, java.lang.String)
@Nullable default PropertyValues postProcessProperties(PropertyValues pvs, Object bean, String beanName) throws BeansException
Implementations should return null
(the default) if they provide a custom
postProcessPropertyValues(org.springframework.beans.PropertyValues, java.beans.PropertyDescriptor[], java.lang.Object, java.lang.String)
implementation, and pvs
otherwise.
In a future version of this interface (with postProcessPropertyValues(org.springframework.beans.PropertyValues, java.beans.PropertyDescriptor[], java.lang.Object, java.lang.String)
removed),
the default implementation will return the given pvs
as-is directly.
pvs
- the property values that the factory is about to apply (never null
)bean
- the bean instance created, but whose properties have not yet been setbeanName
- the name of the beannull
which proceeds with the existing properties
but specifically continues with a call to postProcessPropertyValues(org.springframework.beans.PropertyValues, java.beans.PropertyDescriptor[], java.lang.Object, java.lang.String)
(requiring initialized PropertyDescriptor
s for the current bean class)BeansException
- in case of errorspostProcessPropertyValues(org.springframework.beans.PropertyValues, java.beans.PropertyDescriptor[], java.lang.Object, java.lang.String)
@Deprecated @Nullable default PropertyValues postProcessPropertyValues(PropertyValues pvs, PropertyDescriptor[] pds, Object bean, String beanName) throws BeansException
postProcessProperties(PropertyValues, Object, String)
Also allows for replacing the property values to apply, typically through creating a new MutablePropertyValues instance based on the original PropertyValues, adding or removing specific values.
The default implementation returns the given pvs
as-is.
pvs
- the property values that the factory is about to apply (never null
)pds
- the relevant property descriptors for the target bean (with ignored
dependency types - which the factory handles specifically - already filtered out)bean
- the bean instance created, but whose properties have not yet been setbeanName
- the name of the beannull
to skip property populationBeansException
- in case of errorspostProcessProperties(org.springframework.beans.PropertyValues, java.lang.Object, java.lang.String)
,
MutablePropertyValues