【Spring 笔记】InitializingBean 和 init-method 相关整理

文前说明

作为码农中的一员，需要不断的学习，我工作之余将一些分析总结和学习笔记写成博客与大家一起交流，也希望采用这种方式记录自己的学习之旅。

本文仅供学习交流使用，侵权必删。
不用于商业目的，转载请注明出处。

1. 概述

• Spring 在 bean 初始化时会进行三个检测扩展，可以对 bean 进行三个不同的定制化处理。包含有 Aware 接口、 BeanPostProcessor 接口、InitializingBean 接口 和 init-method。

2. 原理

2.1 InitializingBean

• Spring 的 org.springframework.beans.factory.InitializingBean 接口，为 bean 提供了定义初始化方法的方式。

afterPropertiesSet

• Spring 在完成实例化后，设置完所有属性，进行 Aware 接口 和 BeanPostProcessor 前置处理 之后，会接着检测当前 bean 对象是否实现了 InitializingBean 接口。
  • 如果实现，则调用其 afterPropertiesSet() 方法，进一步调整 bean 实例对象的状态。

public interface InitializingBean {

    /**
     * 该方法在 BeanFactory 设置完了所有属性之后被调用
     * 该方法允许 bean 实例设置了所有 bean 属性时执行初始化工作，如果该过程出现了错误则需要抛出异常
     *
     * Invoked by the containing {@code BeanFactory} after it has set all bean properties
     * and satisfied {@link BeanFactoryAware}, {@code ApplicationContextAware} etc.
     * 
This method allows the bean instance to perform validation of its overall
     * configuration and final initialization when all bean properties have been set.
     * @throws Exception in the event of misconfiguration (such as failure to set an
     * essential property) or if initialization fails for any other reason
     */
    void afterPropertiesSet() throws Exception;
}

2.1.1 用例

• 配置

• 用例

public class Test implements InitializingBean {

    private String name;

    public String getName() {
        return name;
    }

    public static void main(String[] args) {
        ClassPathResource resource = new ClassPathResource("spring.xml");
        DefaultListableBeanFactory factory = new DefaultListableBeanFactory();
        XmlBeanDefinitionReader reader = new XmlBeanDefinitionReader(factory);
        reader.loadBeanDefinitions(resource);
        Test test = (Test) factory.getBean("test");
        System.out.println("name ：" + test.getName());
    }

    @Override
    public void afterPropertiesSet() throws Exception {
        System.out.println("Test initializing...");
        this.name = "test";
    }
}

/**
print
Test initializing...
name ：test
**/

• 用例中通过 afterPropertiesSet() 方法改变了 bean 的属性，Spring 容器又提供了一种可以改变 bean 实例对象的方法。

2.1.2 invokeInitMethods

• bean 初始化阶段，Spring 容器会主动检查当前 bean 是否已经实现了 InitializingBean 接口，这个主动检查、调用的动作是由 invokeInitMethods() 方法完成。

// AbstractAutowireCapableBeanFactory.java
protected void invokeInitMethods(String beanName, final Object bean, @Nullable RootBeanDefinition mbd)
        throws Throwable {
    // 1. 首先会检查是否是 InitializingBean ，如果是的话需要调用 afterPropertiesSet()
    boolean isInitializingBean = (bean instanceof InitializingBean);
    if (isInitializingBean && (mbd == null || !mbd.isExternallyManagedInitMethod("afterPropertiesSet"))) {
        if (logger.isTraceEnabled()) {
            logger.trace("Invoking afterPropertiesSet() on bean with name '" + beanName + "'");
        }
        if (System.getSecurityManager() != null) { // 安全模式
            try {
                AccessController.doPrivileged((PrivilegedExceptionAction