Spring中的BeanPostProcessor詳解

前言

BeanPostProcessor也稱為Bean后置處理器，它是Spring中定義的接口，在Spring容器的創(chuàng)建過程中（具體為Bean初始化前后）會回調(diào)BeanPostProcessor中定義的兩個方法。BeanPostProcessor的源碼如下

public interface BeanPostProcessor {


    Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException;

    
    Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException;

}

其中postProcessBeforeInitialization方法會在每一個bean對象的初始化方法調(diào)用之前回調(diào)；postProcessAfterInitialization方法會在每個bean對象的初始化方法調(diào)用之后被回調(diào)。具體執(zhí)行時期可以參考Spring中Bean的生命周期源碼探究。

自定義BeanPostProcessor

查看BeanPostProcessor源碼，可以看到它兩個方法的參數(shù)都相同，其中第一個參數(shù)Object bean表示當(dāng)前正在初始化的bean對象。此外兩個方法都返回Object類型的實例，返回值既可以是將入?yún)?code>Object bean原封不動的返回出去，也可以對當(dāng)前bean進行包裝再返回。來看看下面的自定義BeanPostProcessor

/**
 * 后置處理器：初始化前后進行處理工作
 * 需要將后置處理器加入到容器中
 */
@Component
public class MyBeanPostProcessor implements BeanPostProcessor {

    @Override
    public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
        System.out.println("postProcessBeforeInitialization..."+beanName+"..."+bean);
        return bean;
    }

    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
        System.out.println("postProcessAfterInitialization..."+beanName+"..."+bean);
        return bean;
    }

}

Spring容器中加入MyBeanPostProcessor之后，針對容器中每個創(chuàng)建的Bean對象（Spring自身創(chuàng)建的Bean和應(yīng)用程序創(chuàng)建的Bean），都會回調(diào)postProcessBeforeInitialization和postProcessAfterInitialization方法。

執(zhí)行原理

BeanPostProcessor的執(zhí)行是定義在容器的刷新過程中，容器刷新對象具體的方法為：AbstractApplicationContext.refresh()。
在refresh方法執(zhí)行的調(diào)用棧中會去調(diào)用AbstractAutowireCapableBeanFactory.doCreateBean()方法，該方法節(jié)選源碼如下

protected Object initializeBean(final String beanName, final Object bean, RootBeanDefinition mbd) {
    
    if (mbd == null || !mbd.isSynthetic()) {
        wrappedBean = applyBeanPostProcessorsBeforeInitialization(wrappedBean, beanName);
    }
    
    invokeInitMethods(beanName, wrappedBean, mbd);

    if (mbd == null || !mbd.isSynthetic()) {
        wrappedBean = applyBeanPostProcessorsAfterInitialization(wrappedBean, beanName);
    }
    return wrappedBean;
}

看到在調(diào)用初始化方法前后會分別調(diào)用applyBeanPostProcessorsBeforeInitialization()和applyBeanPostProcessorsAfterInitialization()。applyBeanPostProcessorsBeforeInitialization()方法的源碼如下

public Object applyBeanPostProcessorsBeforeInitialization(Object existingBean, String beanName)
        throws BeansException {

    Object result = existingBean;
    //獲取所有的BeanPostProcessor進行遍歷
    for (BeanPostProcessor beanProcessor : getBeanPostProcessors()) {
        result = beanProcessor.postProcessBeforeInitialization(result, beanName);
        if (result == null) {
            return result;
        }
    }
    return result;
}

可以看到其邏輯為遍歷得到容器中所有的BeanPostProcessor，然后一次執(zhí)行postProcessBeforeInitialization，一但返回null，就跳出for循環(huán)不執(zhí)行后面的BeanPostProcessor.postProcessorsBeforeInitialization()。也就是說如果返回的是null那么我們通過getBean方法將得不到目標(biāo)Bean。
applyBeanPostProcessorsBeforeInitialization()方法的邏輯和上面一致，就是將循環(huán)執(zhí)行的beanProcessor.postProcessBeforeInitialization()替換成beanProcessor.postProcessAfterInitialization()
Spring底層的很多功能特性都是借助BeanPostProcessor的子類來實現(xiàn)。

常見BeanPostProcessor分析

下圖是debug過程中，ApplicationContext對象中的包含的BeanPostProcessor。具體包含哪些BeanPostProcessor和具體應(yīng)用程序相關(guān)，除了下標(biāo)3中的MyBeanPostProcessor為自定義的BeanPostProcessor，其余均為Spring自帶的BeanPostProcessor。


下面來分析一下ApplicationContextAwareProcessor和AutowiredAnnotationProcessor的執(zhí)行原理。

ApplicationContextAwareProcessor

ApplicationContextAwareProcessor后置處理器的作用是，當(dāng)應(yīng)用程序定義的Bean實現(xiàn)ApplicationContextAware接口時注入ApplicationContext對象。

@Component
public class Car implements ApplicationContextAware {

    private ApplicationContext applicationContext;

    public Car(){
        System.out.println("car instance...");
    }

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        System.out.println("ApplicationContextAware...setApplicationContext()");
        this.applicationContext = applicationContext;
    }
}

那Car是如何通過實現(xiàn)ApplicationContextAware接口就能獲得ApplicationContext對象呢？答案是通過ApplicationContextAwareProcessor后置處理器來實現(xiàn)，我們來看看ApplicationContextAwareProcessor的源碼

class ApplicationContextAwareProcessor implements BeanPostProcessor {

    private final ConfigurableApplicationContext applicationContext;

    private final StringValueResolver embeddedValueResolver;


    /**
     * Create a new ApplicationContextAwareProcessor for the given context.
     */
    public ApplicationContextAwareProcessor(ConfigurableApplicationContext applicationContext) {
        this.applicationContext = applicationContext;
        this.embeddedValueResolver = new EmbeddedValueResolver(applicationContext.getBeanFactory());
    }


    @Override
    public Object postProcessBeforeInitialization(final Object bean, String beanName) throws BeansException {
        AccessControlContext acc = null;
        // 這里bean是Car,它實現(xiàn)了ApplicationContextAware接口
        if (System.getSecurityManager() != null &&
                (bean instanceof EnvironmentAware || bean instanceof EmbeddedValueResolverAware ||
                        bean instanceof ResourceLoaderAware || bean instanceof ApplicationEventPublisherAware ||
                        bean instanceof MessageSourceAware || bean instanceof ApplicationContextAware)) {
            invokeAwareInterfaces(bean);
        }

        return bean;
    }

    private void invokeAwareInterfaces(Object bean) {
        if (bean instanceof Aware) {
            if (bean instanceof EnvironmentAware) {
                ((EnvironmentAware) bean).setEnvironment(this.applicationContext.getEnvironment());
            }
            if (bean instanceof EmbeddedValueResolverAware) {
                ((EmbeddedValueResolverAware) bean).setEmbeddedValueResolver(this.embeddedValueResolver);
            }
            if (bean instanceof ResourceLoaderAware) {
                ((ResourceLoaderAware) bean).setResourceLoader(this.applicationContext);
            }
            if (bean instanceof ApplicationEventPublisherAware) {
                ((ApplicationEventPublisherAware) bean).setApplicationEventPublisher(this.applicationContext);
            }
            if (bean instanceof MessageSourceAware) {
                ((MessageSourceAware) bean).setMessageSource(this.applicationContext);
            }
            if (bean instanceof ApplicationContextAware) {
                // 會執(zhí)行這里回調(diào)car重寫的setApplicationContext方法，然后將this.applicationContext注入給Car
                ((ApplicationContextAware) bean).setApplicationContext(this.applicationContext);
            }
        }
    }

    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) {
        return bean;
    }

}

InitDestroyAnnotationBeanPostProcessor

InitDestroyAnnotationBeanPostProcessor后置處理器是用來處理自定義的初始化方法和銷毀方法。Spring中提供了3種自定義初始化和銷毀方法：

  1. 通過@Bean指定init-method和destroy-method屬性
  2. Bean實現(xiàn)InitializingBean（定義初始化邏輯），DisposableBean（定義銷毀邏輯）;
  3. @PostConstruct：在bean創(chuàng)建完成并且屬性賦值完成；來執(zhí)行初始化方法@PreDestroy：在容器銷毀bean之前通知我們進行清理工作

InitDestroyAnnotationBeanPostProcessor的作用就是讓第3種方式生效。先看看如何使用@PostConstruct和@PreDestroy注解。

@Component
public class Car {

    public Car(){
        System.out.println("car instance...");
    }

    /**
     * 自定義的初始化方法
     */
    @PostConstruct
    public void init(){
        System.out.println("car ... init...");
    }

    /**
     * 自定義的銷毀方法
     */
    @PreDestroy
    public void detory(){
        System.out.println("car ... detory...");
    }
}

InitDestroyAnnotationBeanPostProcessor會在Bean創(chuàng)建的時候通過反射的方式查找包含@PostConstruct和@PreDestroy注解的方法，然后再通過反射執(zhí)行方法。我們來看看InitDestroyAnnotationBeanPostProcessor.postProcessBeforeInitialization()的源碼

public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
    // 獲取bean的metadata
    LifecycleMetadata metadata = findLifecycleMetadata(bean.getClass());
    try {
        // 執(zhí)行@PostConstruct指定的init方法
        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, "Failed to invoke init method", ex);
    }
    return bean;
}

metadata中已經(jīng)解析出initMethods和destroyMethods，其具體內(nèi)容如下。


metadata.invokeInitMethods(bean, beanName);就是根據(jù)反射執(zhí)行init方法。

InstantiationAwareBeanPostProcessor

InstantiationAwareBeanPostProcessor是BeanPostProcessor的子接口。

public interface InstantiationAwareBeanPostProcessor extends BeanPostProcessor {

    //實例化Bean之前調(diào)用
    Object postProcessBeforeInstantiation(Class<?> beanClass, String beanName) throws BeansException;

    //實例化Bean之后調(diào)用
    boolean postProcessAfterInstantiation(Object bean, String beanName) throws BeansException;

    //設(shè)置Bean對象中的某個屬性時調(diào)用
    PropertyValues postProcessPropertyValues(
            PropertyValues pvs, PropertyDescriptor[] pds, Object bean, String beanName) throws BeansException;

}

這兩個接口的功能基本類似，不過要注意InstantiationAwareBeanPostProcessor和BeanPostProcessor的方法名區(qū)別。InstantiationAwareBeanPostProcessor中是Instantiation， 而BeanPostProcessor是Initialization。
參考閱讀
https://blog.csdn.net/chjttony/article/details/6301591
Spring開閉原則的表現(xiàn)-BeanPostProcessor擴展點-2

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 1.1 spring IoC容器和beans的簡介 Spring 框架的最核心基礎(chǔ)的功能是IoC（控制反轉(zhuǎn)）容器，...
    simoscode閱讀 6,844評論 2贊 22
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具（例如配置管理，服務(wù)發(fā)現(xiàn)，斷路器，智...
    卡卡羅2017閱讀 136,506評論 19贊 139
  • 什么是Spring Spring是一個開源的Java EE開發(fā)框架。Spring框架的核心功能可以應(yīng)用在任何Jav...
    jemmm閱讀 16,765評論 1贊 133
  • js同步異步以及回調(diào)函數(shù) 1.背景介紹 什么是同步，什么是異步? 同步指的是一次只能完成一件任務(wù)。如果有多個任務(wù)，...
    慕瑾大大閱讀 849評論 0贊 4
  • 今天是感恩節(jié)！感謝父母，恩重如山，感謝老師，恩深似海，感謝我最愛的愛人，愿我們恩愛有加，事業(yè)步步高升，感恩節(jié)到了，...
    最美的芹天閱讀 449評論 0贊 0

友情鏈接更多精彩內(nèi)容