1. 程式人生 > >Spring 註冊BeanPostProcessor 原始碼閱讀

Spring 註冊BeanPostProcessor 原始碼閱讀

回顧上一篇部落格中,在AbstractApplicationContext這個抽象類中,Spring使用invokeBeanFactoryPostProcessors(beanFactory);執行BeanFactoryPostProcessor,通過回撥Spring自己新增的ConfigurationClassPostProcessor以及使用者新增的bean工廠的後置處理器,完成了包掃描以及對主配置類代理的工作

本篇博文將繼續往下跟進

程式入口:註冊bean的後置處理器

AbstractApplicationContextregisterBeanPostProcessors(beanFactory);

方法

通過方法名字,見名知意, 註冊bean的後置處理器, 說白了就是將系統中所有的bean的後置處理器統一交給Spring的beanFactory管理

那麼問題來了

什麼是BeanPostProcessor? 有什麼作用?

Bean的後置處理器,首先來說,他是Spring中抽象出來的一個頂級的介面, 他裡面有如下有如下兩個方法, 這兩個方法的執行時機通過方法的名字也能猜的出, 一個是在構造方法之後,init()方法之前,第二個是在init()方法之後執行

public interface BeanPostProcessor {
@Nullable
    default Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
        return bean;
    }
@Nullable
    default Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
        return bean;
    }
}

大家說它是Spring對外提供的拓展點,也許是因為,通過實現這個介面,程式設計師可以被Spring管理的bean的生命週期進行插手

這也體現了AOP的設計思想,就比如在init()方法執行前後做出不同的動作,其實就是對bean的一種增強

此外BeanPostProcessor可以存在多個,他們會被儲存在一個列表中,然後依次被執行

為什麼要註冊BeanPostProcessor?

所謂的註冊,只不過是對當前上下文中所有的BeanPostProcessor進行一種集中式管理罷了, 為什麼非得這麼做呢? 因為上下文中BeanPostProcessor的數量不是一成不變的,Spring為了啟動的正常,需要新增原生的BeanPostProcessor

,程式設計師因為自己的需求也會新增不同數量的bean的後置處理器,因此需要這種策略,將上下文中所有的後置處理器進行統一的管理,方便回撥

原始碼閱讀:

這段程式碼的邏輯很清楚簡明: 首先,根據型別從當前的上面中取出所有的BeanPostProcessor的實現類,那麼問題來了,當前上下文中有幾個呢?如下圖:

這三個中的前兩個後置還處理器是在prepareBeanFactory()時新增進去的,第三個是在為主配置類生成代理時傳遞進去的

緊接著呼叫beanFactory.getBeanNamesForType(BeanPostProcessor.class, true, false),結果如下圖

前三個處理器是不是很熟悉? 沒錯,他們是建立AnnotationedBeanDefinitionReader時建立的6個RootBeanDefinition中 的第4-5-6個, 其中的AutowiredAnnotationBeanPostProcessor的主要功能是處理@Autowired註解,並且解決了setter方式的迴圈依賴問題, CommonAnnotationBeanPostProcessor 主要處理@Resource @PostConstructor @PreDestory註解
RequiredAnnotationBeanPostProcessor處理@Required註解, 上圖中的最後一個註解是``

在下面的程式碼中,Spring開始根據不同的處理器的註解標註情況,介面的實現情況進行排序處理, 並且又添加了兩個後置處理器

public static void registerBeanPostProcessors(
        ConfigurableListableBeanFactory beanFactory, AbstractApplicationContext applicationContext) {
    // 根據型別從beanFactory中取出所有實現BeanPostProcessor介面的實現類的名字
    String[] postProcessorNames = beanFactory.getBeanNamesForType(BeanPostProcessor.class, true, false);

    int beanProcessorTargetCount = beanFactory.getBeanPostProcessorCount() + 1 + postProcessorNames.length;
    // 這是個內部類,用來檢查是否在bean的建立過程中,經過了所有本來應經過的後置處理器
    beanFactory.addBeanPostProcessor(new BeanPostProcessorChecker(beanFactory, beanProcessorTargetCount));

    List<BeanPostProcessor> priorityOrderedPostProcessors = new ArrayList<>();
    List<BeanPostProcessor> internalPostProcessors = new ArrayList<>();
    List<String> orderedPostProcessorNames = new ArrayList<>();
    List<String> nonOrderedPostProcessorNames = new ArrayList<>();
    
    // 將新增執行註解,實現排序介面的beanPostProcessor新增到相應的集合中
    for (String ppName : postProcessorNames) {
        if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) {
            BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class);
            priorityOrderedPostProcessors.add(pp);
            if (pp instanceof MergedBeanDefinitionPostProcessor) {
                internalPostProcessors.add(pp);
            }
        }
        else if (beanFactory.isTypeMatch(ppName, Ordered.class)) {
            orderedPostProcessorNames.add(ppName);
        }
        else {
            nonOrderedPostProcessorNames.add(ppName);
        }
    }
    // 按照優先順序排序
    sortPostProcessors(priorityOrderedPostProcessors, beanFactory);
    // 批量註冊priorityOrderedPostProcessors中的bean的後置處理器
    registerBeanPostProcessors(beanFactory, priorityOrderedPostProcessors);

    List<BeanPostProcessor> orderedPostProcessors = new ArrayList<>();
    for (String ppName : orderedPostProcessorNames) {
        BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class);
        orderedPostProcessors.add(pp);
        if (pp instanceof MergedBeanDefinitionPostProcessor) {
            internalPostProcessors.add(pp);
        }
    }
    // 再次排序,註冊
    sortPostProcessors(orderedPostProcessors, beanFactory);
    registerBeanPostProcessors(beanFactory, orderedPostProcessors);

    // Now, register all regular BeanPostProcessors.
    // todo 現在註冊 全部 正常的沒有排序的BeanPostProcessor
    List<BeanPostProcessor> nonOrderedPostProcessors = new ArrayList<>();
    for (String ppName : nonOrderedPostProcessorNames) {
        BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class);
        nonOrderedPostProcessors.add(pp);
        if (pp instanceof MergedBeanDefinitionPostProcessor) {
            internalPostProcessors.add(pp);
        }
    }
    // 再次排序,註冊
    registerBeanPostProcessors(beanFactory, nonOrderedPostProcessors);
    sortPostProcessors(internalPostProcessors, beanFactory);

    // Finally, re-register all internal BeanPostProcessors.
    // 最後註冊所有內建的BeanPostProcessor
    registerBeanPostProcessors(beanFactory, internalPostProcessors);

    //這裡又添加了一個處理器
    beanFactory.addBeanPostProcessor(new ApplicationListenerDetector(applicationContext));
}

beanPostProcessor全部註冊到了AbstractBeanFactory中的下面這個欄位中

private final List<BeanPostProcessor> beanPostProcessors = new CopyOnWriteArrayList<>();