【Spring註解驅動開發】使用InitializingBean和DisposableBean來管理bean的生命周期，你真的了解嗎？

2020 年 6 月 22 日
筆記
spring

寫在前面

在《【Spring註解驅動開發】如何使用@Bean註解指定初始化和銷毀的方法？看這一篇就夠了！！》一文中，我們講述了如何使用@Bean註解來指定bean初始化和銷毀的方法。具體的用法就是在@Bean註解中使用init-method屬性和destroy-method屬性來指定初始化方法和銷毀方法。除此之外，Spring中是否還提供了其他的方式來對bean實例進行初始化和銷毀呢？

項目工程源碼已經提交到GitHub：//github.com/sunshinelyz/spring-annotation

InitializingBean接口

1.InitializingBean接口概述

Spring中提供了一個InitializingBean接口，InitializingBean接口為bean提供了屬性初始化後的處理方法，它只包括afterPropertiesSet方法，凡是繼承該接口的類，在bean的屬性初始化後都會執行該方法。InitializingBean接口的源碼如下所示。

package org.springframework.beans.factory;
public interface InitializingBean {
	void afterPropertiesSet() throws Exception;
}

根據InitializingBean接口中提供的afterPropertiesSet()方法的名字可以推斷出：afterPropertiesSet()方法是在屬性賦好值之後調用的。那到底是不是這樣呢？我們來分析下afterPropertiesSet()方法的調用時機。

2.何時調用InitializingBean接口？

我們定位到Spring中的org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory類下的invokeInitMethods()方法中，來查看Spring加載bean的方法。

題外話：不要問我為什麼會是這個invokeInitMethods()方法，如果你和我一樣對Spring的源碼非常熟悉的話，你也會知道是這個invokeInitMethods()方法，哈哈哈哈！所以，小夥伴們不要只顧着使用Spring，還是要多看看Spring的源碼啊！Spring框架中使用了大量優秀的設計模型，其代碼的編寫規範和嚴謹程度也是業界開源框架中數一數二的，非常值得閱讀。

我們來到AbstractAutowireCapableBeanFactory類下的invokeInitMethods()方法，如下所示。

protected void invokeInitMethods(String beanName, final Object bean, @Nullable RootBeanDefinition mbd)
    throws Throwable {
	//判斷該bean是否實現了實現了InitializingBean接口，如果實現了InitializingBean接口，則調用bean的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<Object>) () -> {
                    //調用afterPropertiesSet()方法
                    ((InitializingBean) bean).afterPropertiesSet();
                    return null;
                }, getAccessControlContext());
            }
            catch (PrivilegedActionException pae) {
                throw pae.getException();
            }
        }
        else {
            //調用afterPropertiesSet()方法
            ((InitializingBean) bean).afterPropertiesSet();
        }
    }

    if (mbd != null && bean.getClass() != NullBean.class) {
        String initMethodName = mbd.getInitMethodName();
        if (StringUtils.hasLength(initMethodName) &&
            !(isInitializingBean && "afterPropertiesSet".equals(initMethodName)) &&
            !mbd.isExternallyManagedInitMethod(initMethodName)) {
            //通過反射的方式調用init-method
            invokeCustomInitMethod(beanName, bean, mbd);
        }
    }
}

分析上述代碼後，我們可以初步得出如下信息：

Spring為bean提供了兩種初始化bean的方式，實現InitializingBean接口，實現afterPropertiesSet方法，或者在配置文件和@Bean註解中通過init-method指定，兩種方式可以同時使用。
實現InitializingBean接口是直接調用afterPropertiesSet()方法，比通過反射調用init-method指定的方法效率相對來說要高點。但是init-method方式消除了對Spring的依賴。
如果調用afterPropertiesSet方法時出錯，則不調用init-method指定的方法。

也就是說Spring為bean提供了兩種初始化的方式，第一種實現InitializingBean接口，實現afterPropertiesSet方法，第二種配置文件或@Bean註解中通過init-method指定，兩種方式可以同時使用，同時使用先調用afterPropertiesSet方法，後執行init-method指定的方法。

DisposableBean接口

1.DisposableBean接口概述

實現org.springframework.beans.factory.DisposableBean接口的bean在銷毀前，Spring將會調用DisposableBean接口的destroy()方法。我們先來看下DisposableBean接口的源碼，如下所示。

package org.springframework.beans.factory;
public interface DisposableBean {
	void destroy() throws Exception;
}

可以看到，在DisposableBean接口中只定義了一個destroy()方法。

在Bean生命周期結束前調用destory()方法做一些收尾工作，亦可以使用destory-method。前者與Spring耦合高，使用類型強轉.方法名()，效率高。後者耦合低，使用反射，效率相對低

2.DisposableBean接口注意事項

多例bean的生命周期不歸Spring容器來管理，這裡的DisposableBean中的方法是由Spring容器來調用的，所以如果一個多例實現了DisposableBean是沒有啥意義的，因為相應的方法根本不會被調用，當然在XML配置文件中指定了destroy方法，也是沒有意義的。所以，在多實例bean情況下，Spring不會自動調用bean的銷毀方法。

單實例bean案例

創建一個Animal的類實現InitializingBean和DisposableBean接口，代碼如下：

package io.mykit.spring.plugins.register.bean;

import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.stereotype.Component;
/**
 * @author binghe
 * @version 1.0.0
 * @description 測試InitializingBean接口和DisposableBean接口
 */
public class Animal implements InitializingBean, DisposableBean {
    public Animal(){
        System.out.println("執行了Animal類的無參數構造方法");
    }

    @Override
    public void afterPropertiesSet() throws Exception {
        System.out.println("執行了Animal類的初始化方法。。。。。");

    }
    @Override
    public void destroy() throws Exception {
        System.out.println("執行了Animal類的銷毀方法。。。。。");

    }
}

接下來，我們新建一個AnimalConfig類，並將Animal通過@Bean註解的方式註冊到Spring容器中，如下所示。

package io.mykit.spring.plugins.register.config;

import io.mykit.spring.plugins.register.bean.Animal;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
/**
 * @author binghe
 * @version 1.0.0
 * @description AnimalConfig
 */
@Configuration
@ComponentScan("io.mykit.spring.plugins.register.bean")
public class AnimalConfig {
    @Bean
    public Animal animal(){
        return new Animal();
    }
}

接下來，我們在BeanLifeCircleTest類中新增testBeanLifeCircle02()方法來進行測試，如下所示。

@Test
public void testBeanLifeCircle02(){
    //創建IOC容器
    AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AnimalConfig.class);
    System.out.println("IOC容器創建完成...");
    //關閉IOC容器
    context.close();
}

運行BeanLifeCircleTest類中的testBeanLifeCircle02()方法，輸出的結果信息如下所示。

執行了Animal類的無參數構造方法
執行了Animal類的初始化方法。。。。。
IOC容器創建完成...
執行了Animal類的銷毀方法。。。。。

從輸出的結果信息可以看出：單實例bean下，IOC容器創建完成後，會自動調用bean的初始化方法；而在容器銷毀前，會自動調用bean的銷毀方法。

多實例bean案例

多實例bean的案例代碼基本與單實例bean的案例代碼相同，只不過在AnimalConfig類中，我們在animal()方法上添加了@Scope(“prototype”)註解，如下所示。

package io.mykit.spring.plugins.register.config;
import io.mykit.spring.plugins.register.bean.Animal;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Scope;
/**
 * @author binghe
 * @version 1.0.0
 * @description AnimalConfig
 */
@Configuration
@ComponentScan("io.mykit.spring.plugins.register.bean")
public class AnimalConfig {
    @Bean
    @Scope("prototype")
    public Animal animal(){
        return new Animal();
    }
}

接下來，我們在BeanLifeCircleTest類中新增testBeanLifeCircle03()方法來進行測試，如下所示。

@Test
public void testBeanLifeCircle03(){
    //創建IOC容器
    AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(AnimalConfig.class);
    System.out.println("IOC容器創建完成...");
    System.out.println("-------");
    //調用時創建對象
    Object bean = ctx.getBean("animal");
    System.out.println("-------");
    //調用時創建對象
    Object bean1 = ctx.getBean("animal");
    System.out.println("-------");
    //關閉IOC容器
    ctx.close();
}

運行BeanLifeCircleTest類中的testBeanLifeCircle03()方法，輸出的結果信息如下所示。

IOC容器創建完成...
-------
執行了Animal類的無參數構造方法
執行了Animal類的初始化方法。。。。。
-------
執行了Animal類的無參數構造方法
執行了Animal類的初始化方法。。。。。
-------

從輸出的結果信息中可以看出：在多實例bean情況下，Spring不會自動調用bean的銷毀方法。

好了，咱們今天就聊到這兒吧！別忘了給個在看和轉發，讓更多的人看到，一起學習一起進步！！

項目工程源碼已經提交到GitHub：//github.com/sunshinelyz/spring-annotation

寫在最後

如果覺得文章對你有點幫助，請微信搜索並關注「冰河技術」微信公眾號，跟冰河學習Spring註解驅動開發。公眾號回復「spring註解」關鍵字，領取Spring註解驅動開發核心知識圖，讓Spring註解驅動開發不再迷茫。

Tags: spring