init-method、@PostConstruct、afterPropertiesSet孰先孰后

发表于

Spring 允许在 Bean 在初始化完成后以及 Bean 销毁前执行特定的操作，常用的设定方式有以下三种：

  • 通过实现 InitializingBean/DisposableBean 接口来定制初始化之后/销毁之前的操作方法；
  • 通过<bean> 元素的init-method/destroy-method属性指定初始化之后 /销毁之前调用的操作方法；
  • 在指定方法上加上@PostConstruct/@PreDestroy注解来制定该方法是在初始化之后还是销毁之前调用。

这三种方式是完全等同的吗，孰先孰后？

演示

编写一个简单的测试代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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定义：

1
<bean class="InitSequenceBean" init-method="initMethod"></bean>

启动Spring容器，观察输出结果，就可知道三者的先后顺序了：

1
2
3
4
InitSequenceBean: constructor
InitSequenceBean: postConstruct
InitSequenceBean: afterPropertiesSet
InitSequenceBean: init-method

通过上述输出结果，三者的先后顺序也就一目了然了：

Constructor > @PostConstruct > InitializingBean > init-method

PostConstruct为何率先于InitializingBean执行呢？

CommonAnnotationBeanPostProcessor

通过Debug并查看调用栈，发现了这个类org.springframework.context.annotation.CommonAnnotationBeanPostProcessor，从命名上，我们就可以得到某些信息—这是一个BeanPostProcessor。BeanPostProcessor的postProcessBeforeInitialization是在Bean生命周期中afterPropertiesSet和init-method之前执被调用的。

CommonAnnotationBeanPostProcessor这个类，继承自InitDestroyAnnotationBeanPostProcessor。InitDestroyAnnotationBeanPostProcessor顾名思义，就是在Bean初始化和销毁的时候所作的一个前置/后置处理器。

查看InitDestroyAnnotationBeanPostProcessor类下的postProcessBeforeInitialization方法：

1
2
3
4
5
6
7
8
9
10
11
12
13
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这个方法体的内容：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
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的构造函数中看到下面这段代码：

1
2
3
4
5
6
public CommonAnnotationBeanPostProcessor() {  
       setOrder(Ordered.LOWEST_PRECEDENCE - 3);  
       setInitAnnotationType(PostConstruct.class);  
       setDestroyAnnotationType(PreDestroy.class);  
       ignoreResourceType("javax.xml.ws.WebServiceContext");  
}

一言以蔽之，@PostConstruct注解后的方法在BeanPostProcessor前置处理器中就被执行了，所以当然要先于InitializingBean和init-method执行了。

参考：

源码解析：init-method、@PostConstruct、afterPropertiesSet孰先孰后

热评文章