Spring中的BeanPostProcessor詳解

前言

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

public interface BeanPostProcessor {


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

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

}

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

自定義BeanPostProcessor

查看BeanPostProcessor源碼,可以看到它兩個方法的參數都相同,其中第一個參數Object bean表示當前正在初始化的bean對象。此外兩個方法都返回Object類型的實例,返回值既可以是將入參Object bean原封不動的返回出去,也可以對當前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之后,針對容器中每個創建的Bean對象(Spring自身創建的Bean和應用程序創建的Bean),都會回調postProcessBeforeInitializationpostProcessAfterInitialization方法。

執行原理

BeanPostProcessor的執行是定義在容器的刷新過程中,容器刷新對象具體的方法為:AbstractApplicationContext.refresh()
在refresh方法執行的調用棧中會去調用AbstractAutowireCapableBeanFactory.doCreateBean()方法,該方法節選源碼如下

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;
}

看到在調用初始化方法前后會分別調用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,然后一次執行postProcessBeforeInitialization,一但返回null,就跳出for循環不執行后面的BeanPostProcessor.postProcessorsBeforeInitialization()。也就是說如果返回的是null那么我們通過getBean方法將得不到目標Bean。
applyBeanPostProcessorsBeforeInitialization()方法的邏輯和上面一致,就是將循環執行的beanProcessor.postProcessBeforeInitialization()替換成beanProcessor.postProcessAfterInitialization()
Spring底層的很多功能特性都是借助BeanPostProcessor的子類來實現。

常見BeanPostProcessor分析

下圖是debug過程中,ApplicationContext對象中的包含的BeanPostProcessor。具體包含哪些BeanPostProcessor和具體應用程序相關,除了下標3中的MyBeanPostProcessor為自定義的BeanPostProcessor,其余均為Spring自帶的BeanPostProcessor。


下面來分析一下ApplicationContextAwareProcessorAutowiredAnnotationProcessor的執行原理。

ApplicationContextAwareProcessor

ApplicationContextAwareProcessor后置處理器的作用是,當應用程序定義的Bean實現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是如何通過實現ApplicationContextAware接口就能獲得ApplicationContext對象呢?答案是通過ApplicationContextAwareProcessor后置處理器來實現,我們來看看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,它實現了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) {
                // 會執行這里回調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實現InitializingBean(定義初始化邏輯),DisposableBean(定義銷毀邏輯);
  3. @PostConstruct:在bean創建完成并且屬性賦值完成;來執行初始化方法@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創建的時候通過反射的方式查找包含@PostConstruct@PreDestroy注解的方法,然后再通過反射執行方法。我們來看看InitDestroyAnnotationBeanPostProcessor.postProcessBeforeInitialization()的源碼

public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
    // 獲取bean的metadata
    LifecycleMetadata metadata = findLifecycleMetadata(bean.getClass());
    try {
        // 執行@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中已經解析出initMethods和destroyMethods,其具體內容如下。


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

InstantiationAwareBeanPostProcessor

InstantiationAwareBeanPostProcessorBeanPostProcessor的子接口。

public interface InstantiationAwareBeanPostProcessor extends BeanPostProcessor {

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

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

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

}

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

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,505評論 6 533
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,556評論 3 418
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,463評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,009評論 1 312
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,778評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,218評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,281評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,436評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,969評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,795評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,993評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,537評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,229評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,659評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,917評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,687評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,990評論 2 374

推薦閱讀更多精彩內容

  • 1.1 spring IoC容器和beans的簡介 Spring 框架的最核心基礎的功能是IoC(控制反轉)容器,...
    simoscode閱讀 6,741評論 2 22
  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,785評論 18 139
  • 什么是Spring Spring是一個開源的Java EE開發框架。Spring框架的核心功能可以應用在任何Jav...
    jemmm閱讀 16,508評論 1 133
  • js同步異步以及回調函數 1.背景介紹 什么是同步,什么是異步? 同步指的是一次只能完成一件任務。如果有多個任務,...
    慕瑾大大閱讀 829評論 0 4
  • 今天是感恩節!感謝父母,恩重如山,感謝老師,恩深似海,感謝我最愛的愛人,愿我們恩愛有加,事業步步高升,感恩節到了,...
    最美的芹天閱讀 431評論 0 0