类 InitDestroyAnnotationBeanPostProcessor
- java.lang.Object
- org.springframework.beans.factory.annotation.InitDestroyAnnotationBeanPostProcessor
- 所有已实现的接口:
Serializable,BeanPostProcessor,DestructionAwareBeanPostProcessor,MergedBeanDefinitionPostProcessor,Ordered,PriorityOrdered
public class InitDestroyAnnotationBeanPostProcessor extends Object implements DestructionAwareBeanPostProcessor, MergedBeanDefinitionPostProcessor, PriorityOrdered, Serializable
BeanPostProcessorimplementation that invokes annotated init and destroy methods. Allows for an annotation alternative to Spring'sInitializingBeanandDisposableBeancallback interfaces.The actual annotation types that this post-processor checks for can be configured through the
"initAnnotationType"and"destroyAnnotationType"properties. Any custom annotation can be used, since there are no required annotation attributes.Init and destroy annotations may be applied to methods of any visibility: public, package-protected, protected, or private. Multiple such methods may be annotated, but it is recommended to only annotate one single init method and destroy method, respectively.
Spring's
CommonAnnotationBeanPostProcessorsupports the JSR-250PostConstructandPreDestroyannotations out of the box, as init annotation and destroy annotation, respectively. Furthermore, it also supports theResourceannotation for annotation-driven injection of named beans.
字段概要
从接口继承的字段 org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
构造器概要
构造器 构造器 说明 InitDestroyAnnotationBeanPostProcessor()
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 intgetOrder()Get the order value of this object.ObjectpostProcessAfterInitialization(Object bean, String beanName)Apply this BeanPostProcessor to the given new bean instance after any bean initialization callbacks (like InitializingBean'safterPropertiesSetor a custom init-method).voidpostProcessBeforeDestruction(Object bean, String beanName)Apply this BeanPostProcessor to the given bean instance before its destruction, e.g. invoking custom destruction callbacks.ObjectpostProcessBeforeInitialization(Object bean, String beanName)Apply this BeanPostProcessor to the given new bean instance before any bean initialization callbacks (like InitializingBean'safterPropertiesSetor a custom init-method).voidpostProcessMergedBeanDefinition(RootBeanDefinition beanDefinition, Class<?> beanType, String beanName)Post-process the given merged bean definition for the specified bean.booleanrequiresDestruction(Object bean)Determine whether the given bean instance requires destruction by this post-processor.voidsetDestroyAnnotationType(Class<? extends Annotation> destroyAnnotationType)Specify the destroy annotation to check for, indicating destruction methods to call when the context is shutting down.voidsetInitAnnotationType(Class<? extends Annotation> initAnnotationType)Specify the init annotation to check for, indicating initialization methods to call after configuration of a bean.voidsetOrder(int order)
构造器详细资料
InitDestroyAnnotationBeanPostProcessor
public InitDestroyAnnotationBeanPostProcessor()
方法详细资料
setInitAnnotationType
public void setInitAnnotationType(Class<? extends Annotation> initAnnotationType)
Specify the init annotation to check for, indicating initialization methods to call after configuration of a bean.Any custom annotation can be used, since there are no required annotation attributes. There is no default, although a typical choice is the JSR-250
PostConstructannotation.
setDestroyAnnotationType
public void setDestroyAnnotationType(Class<? extends Annotation> destroyAnnotationType)
Specify the destroy annotation to check for, indicating destruction methods to call when the context is shutting down.Any custom annotation can be used, since there are no required annotation attributes. There is no default, although a typical choice is the JSR-250
PreDestroyannotation.
setOrder
public void setOrder(int order)
getOrder
public int getOrder()
从接口复制的说明:OrderedGet the order value of this object.Higher values are interpreted as lower priority. As a consequence, the object with the lowest value has the highest priority (somewhat analogous to Servlet
load-on-startupvalues).Same order values will result in arbitrary sort positions for the affected objects.
- 指定者:
getOrder在接口中Ordered- 返回:
- the order value
- 另请参阅:
Ordered.HIGHEST_PRECEDENCE,Ordered.LOWEST_PRECEDENCE
postProcessMergedBeanDefinition
public void postProcessMergedBeanDefinition(RootBeanDefinition beanDefinition, Class<?> beanType, String beanName)
从接口复制的说明:MergedBeanDefinitionPostProcessorPost-process the given merged bean definition for the specified bean.- 指定者:
postProcessMergedBeanDefinition在接口中MergedBeanDefinitionPostProcessor- 参数:
beanDefinition- the merged bean definition for the beanbeanType- the actual type of the managed bean instancebeanName- the name of the bean
postProcessBeforeInitialization
public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException
从接口复制的说明:BeanPostProcessorApply this BeanPostProcessor to the given new bean instance before any bean initialization callbacks (like InitializingBean'safterPropertiesSetor a custom init-method). The bean will already be populated with property values. The returned bean instance may be a wrapper around the original.- 指定者:
postProcessBeforeInitialization在接口中BeanPostProcessor- 参数:
bean- the new bean instancebeanName- the name of the bean- 返回:
- the bean instance to use, either the original or a wrapped one; if
null, no subsequent BeanPostProcessors will be invoked - 抛出:
BeansException- in case of errors- 另请参阅:
InitializingBean.afterPropertiesSet()
postProcessAfterInitialization
public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException
从接口复制的说明:BeanPostProcessorApply this BeanPostProcessor to the given new bean instance after any bean initialization callbacks (like InitializingBean'safterPropertiesSetor a custom init-method). The bean will already be populated with property values. The returned bean instance may be a wrapper around the original.In case of a FactoryBean, this callback will be invoked for both the FactoryBean instance and the objects created by the FactoryBean (as of Spring 2.0). The post-processor can decide whether to apply to either the FactoryBean or created objects or both through corresponding
bean instanceof FactoryBeanchecks.This callback will also be invoked after a short-circuiting triggered by a
InstantiationAwareBeanPostProcessor.postProcessBeforeInstantiation(java.lang.Class<?>, java.lang.String)method, in contrast to all other BeanPostProcessor callbacks.- 指定者:
postProcessAfterInitialization在接口中BeanPostProcessor- 参数:
bean- the new bean instancebeanName- the name of the bean- 返回:
- the bean instance to use, either the original or a wrapped one; if
null, no subsequent BeanPostProcessors will be invoked - 抛出:
BeansException- in case of errors- 另请参阅:
InitializingBean.afterPropertiesSet(),FactoryBean
postProcessBeforeDestruction
public void postProcessBeforeDestruction(Object bean, String beanName) throws BeansException
从接口复制的说明:DestructionAwareBeanPostProcessorApply this BeanPostProcessor to the given bean instance before its destruction, e.g. invoking custom destruction callbacks.Like DisposableBean's
destroyand a custom destroy method, this callback will only apply to beans which the container fully manages the lifecycle for. This is usually the case for singletons and scoped beans.- 指定者:
postProcessBeforeDestruction在接口中DestructionAwareBeanPostProcessor- 参数:
bean- the bean instance to be destroyedbeanName- the name of the bean- 抛出:
BeansException- in case of errors- 另请参阅:
DisposableBean.destroy(),AbstractBeanDefinition.setDestroyMethodName(String)
requiresDestruction
public boolean requiresDestruction(Object bean)
从接口复制的说明:DestructionAwareBeanPostProcessorDetermine whether the given bean instance requires destruction by this post-processor.NOTE: Even as a late addition, this method has been introduced on
DestructionAwareBeanPostProcessoritself instead of on a SmartDABPP subinterface. This allows existingDestructionAwareBeanPostProcessorimplementations to easily providerequiresDestructionlogic while retaining compatibility with Spring <4.3, and it is also an easier onramp to declaringrequiresDestructionas a Java 8 default method in Spring 5.If an implementation of
DestructionAwareBeanPostProcessordoes not provide a concrete implementation of this method, Spring's invocation mechanism silently assumes a method returningtrue(the effective default before 4.3, and the to-be-default in the Java 8 method in Spring 5).- 指定者:
requiresDestruction在接口中DestructionAwareBeanPostProcessor- 参数:
bean- the bean instance to check- 返回:
trueifDestructionAwareBeanPostProcessor.postProcessBeforeDestruction(java.lang.Object, java.lang.String)is supposed to be called for this bean instance eventually, orfalseif not needed