Spring IoC源码学习:invokeBeanFactoryPostProcessors 详解

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》点击传送门,即可获取!

小白也看得懂的 Spring IoC 核心流程介绍

Spring IoC源码学习:总览

Spring IoC源码学习:ApplicationContext 刷新前的配置

Spring IoC源码学习:obtainFreshBeanFactory详解

Spring IoC源码学习:parseDefaultElement详解

Spring IoC源码学习:parseCustomElement详解

Spring IoC源码学习:context:component-scan 节点详解

Spring IoC源码学习:invokeBeanFactoryPostProcessors详解

Spring IoC源码学习:registerBeanPostProcessors详解

Spring IoC源码学习:finishBeanFactoryInitialization详解

Spring IoC源码学习:getBean详解

Spring IoC源码学习:createBean详解(上)

Spring IoC源码学习:createBean详解(下)

Spring IoC源码学习:@Autowire 详解

Spring IoC源码学习:finishRefresh 详解

前言

==

随着 Spring IoC:context:component-scan节点解析 的结束,obtainFreshBeanFactory 方法的解析也告一段落,我们通过5篇文章,完整的介绍了obtainFreshBeanFactory 方法。本文将介绍 obtainFreshBeanFactory 方法之后的另一个重要方法——invokeBeanFactoryPostProcessors。

概述

==

本方法会实例化和调用所有 BeanFactoryPostProcessor(包括其子类 BeanDefinitionRegistryPostProcessor)。

BeanFactoryPostProcessor 接口是 Spring 初始化 BeanFactory 时对外暴露的扩展点,Spring IoC 容器允许 BeanFactoryPostProcessor 在容器实例化任何 bean 之前读取 bean 的定义,并可以修改它。

BeanDefinitionRegistryPostProcessor 继承自 BeanFactoryPostProcessor,比 BeanFactoryPostProcessor 具有更高的优先级,主要用来在常规的 BeanFactoryPostProcessor 检测开始之前注册其他 bean 定义。特别是,你可以通过 BeanDefinitionRegistryPostProcessor 来注册一些常规的 BeanFactoryPostProcessor,因为此时所有常规的 BeanFactoryPostProcessor 都还没开始被处理。

注:这边的 “常规 BeanFactoryPostProcessor” 主要用来跟 BeanDefinitionRegistryPostProcessor 区分。

正文

==

首先我们回到 AbstractApplicationContext.refresh() 方法,找到代码:invokeBeanFactoryPostProcessors(beanFactory) ,单击该行代码跳转到具体的实现。

invokeBeanFactoryPostProcessors


protected void invokeBeanFactoryPostProcessors(ConfigurableListableBeanFactory beanFactory) {

// 1.getBeanFactoryPostProcessors(): 拿到当前应用上下文beanFactoryPostProcessors变量中的值

// 2.invokeBeanFactoryPostProcessors: 实例化并调用所有已注册的BeanFactoryPostProcessor

PostProcessorRegistrationDelegate.invokeBeanFactoryPostProcessors(beanFactory, getBeanFactoryPostProcessors());

// Detect a LoadTimeWeaver and prepare for weaving, if found in the meantime

// (e.g. through an @Bean method registered by ConfigurationClassPostProcessor)

if (beanFactory.getTempClassLoader() == null && beanFactory.containsBean(LOAD_TIME_WEAVER_BEAN_NAME)) {

beanFactory.addBeanPostProcessor(new LoadTimeWeaverAwareProcessor(beanFactory));

beanFactory.setTempClassLoader(new ContextTypeMatchClassLoader(beanFactory.getBeanClassLoader()));

}

}

1.拿到当前应用上下文 beanFactoryPostProcessors 变量中的值,见代码块1详解

2.实例化并调用所有已注册的 BeanFactoryPostProcessor,见代码块2详解

代码块1:getBeanFactoryPostProcessors


public List getBeanFactoryPostProcessors() {

return this.beanFactoryPostProcessors;

}

这边 getBeanFactoryPostProcessors() 会拿到当前应用上下文中已经注册的 BeanFactoryPostProcessor,在默认情况下,this.beanFactoryPostProcessors 是返回空的。

如何添加自定义 BeanFactoryPostProcessor 到 this.beanFactoryPostProcessors 变量中了?

如果还有印象的话,我们在 Spring IoC:refresh前的环境准备 中的代码块12介绍过 customizeContext 方法,该方法是 Spring 提供给开发者的一个扩展点,用于自定义应用上下文,并且在 refresh() 方法前就被调用。在这边就可以通过该方法来添加自定义的 BeanFactoryPostProcessor。

简单的实现如下:

1.新建一个 ApplicationContextInitializer 的实现类 SpringApplicationContextInitializer ,并在 initialize 方法中写我们的逻辑。

package com.joonwhee.open.demo.spring;

import org.springframework.context.ApplicationContextInitializer;

import org.springframework.context.ConfigurableApplicationContext;

/**

  • @author joonwhee

  • @date 2019/1/19

*/

public class SpringApplicationContextInitializer implements ApplicationContextInitializer {

@Override

public void initialize(ConfigurableApplicationContext applicationContext) {

FirstBeanDefinitionRegistryPostProcessor firstBeanDefinitionRegistryPostProcessor = new FirstBeanDefinitionRegistryPostProcessor();

// 将自定义的firstBeanDefinitionRegistryPostProcessor添加到应用上下文中

applicationContext.addBeanFactoryPostProcessor(firstBeanDefinitionRegistryPostProcessor);

// …自定义操作

System.out.println(“SpringApplicationContextInitializer#initialize”);

}

}

2.将 SpringApplicationContextInitializer 作为初始化参数 contextInitializerClasses 配置到 web.xml 中。

contextInitializerClasses

com.joonwhee.open.demo.spring.SpringApplicationContextInitializer

这样,在启动应用时,FirstBeanDefinitionRegistryPostProcessor 就会被添加到 this.beanFactoryPostProcessors 中。

代码块2:invokeBeanFactoryPostProcessors


public static void invokeBeanFactoryPostProcessors(

ConfigurableListableBeanFactory beanFactory, List beanFactoryPostProcessors) {

// Invoke BeanDefinitionRegistryPostProcessors first, if any.

Set processedBeans = new HashSet();

// 1.判断beanFactory是否为BeanDefinitionRegistry,beanFactory为DefaultListableBeanFactory,

// 而DefaultListableBeanFactory实现了BeanDefinitionRegistry接口,因此这边为true

if (beanFactory instanceof BeanDefinitionRegistry) {

BeanDefinitionRegistry registry = (BeanDefinitionRegistry) beanFactory;

// 用于存放普通的BeanFactoryPostProcessor

List regularPostProcessors = new LinkedList();

// 用于存放BeanDefinitionRegistryPostProcessor

List registryProcessors = new LinkedList();

// 2.首先处理入参中的beanFactoryPostProcessors

// 遍历所有的beanFactoryPostProcessors, 将BeanDefinitionRegistryPostProcessor和普通BeanFactoryPostProcessor区分开

for (BeanFactoryPostProcessor postProcessor : beanFactoryPostProcessors) {

if (postProcessor instanceof BeanDefinitionRegistryPostProcessor) {

// 2.1 如果是BeanDefinitionRegistryPostProcessor

BeanDefinitionRegistryPostProcessor registryProcessor =

(BeanDefinitionRegistryPostProcessor) postProcessor;

// 2.1.1 直接执行BeanDefinitionRegistryPostProcessor接口的postProcessBeanDefinitionRegistry方法

registryProcessor.postProcessBeanDefinitionRegistry(registry);

// 2.1.2 添加到registryProcessors(用于最后执行postProcessBeanFactory方法)

registryProcessors.add(registryProcessor);

} else {

// 2.2 否则,只是普通的BeanFactoryPostProcessor

// 2.2.1 添加到regularPostProcessors(用于最后执行postProcessBeanFactory方法)

regularPostProcessors.add(postProcessor);

}

}

// Do not initialize FactoryBeans here: We need to leave all regular beans

// uninitialized to let the bean factory post-processors apply to them!

// Separate between BeanDefinitionRegistryPostProcessors that implement

// PriorityOrdered, Ordered, and the rest.

// 用于保存本次要执行的BeanDefinitionRegistryPostProcessor

List currentRegistryProcessors = new ArrayList();

// First, invoke the BeanDefinitionRegistryPostProcessors that implement PriorityOrdered.

// 3.调用所有实现PriorityOrdered接口的BeanDefinitionRegistryPostProcessor实现类

// 3.1 找出所有实现BeanDefinitionRegistryPostProcessor接口的Bean的beanName

String[] postProcessorNames =

beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false);

// 3.2 遍历postProcessorNames

for (String ppName : postProcessorNames) {

// 3.3 校验是否实现了PriorityOrdered接口

if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) {

// 3.4 获取ppName对应的bean实例, 添加到currentRegistryProcessors中,

// beanFactory.getBean: 这边getBean方法会触发创建ppName对应的bean对象, 目前暂不深入解析

currentRegistryProcessors.add(beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class));

// 3.5 将要被执行的加入processedBeans,避免后续重复执行

processedBeans.add(ppName);

}

}

// 3.6 进行排序(根据是否实现PriorityOrdered、Ordered接口和order值来排序)

sortPostProcessors(currentRegistryProcessors, beanFactory);

// 3.7 添加到registryProcessors(用于最后执行postProcessBeanFactory方法)

registryProcessors.addAll(currentRegistryProcessors);

// 3.8 遍历currentRegistryProcessors, 执行postProcessBeanDefinitionRegistry方法

invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry);

// 3.9 执行完毕后, 清空currentRegistryProcessors

currentRegistryProcessors.clear();

// Next, invoke the BeanDefinitionRegistryPostProcessors that implement Ordered.

// 4.调用所有实现了Ordered接口的BeanDefinitionRegistryPostProcessor实现类(过程跟上面的步骤3基本一样)

// 4.1 找出所有实现BeanDefinitionRegistryPostProcessor接口的类, 这边重复查找是因为执行完上面的BeanDefinitionRegistryPostProcessor,

// 可能会新增了其他的BeanDefinitionRegistryPostProcessor, 因此需要重新查找

postProcessorNames = beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false);

for (String ppName : postProcessorNames) {

// 校验是否实现了Ordered接口,并且还未执行过

if (!processedBeans.contains(ppName) && beanFactory.isTypeMatch(ppName, Ordered.class)) {

currentRegistryProcessors.add(beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class));

processedBeans.add(ppName);

}

}

sortPostProcessors(currentRegistryProcessors, beanFactory);

registryProcessors.addAll(currentRegistryProcessors);

// 4.2 遍历currentRegistryProcessors, 执行postProcessBeanDefinitionRegistry方法

invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry);

currentRegistryProcessors.clear();

// Finally, invoke all other BeanDefinitionRegistryPostProcessors until no further ones appear.

// 5.最后, 调用所有剩下的BeanDefinitionRegistryPostProcessors

boolean reiterate = true;

while (reiterate) {

reiterate = false;

// 5.1 找出所有实现BeanDefinitionRegistryPostProcessor接口的类

postProcessorNames = beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false);

for (String ppName : postProcessorNames) {

// 5.2 跳过已经执行过的

if (!processedBeans.contains(ppName)) {

currentRegistryProcessors.add(beanFactory.getBean(ppName, BeanDefinitionRegistryPostProcessor.class));

processedBeans.add(ppName);

// 5.3 如果有BeanDefinitionRegistryPostProcessor被执行, 则有可能会产生新的BeanDefinitionRegistryPostProcessor,

// 因此这边将reiterate赋值为true, 代表需要再循环查找一次

reiterate = true;

}

}

sortPostProcessors(currentRegistryProcessors, beanFactory);

registryProcessors.addAll(currentRegistryProcessors);

// 5.4 遍历currentRegistryProcessors, 执行postProcessBeanDefinitionRegistry方法

invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry);

currentRegistryProcessors.clear();

}

// Now, invoke the postProcessBeanFactory callback of all processors handled so far.

// 6.调用所有BeanDefinitionRegistryPostProcessor的postProcessBeanFactory方法(BeanDefinitionRegistryPostProcessor继承自BeanFactoryPostProcessor)

invokeBeanFactoryPostProcessors(registryProcessors, beanFactory);

// 7.最后, 调用入参beanFactoryPostProcessors中的普通BeanFactoryPostProcessor的postProcessBeanFactory方法

invokeBeanFactoryPostProcessors(regularPostProcessors, beanFactory);

} else {

// Invoke factory processors registered with the context instance.

invokeBeanFactoryPostProcessors(beanFactoryPostProcessors, beanFactory);

}

// 到这里 , 入参beanFactoryPostProcessors和容器中的所有BeanDefinitionRegistryPostProcessor已经全部处理完毕,

// 下面开始处理容器中的所有BeanFactoryPostProcessor

// Do not initialize FactoryBeans here: We need to leave all regular beans

// uninitialized to let the bean factory post-processors apply to them!

// 8.找出所有实现BeanFactoryPostProcessor接口的类

String[] postProcessorNames =

beanFactory.getBeanNamesForType(BeanFactoryPostProcessor.class, true, false);

// Separate between BeanFactoryPostProcessors that implement PriorityOrdered,

// Ordered, and the rest.

// 用于存放实现了PriorityOrdered接口的BeanFactoryPostProcessor

List priorityOrderedPostProcessors = new ArrayList();

// 用于存放实现了Ordered接口的BeanFactoryPostProcessor的beanName

List orderedPostProcessorNames = new ArrayList();

// 用于存放普通BeanFactoryPostProcessor的beanName

List nonOrderedPostProcessorNames = new ArrayList();

// 8.1 遍历postProcessorNames, 将BeanFactoryPostProcessor按实现PriorityOrdered、实现Ordered接口、普通三种区分开

for (String ppName : postProcessorNames) {

// 8.2 跳过已经执行过的

if (processedBeans.contains(ppName)) {

// skip - already processed in first phase above

} else if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) {

// 8.3 添加实现了PriorityOrdered接口的BeanFactoryPostProcessor

priorityOrderedPostProcessors.add(beanFactory.getBean(ppName, BeanFactoryPostProcessor.class));

} else if (beanFactory.isTypeMatch(ppName, Ordered.class)) {

// 8.4 添加实现了Ordered接口的BeanFactoryPostProcessor的beanName

orderedPostProcessorNames.add(ppName);

} else {

// 8.5 添加剩下的普通BeanFactoryPostProcessor的beanName

nonOrderedPostProcessorNames.add(ppName);

}

}

// First, invoke the BeanFactoryPostProcessors that implement PriorityOrdered.

// 9.调用所有实现PriorityOrdered接口的BeanFactoryPostProcessor

// 9.1 对priorityOrderedPostProcessors排序

sortPostProcessors(priorityOrderedPostProcessors, beanFactory);

// 9.2 遍历priorityOrderedPostProcessors, 执行postProcessBeanFactory方法

invokeBeanFactoryPostProcessors(priorityOrderedPostProcessors, beanFactory);

// Next, invoke the BeanFactoryPostProcessors that implement Ordered.

// 10.调用所有实现Ordered接口的BeanFactoryPostProcessor

List orderedPostProcessors = new ArrayList();

for (String postProcessorName : orderedPostProcessorNames) {

// 10.1 获取postProcessorName对应的bean实例, 添加到orderedPostProcessors, 准备执行

orderedPostProcessors.add(beanFactory.getBean(postProcessorName, BeanFactoryPostProcessor.class));

}

// 10.2 对orderedPostProcessors排序

sortPostProcessors(orderedPostProcessors, beanFactory);

// 10.3 遍历orderedPostProcessors, 执行postProcessBeanFactory方法

invokeBeanFactoryPostProcessors(orderedPostProcessors, beanFactory);

// Finally, invoke all other BeanFactoryPostProcessors.

// 11.调用所有剩下的BeanFactoryPostProcessor

List nonOrderedPostProcessors = new ArrayList();

for (String postProcessorName : nonOrderedPostProcessorNames) {

// 11.1 获取postProcessorName对应的bean实例, 添加到nonOrderedPostProcessors, 准备执行

nonOrderedPostProcessors.add(beanFactory.getBean(postProcessorName, BeanFactoryPostProcessor.class));

}

// 11.2 遍历nonOrderedPostProcessors, 执行postProcessBeanFactory方法

invokeBeanFactoryPostProcessors(nonOrderedPostProcessors, beanFactory);

// Clear cached merged bean definitions since the post-processors might have

// modified the original metadata, e.g. replacing placeholders in values…

// 12.清除元数据缓存(mergedBeanDefinitions、allBeanNamesByType、singletonBeanNamesByType),

// 因为后处理器可能已经修改了原始元数据,例如, 替换值中的占位符…

beanFactory.clearMetadataCache();

}

1.判断 beanFactory 是否为 BeanDefinitionRegistry。beanFactory 是在之前的 obtainFreshBeanFactory 方法构建的,具体代码在:AbstractRefreshableApplicationContext.refreshBeanFactory() 方法,代码如下。

@Override

protected final void refreshBeanFactory() throws BeansException {

if (hasBeanFactory()) {

destroyBeans();

closeBeanFactory();

}

try {

// 创建一个新的BeanFactory

DefaultListableBeanFactory beanFactory = createBeanFactory();

beanFactory.setSerializationId(getId());

customizeBeanFactory(beanFactory);

loadBeanDefinitions(beanFactory);

synchronized (this.beanFactoryMonitor) {

this.beanFactory = beanFactory;

}

}

catch (IOException ex) {

throw new ApplicationContextException("I/O error parsing bean definition source for " + getDisplayName(), ex);

}

}

可以看出,我们构建的 beanFactory 是一个 DefaultListableBeanFactory ,而 DefaultListableBeanFactory 实现了BeanDefinitionRegistry 接口,因此 beanFactory instanceof BeanDefinitionRegistry 结果为 true。

3.4 获取 ppName 对应的 bean 实例,添加到 currentRegistryProcessors 中,准备执行。beanFactory.getBean 方法会触发创建 ppName 对应的 bean 实例对象,创建 bean 实例是 IoC 的另一个核心内容,之后会单独解析,目前暂不深入解析。

3.6 进行排序,该方法在下面也被调用了好几次,见代码块3详解。

代码块3:sortPostProcessors


private static void sortPostProcessors(List<?> postProcessors, ConfigurableListableBeanFactory beanFactory) {

Comparator comparatorToUse = null;

if (beanFactory instanceof DefaultListableBeanFactory) {

// 1.获取设置的比较器

comparatorToUse = ((DefaultListableBeanFactory) beanFactory).getDependencyComparator();

}

if (comparatorToUse == null) {

// 2.如果没有设置比较器, 则使用默认的OrderComparator

comparatorToUse = OrderComparator.INSTANCE;

}

// 3.使用比较器对postProcessors进行排序

Collections.sort(postProcessors, comparatorToUse);

}

默认情况下,比较器为 OrderComparator;如果配置了 annotation-config,并且值为true,使用的是 AnnotationAwareOrderComparator( Spring IoC:context:component-scan节点解析 代码块17中设置了dependencyComparator 属性为 AnnotationAwareOrderComparator.INSTANCE),AnnotationAwareOrderComparator 继承自 OrderComparator,只是重写了部分方法,比较器的部分代码如下:

@Override

public int compare(Object o1, Object o2) {

return doCompare(o1, o2, null);

}

private int doCompare(Object o1, Object o2, OrderSourceProvider sourceProvider) {

// 判断o1是否实现了PriorityOrdered接口

boolean p1 = (o1 instanceof PriorityOrdered);

// 判断o2是否实现了PriorityOrdered接口

boolean p2 = (o2 instanceof PriorityOrdered);

// 1.如果o1实现了PriorityOrdered接口, 而o2没有, 则o1排前面

if (p1 && !p2) {

return -1;

最后

分布式技术专题+面试解析+相关的手写和学习的笔记pdf

还有更多Java笔记分享如下:

image

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》点击传送门,即可获取!
encyComparator 属性为 AnnotationAwareOrderComparator.INSTANCE),AnnotationAwareOrderComparator 继承自 OrderComparator,只是重写了部分方法,比较器的部分代码如下:

@Override

public int compare(Object o1, Object o2) {

return doCompare(o1, o2, null);

}

private int doCompare(Object o1, Object o2, OrderSourceProvider sourceProvider) {

// 判断o1是否实现了PriorityOrdered接口

boolean p1 = (o1 instanceof PriorityOrdered);

// 判断o2是否实现了PriorityOrdered接口

boolean p2 = (o2 instanceof PriorityOrdered);

// 1.如果o1实现了PriorityOrdered接口, 而o2没有, 则o1排前面

if (p1 && !p2) {

return -1;

最后

分布式技术专题+面试解析+相关的手写和学习的笔记pdf

还有更多Java笔记分享如下:

[外链图片转存中…(img-fzEazUqm-1714751602694)]

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》点击传送门,即可获取!

  • 30
    点赞
  • 11
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值