【Spring源码:循环依赖】一文弄懂Spring循环依赖

1. 什么是循坏依赖

很简单,其实就是互相依赖对方,比如,有一个A对象依赖了B对象,B对象又依赖了A对象。


// A依赖了B
public class A{
    private B b;
}
 
// B依赖了A
public class B{
    private A a;
}

但是,在我们普通的java开发中,循坏依赖会出现问题吗?

如果不考虑Spring,循环依赖并不是问题,因为对象之间相互依赖注入是很正常的事情。

比如:

【Spring源码:循环依赖】一文弄懂Spring循环依赖_第1张图片

这样,A,B就互相依赖上了。

但是,在Spring中循环依赖就是一个问题了,为什么?

因为,在Spring中,一个对象并不是简单new出来了,而是会经过一系列的Spring Bean的生命周期,正是因为Bean的生命周期所以才会出现循环依赖问题。当然,在Spring中,出现循环依赖的场景很多,有的场景Spring自动帮我们解决了,而有的场景则需要程序员来解决,下面具体分析。

要明白Spring中的循环依赖,得先弄明白Spring中Bean的生命周期。

2. 前置知识

2.1 Spring bean 生命周期

这里不会对Bean的生命周期进行详细的分析,只描述一下大概的过程。

Bean的生命周期指的就是:在Spring启动中,Bean是如何生成的?

被Spring管理的对象叫做Bean。Bean的生成步骤如下:

class --> BeanDefinition --> 实例化(前后)--> 属性填充 --> 初始化(前后) --> bean 加入单例池

  1. Spring扫描class得到每个beanName对应的BeanDefinition;
  2. 根据得到的BeanDefinition去生成bean;
  3. 首先根据class推断构造方法;
  4. 根据推断出来的构造方法,反射,得到一个对象(暂时叫做原始对象/普通对象);
  5. 填充原始对象中的属性(依赖注入);
  6. 如果原始对象中的某个方法被AOP了,那么则需要根据原始对象生成一个代理对象;
  7. 把最终生成的代理对象放入单例池(源码中叫做singletonObjects)中,下次getBean时就直接从单例池拿即可。

可以发现,在Spring中,构造一个Bean,包括了new这个步骤(第4步构造方法反射-->实例化)。

通过反射构造了一个原始对象之后,就需要进行属性填充(依赖注入),注入的过程大致如下:

上面的A类需要注入一个B类的b属性,则当A实例化之后,就需要去给b属性赋值。在属性填充之前,会先去获得属性值,但是此时B对象还没有被实例化,所以需要先去实例化B才可以。此时递归的去构建B对象。同理,在创建B类的Bean的过程中,B类中也存在一个A类的a属性,在B实例化之后,进行属性填充,又去获取A对象(但是A正在创建中),从而形成循环依赖:

ABean创建-->依赖了B属性-->触发BBean创建--->B依赖了A属性--->需要ABean(但ABean还在创建过程中)

从而导致ABean创建不出来,BBean也创建不出来。

因此,下面我们具体分析,在Spring中,它帮我们解决了哪些场景的循环依赖。

2.2 主要用到4个集合缓存

  • Map singletonObjects (一级缓存)

    key:beanName,value:经历了spring完整生命周期的bean对象

  • Map earlySingletonObjects(二级缓存)

    key:beanName,value:不完整的单例对象,也就是还没有初始化完毕

  • Map> singletonFactories(三级缓存)

    key:beanName,value:单例工厂,用于创建beanName所对应的Bean对象

  • Set< String > singletonsCurrentlyInCreation

    set集合,存放正在创建的Bean的名称,创建完成后,从这个集合中删除。

3. 调试与分析

3.1 调试

@Component
public class A {

    @Autowired
    private B b;
}

@Component
public class B {

    @Autowired
    private A a;
}

@Configuration
@ComponentScan("com.example.demo.test")
public class AppConfig {
}

public class test {

    public static void main(String[] args) {
        AnnotationConfigApplicationContext annotationConfigApplicationContext =
                new AnnotationConfigApplicationContext(AppConfig.class);
    }
}

熟悉Spring Bean生命周期源码的读者,应该都知道,我们可以直接跟进在AbstractApplicationContext#refresh()中的代码:

// 完成所有剩余的非懒加载的单例bean的实例化与初始化过程
finishBeanFactoryInitialization(beanFactory);

继续跟进到 beanFactory.preInstantiateSingletons()

【Spring源码:循环依赖】一文弄懂Spring循环依赖_第2张图片

如上,遍历所有的beanNames,判断当前创建的bean是否是FactoryBean子类,这里A是一个普通的bean(非FactoryBean子类),所以直接执行到getBean(beanName),而getBean会调用doGetBean,则跟进到AbstractBeanFactory# doGetBean:

这里首先是 transformedBeanName(name) 对name进行格式化(如别名、&前缀的处理等),然后根据beanName去获取对应的bean 对象,getSingleton方法就是解决循环依赖的关键:

【Spring源码:循环依赖】一文弄懂Spring循环依赖_第3张图片

此时的beanName是“a“ 先从单例池(一级缓存)中找,此时肯定是找不到的,返回null。

isSingletonCurrentlyCreation方法是判断当前Bean是否在singletonsCurrentlyInCreation集合当中。此时也是没有的,返回false。那么就不会进第一个if,直接返回null值。

表示从缓存中获取不到 “a” 对应的Bean,方法返回后,回到 AbstractBeanFactory# doGetBean ,继续往下执行:

【Spring源码:循环依赖】一文弄懂Spring循环依赖_第4张图片

其中,方法:

// 第二个参数是 ObjectFactory,它是一个函数式接口,支持lambda表达式

getSIngleton(String beanName, ObjectFactory singletonFactory)

// 判断当前需要创建的bean是否正在被创建,如果不在则把他放到singletonsCurrentlyInCreation中标记为正在创建
// singletonsCurrentlyInCreation 该集合存放的都是正在创建的Bean的名字,创建完成后会从这个集合中删除
beforeSingletonCreation(beanName);

getSIngleton()方法中,当执行到上面这一句时,就会将当前正在创建的Bean的BeanName放入到 singletonsCurrentlyInCreation中,标志此bean正在创建中。

因此,此时singletonsCurrentlyInCreation集合中已经有a了。

接着,我们会调用上面的lambda表达式中的createBean()来创建Bean,进入到createBean()中,会发现它会调用doCreateBean()

【Spring源码:循环依赖】一文弄懂Spring循环依赖_第5张图片

AbstractAutowireCapableBeanFactory# doCreateBean,如下(省略部分代码):

	protected Object doCreateBean(final String beanName, final RootBeanDefinition mbd, final @Nullable Object[] args)
			throws BeanCreationException {

		// Instantiate the bean.
		BeanWrapper instanceWrapper = null;
		// 1、推断构造方法并且实例化bean对象
		instanceWrapper = createBeanInstance(beanName, mbd, args);
		final Object bean = instanceWrapper.getWrappedInstance();
		
		// 2、做一些合并bean定义的逻辑
		//...


		// 判断属于单例、并且允许循环依赖、在当前正在创建的beanName集合中
		boolean earlySingletonExposure = (mbd.isSingleton() && this.allowCircularReferences &&
				isSingletonCurrentlyInCreation(beanName));
		if (earlySingletonExposure) {

			// 重点:3、将当前正在创建的bean的单例工厂放入到SingletonFactories集合中(三级缓存)
			// 第二个参数,ObjectFactory属于函数式接口,只有getObject()一个方法,所以支持lambda表达式
			addSingletonFactory(beanName, () -> getEarlyBeanReference(beanName, mbd, bean));
		}

		// Initialize the bean instance.
		Object exposedObject = bean;
		try {

			// 4、填充属性--->循环依赖
			// populateBean中 会执行InstantiationAwareBeanPostProcessor中的postProcessAfterInstantiation,
			// 这是在对象实例化后,还没有进行属性填充的时候会调用的方法。如果此时该方法返回false,
			// 并且mbd.getDependencyCheck() 不需要check,则不会进行属性填充,否则继续走下面的逻辑

			// 【注意】提前动态代理(循环依赖),其实是在依赖注入的时候,也就是在populateBean属性填充方法内完成的
			populateBean(beanName, mbd, instanceWrapper);

			// 5、执行initializeBean,初始化Bean
			// 【注意】非提前生成代理对象(非循环依赖)是在属性填充populateBean完成之后,执行了initializeBean方法的里面进行的动态代理
			exposedObject = initializeBean(beanName, exposedObject, mbd);

		} 
    // ...
}

可以看到,首先是通过构造创建了一个A的原始对象(实例化),然后当执行到第3点时,在填充A的属性之前,会将创建A Bean的工厂放入到singletonFactories(三级缓存)中。

addSingletonFactory(beanName, () -> getEarlyBeanReference(beanName, mbd, bean));

因此,此时singletonFactories(三级缓存)中存在了A的ObjectFactory。

紧接着,就是初始化的过程,调用populateBean(),下面具体分析。

AbstractAutowireCapableBeanFactory# populateBean

【Spring源码:循环依赖】一文弄懂Spring循环依赖_第6张图片

在属性填充之前,会先去获得对应的属性值,A需要注入B的属性值,但是此时的B对象还没有被实例化,所以需要先去实例化B才可以,此时递归的去构建B对象。

同理,在构建B时:

  1. 先根据beanName去单例池中获取,B也是正在创建中,显然获取不到,然后接着会将当前正在创建的B的BeanName放入到 singletonsCurrentlyInCreation中;
  2. 继续往下执行到doCreateBean()方法中,同样,当执行到addSingletonFactory()时,会将b对应的bean工厂放到singletonFactories(三级缓存)中;
  3. 接下来是初始化的过程,调用populateBean(),对B的属性进行赋值填充,填充前就需要先去获取属性值-a;
  4. 最后代码又递归回到 AbstractBeanFactory# doGetBean,即又去获取A对象...

下面,我们将分析,此时再次获取A对象过程的差异:

首先还是调用getSingleton()从缓存中获取,进入getSingleton方法看能否得到A的实例:

【Spring源码:循环依赖】一文弄懂Spring循环依赖_第7张图片

我们上面已经分析,此时单例池 singletonObjects(一级缓存)是还没有A对象的,所以代码中的singletonObject=null;然后是调用 isSingletonCurrentlyInCreation(a),显然此时 singletonsCurrentlyInCreation 是有 “a” 的,所以返回true,所以能进入if代码块。接着就是去二级缓存earlySingletonObjects中获取A对象,并没有。最后,从三级缓存singletonFactories中发现了有可以生产A的Bean的工厂对象。则通过工厂对象生成了一个A的原始对象,将这个A对象添加到earlySingletonObjects集合当中。然后将这个工厂对象从工厂集合中删除,完成了它的使命。

此时,我们看一下,4个集合中分别有什么:

  • singletonObjects:
  • earlySingletonObjects:A的原始对象
  • singletonFactories:B的对象工厂
  • singletonsCurrentlyInCreation:a、b 

因此,通过调用getSingleton()便能获取到A的一个原始对象,直接返回给到B,B就完成了属性填充,接着往下执行B的初始化流程,然后回到DefaultSingletonBeanRegistry# getSingleton 中:

// 1、bean构建完毕,从singletonsCurrentlyIncreation集合中删除对应的beanName
afterSingletonCreation(beanName);

// 2、添加到单例缓存池中,并从二级缓存和三级缓存中删除
addSingleton(beanName, singletonObject);
  1. 将b从singletonsCurrentlyIncreation集合中删除;
  2. 然后将B的bean添加到单例缓存池中,并从二级缓存和三级缓存中删除,则B的完整bean创建完成
	// 添加到单例缓存池中,并从二级缓存和三级缓存中删除
	protected void addSingleton(String beanName, Object singletonObject) {
		synchronized (this.singletonObjects) {
			this.singletonObjects.put(beanName, singletonObject);
			this.singletonFactories.remove(beanName);
			this.earlySingletonObjects.remove(beanName);
			this.registeredSingletons.add(beanName);
		}
	}

此时,我们再看一下,4个集合中分别有什么:

  • singletonObjects:B完整的bean
  • earlySingletonObjects:A的原始对象
  • singletonFactories:
  • singletonsCurrentlyInCreation:a

得到了B的Bean对象,A第一层递归的地方,就可以执行填充属性B了,还有后续的初始化等操作,最终清除当前bean对应的二三级缓存,将A的完整bean放入单例池。

最终4个集合结果如下,A、B的完整单例对象都被实例化并放入到单例池中。

  • singletonObjects:B完整的bean、A完整的bean
  • earlySingletonObjects:
  • singletonFactories:
  • singletonsCurrentlyInCreation:

注:这4个集合中,我们只关注A、B相关的内容,其它bean忽略。

3.2 为什么Spring中需要singletonFactories(三级缓存)呢?

经过我们上面的示例分析,细心的读者应该会发现,这个singletonFactories三级缓存是不是有点多余?就算去掉三级缓存,我们直接将原始对象创建好之后放入二级缓存,然后其它Bean需要依赖注入时就可以从二级缓存中拿即可。下面具体分析:

A的Bean在创建过程中,在进行依赖注入之前,先把A的原始Bean放入二级缓存(提早暴露,只要放到缓存了,其它Bean需要时就可以从缓存中拿了),放入缓存后,再进行依赖注入,此时A的Bean依赖了B的Bean,如果B的Bean不存在,则需要创建B的Bean,而创建B的Bean的过程和A一样,也是先创建一个B的原始对象,然后把B的原始对象提早暴露出来放入缓存中,然后再对B的原始对象进行依赖注入A,此时能从缓存中拿到A的原始对象(虽然是A的原始对象,还不是最终的Bean),B的原始对象依赖注入完了之后,B的生命周期结束,那么A的生命周期也能结束。

因为整个过程中,都只有一个A原始对象,所以对于B而言,就算在属性注入时,注入的是A原始对象,也没有关系,因为A原始对象在后续的生命周期中在堆中没有发生变化。

从上面这个分析可知,只需要一个缓存就能解决循环依赖了,那么为什么Spring中还需要singletonFactories呢?

这是难点,基于上面的场景思考以下问题:

如果我们给A配置了一个切面,则当A的原始对象注入给B的属性之后,A的原始对象进行了AOP产生了一个代理对象此时就会出现,对于A而言,它的Bean对象其实应该是AOP之后的代理对象,而B的a属性对应的是A的原始对象,这就产生了冲突

而AOP可以说是Spring中除开IoC的另外一大功能,而循环依赖又是属于IoC范畴的,所以这两大功能想要并存,Spring需要特殊处理。如何处理呢,就是利用了第三级缓存singletonFactories

首先,singletonFactories中存的是某个beanName对应的ObjectFactory,在bean的生命周期中,生成完原始对象之后,就会构造一个ObjectFactory存入singletonFactories中。这个ObjectFactory是一个函数式接口(只定义了一个方法),所以支持Lambda表达式:() -> getEarlyBeanReference(beanNamembdbean):


protected Object getEarlyBeanReference(String beanName, RootBeanDefinition mbd, Object bean) {
    Object exposedObject = bean;
    if (!mbd.isSynthetic() && hasInstantiationAwareBeanPostProcessors()) {
        // 遍历又有bean后置处理器
        for (BeanPostProcessor bp : getBeanPostProcessors()) {
            if (bp instanceof SmartInstantiationAwareBeanPostProcessor) {
                SmartInstantiationAwareBeanPostProcessor ibp = (SmartInstantiationAwareBeanPostProcessor) bp;
                exposedObject = ibp.getEarlyBeanReference(exposedObject, beanName);
            }
        }
    }
    return exposedObject;
}

该方法主要是去遍历所有的 BeanPostProcessors,然后分别判断该bp是否属于SmartInstantiationAwareBeanPostProcessor类型对象,是则调用它的getEarlyBeanReference方法,而这个接口下的实现类中只有两个类实现了这个方法,一个是AbstractAutoProxyCreator,一个是InstantiationAwareBeanPostProcessorAdapter,它的实现如下:

// InstantiationAwareBeanPostProcessorAdapter
@Override
public Object getEarlyBeanReference(Object bean, String beanName) throws BeansException {
    return bean;
}
 
 
// AbstractAutoProxyCreator
@Override
public Object getEarlyBeanReference(Object bean, String beanName) {
    Object cacheKey = getCacheKey(bean.getClass(), beanName);
    this.earlyProxyReferences.put(cacheKey, bean);
    return wrapIfNecessary(bean, beanName, cacheKey);
}

所以很明显,在整个Spring中,默认就只有AbstractAutoProxyCreator真正意义上实现了getEarlyBeanReference方法,而该类就是用来进行AOP的。之前也有单独的文章《【Spring源码:AOP一】基于JDK动态代理和Cglib创建代理对象的原理分析》分析了,AnnotationAwareAspectJAutoProxyCreator的父类就是AbstractAutoProxyCreator。

那么getEarlyBeanReference方法到底在干什么?

首先得到一个cachekey,cachekey其实就是beanName。

然后把beanName和bean(这是原始对象)存入earlyProxyReferences中,调用wrapIfNecessary进行AOP,得到一个代理对象。

分析:

这个ObjectFactory就是上文说的labmda表达式,中间有getEarlyBeanReference方法,注意存入singletonFactories时并不会执行lambda表达式,也就是不会执行getEarlyBeanReference方法。

从singletonFactories根据beanName得到一个ObjectFactory,然后执行ObjectFactory,也就是执行getEarlyBeanReference方法,此时会得到一个A原始对象经过AOP之后的代理对象,然后把该代理对象放入earlySingletonObjects中,注意此时并没有把代理对象放入singletonObjects中,那什么时候放入到singletonObjects中呢?

我们这个时候得来理解一下earlySingletonObjects的作用,此时,我们只得到了A原始对象的代理对象,这个对象还不完整,因为A原始对象还没有进行属性填充,所以此时不能直接把A的代理对象放入singletonObjects中,所以只能把代理对象放入earlySingletonObjects,假设现在有其他对象依赖了A,那么则可以从earlySingletonObjects中得到A原始对象的代理对象了,并且是A的同一个代理对象。

当B创建完了之后,A继续进行生命周期,而A在完成属性注入后,会按照它本身的逻辑去进行AOP,而此时我们知道A原始对象已经经历过了AOP,所以对于A本身而言,不会再去进行AOP了,那么怎么判断一个对象是否经历过了AOP呢?会利用上文提到的earlyProxyReferences,在AbstractAutoProxyCreator的postProcessAfterInitialization方法中,会去判断当前beanName是否在earlyProxyReferences,如果在则表示已经提前进行过AOP了,无需再次进行AOP。

对于A而言,进行了AOP的判断后,以及BeanPostProcessor的执行之后,就需要把A对应的对象放入singletonObjects中了,但是我们知道,应该是要A的代理对象放入singletonObjects中,所以此时需要从earlySingletonObjects中得到代理对象,然后入singletonObjects中。

4. 总结

  1. singletonObjects:缓存所有经过完整生命周期的单例bean。
  2. earlySingletonObjects:不完整的单例对象(原始对象),如果配置了AOP,那缓存的就是提前拿原始对象进行了AOP之后得到的代理对象。原始对象是还没有进行属性注入和后续的BeanPostProcessor等生命周期的对象。
  3. singletonFactories:缓存的是一个ObjectFactory,主要用来去生成原始对象进行了AOP之后得到的代理对象,在每个Bean的生成过程中,都会提前暴露一个工厂,这个工厂可能用到,也可能用不到,如果没有出现循环依赖依赖本bean,那么这个工厂无用,本bean按照自己的生命周期执行,执行完后直接把本bean放入singletonObjects中即可,如果出现了循环依赖依赖了本bean,则另外那个bean执行ObjectFactory提交得到一个AOP之后的代理对象(如果有AOP的话,如果无需AOP,则直接得到一个原始对象)。
  4. singletonsCurrentlyInCreation:存放正在创建的Bean的名称,创建完成后,从这个集合中删除。

其实还有一个缓存,就是earlyProxyReferences,主要用来记录某个原始对象是否进行过AOP了。

扩展:面试必问:Spring循环依赖的三种方式_骏马逸动,心随你动的博客-CSDN博客

Spring 解决了哪些情况的循环依赖?

(1)构造注入无法解决循环依赖:

Spring容器会将每一个正在创建的Bean 标识符放在一个“当前创建Bean池”中,Bean标识符在创建过程中将一直保持在这个池中。因此如果在创建Bean过程中发现自己已经在“当前创建Bean池”里时将抛出BeanCurrentlyInCreationException异常表示循环依赖;而对于创建完毕的Bean将从“当前创建Bean池”中清除掉。

(2)Spring单例作用域的bean,Setter依赖注入,可解决循环依赖

Spring是先将Bean对象实例化之后再设置对象属性的,即Spring先是用构造实例化Bean对象 ,此时Spring会将这个实例化结束的对象(原始对象)放到一个Map中,并且Spring提供了获取这个未设置属性的实例化对象引用的方法。 

(3)Spring原型作用域的bean,Setter依赖注入,无法解决循环依赖:

 对于“prototype”作用域Bean,Spring容器无法完成依赖注入,因为“prototype”作用域的Bean,Spring容器不进行缓存,因此无法提前暴露一个创建中的Bean。

不要使用基于构造函数的依赖注入,可以通过以下方式解决:

  • 在字段上使用@Autowired注解,让Spring决定在合适的时机注入

  • 用基于setter方法的依赖注入。

参考:

https://www.yuque.com/renyong-jmovm/kb/dpzl6u

https://blog.csdn.net/gongsenlin341/article/details/108753560

●史上最强Tomcat8性能优化

●阿里巴巴为什么能抗住90秒100亿?--服务端高并发分布式架构演进之路

●B2B电商平台--ChinaPay银联电子支付功能

●学会Zookeeper分布式锁,让面试官对你刮目相看

●SpringCloud电商秒杀微服务-Redisson分布式锁方案

查看更多好文,进入公众号--撩我--往期精彩

一只 有深度 有灵魂 的公众号0.0

你可能感兴趣的:(Spring,Spring,架构,循环依赖,AOP,Java)