Spring 容器中的 Bean 是有生命周期的 , Spring 允许在 Bean 在初始化完成后以及 Bean 销毁前执行特定的操作,常用的设定
方式有以下三种:
这是我们就有个疑问,这三种方式是完全等同的吗,孰先孰后?
下面我们将带着这个疑问,试图通过测试代码以及分析 Spring 源码找到答案。
首先,我们还是编写一个简单的测试代码:
public class InitSequenceBean implements InitializingBean {
public InitSequenceBean() {
System.out.println("InitSequenceBean: constructor");
}
@PostConstruct
public void postConstruct() {
System.out.println("InitSequenceBean: postConstruct");
}
public void initMethod() {
System.out.println("InitSequenceBean: init-method");
}
@Override
public void afterPropertiesSet() throws Exception { System.out.println("InitSequenceBean: afterPropertiesSet"); }
}
并且在配置文件中添加如下 Bean 定义:
< bean class = "InitSequenceBean" init-method = "initMethod" ></ bean >
好了,我们启动 Spring 容器,观察输出结果,就可知道三者的先后顺序了:
InitSequenceBean: constructor InitSequenceBean: postConstruct InitSequenceBean: afterPropertiesSet InitSequenceBean: init-method |
通过上述输出结果,三者的先后顺序也就一目了然了:
Constructor > @PostConstruct > InitializingBean > init-method
先大致分析下为什么会出现这些的结果:构造器( Constructor )被率先调用毋庸置疑, InitializingBean 先于 init-method 我
们也可以理解(在 也谈 Spring 容器的生命周期 中已经讨论过),但是 PostConstruct 为何率先于 InitializingBean 执行呢?
我们再次带着这个疑问去查看 Spring 源代码来一探究竟。
通过 Debug 并查看调用栈,我们发现了这个类 org.springframework.context.annotation.CommonAnnotationBeanPostProcessor ,从命名上,我们就可以得到某些信
息——这是一个 BeanPostProcessor 。想到了什么?在 也谈 Spring 容器的生命周期 中,我们提到过 BeanPostProcessor 的 postProcessBeforeInitialization 是在 Bean 生命周期中 afterPropertiesSet 和 init-method 之前执被调用的。
再次观察 CommonAnnotationBeanPostProcessor 这个类,它继承自 InitDestroyAnnotationBeanPostProcessor 。 InitDestroyAnnotationBeanPostProcessor 顾名思义,就是在 Bean 初始化和销毁的时候所作的一个前置 / 后置处理器。
通过查看 InitDestroyAnnotationBeanPostProcessor 类下的 postProcessBeforeInitialization 方法:
public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { LifecycleMetadata metadata = findLifecycleMetadata(bean.getClass()); try { metadata.invokeInitMethods(bean, beanName); } catch (InvocationTargetException ex) { throw new BeanCreationException(beanName, "Invocation of init method failed", ex.getTargetException()); } catch (Throwable ex) { throw new BeanCreationException(beanName, "Couldn't invoke init method", ex); } return bean; }
查看 findLifecycleMetadata 方法,继而我们跟踪到 buildLifecycleMetadata 这个方法体中,看下 buildLifecycleMetadata 这个方法体的内容:
private LifecycleMetadata buildLifecycleMetadata(final Class clazz) {
final LifecycleMetadata newMetadata = new LifecycleMetadata();
final boolean debug = logger.isDebugEnabled();
ReflectionUtils.doWithMethods(clazz, new ReflectionUtils.MethodCallback() {
public void doWith(Method method) {
if (initAnnotationType != null) {
if (method.getAnnotation(initAnnotationType) != null) {
newMetadata.addInitMethod(method);
if (debug) {
logger.debug("Found init method on class [" + clazz.getName() + "]: " + method);
}
}
}
if (destroyAnnotationType != null) {
if (method.getAnnotation(destroyAnnotationType) != null) { newMetadata.addDestroyMethod(method); if (debug) { logger.debug("Found destroy method on class [" + clazz.getName() + "]: " + method); } } } } }); return newMetadata;}
分析这段代码发现,在这里会去判断某方法有没有被 initAnnotationType/destroyAnnotationType 注释,如果有,则添加
到 init/destroy 队列中,后续一一执行。
initAnnotationType/destroyAnnotationType 注释是什么呢,我们在 CommonAnnotationBeanPostProcessor 的构造函数
中看到下面这段代码:
public CommonAnnotationBeanPostProcessor() {
setOrder(Ordered.LOWEST_PRECEDENCE - 3);
setInitAnnotationType(PostConstruct.class);
setDestroyAnnotationType(PreDestroy.class);
ignoreResourceType("javax.xml.ws.WebServiceContext");
}
一切都清晰了吧。一言以蔽之, @PostConstruct 注解后的方法在 BeanPostProcessor 前置处理器中就被执行了,所以当然
要先于 InitializingBean 和 init-method 执行了。
最后,给出本文的结论, Bean 在实例化的过程中:
Constructor > @PostConstruct > InitializingBean > init-method
本文源代码下载: https://lb-multi-demo.googlecode.com/svn/trunk/spring-lifecycle-test