前言
springboot的项目中,有可能会遇到Spring的循环依赖的运行时问题,导致springboot的项目启动报错,而无法启动。今天就来一起探讨这个问题。
循环依赖
循环依赖是指,A 依赖 B,B 又依赖 A,它们之间形成了循环依赖。或者是 A 依赖 B,B 依赖 C,C 又依赖 A。这样依赖,就不知道该先实例化谁了。
在springboot的加载启动过程中;可能引起循环依赖的场景大致有三种:
1.构造器互相依赖 2.构造器依赖 + field依赖或者setter依赖(A的构造器依赖B,B的field或者setter依赖A) 3.field依赖或者setter依赖 当然,Spring对于循环依赖的解决不是万能的,前提条件是针对scope单例并且没有显式指明不需要解决循环依赖的对象,而且要求该对象没有被代理过。针对上面这三种情况,spring只能解决第二、第三种循环依赖,那么它是怎么解决的呢?为什么其余情况无法解决?
spring单例对象的初始化步骤
createBeanInstance :实例化,调用对象的构造方法实例化对象,此时只是调用了构造方法,spring xml中指定的property并没有进行populate populateBean :填充属性,这步对spring xml中指定的property进行populate initializeBean :调用spring xml中指定的init方法,或者AfterPropertiesSet方法 会发生循环依赖的步骤集中在第一步和第二步,也就是构造器循环依赖和field循环依赖。
2.2三级缓存
那么我们要解决循环引用也应该从初始化过程着手,对于单例来说,在Spring容器整个生命周期内,有且只有一个对象,所以很容易想到这个对象应该存在Cache中,Spring为了解决单例的循环依赖问题,使用了三级缓存。对于“prototype”作用域bean, Spring 容器不对其进行缓存,因此无法提前暴露一个创建中的bean ,所以不支持循环依赖。
三级缓存:
/** Cache of singleton objects: bean name –> bean instance */ private final Map singletonObjects = new ConcurrentHashMap(256); /** Cache of singleton factories: bean name –> ObjectFactory */ private final Map> singletonFactories = new HashMap>(16); /** Cache of early singleton objects: bean name –> bean instance */ private final Map earlySingletonObjects = new HashMap(16); 一级缓存 singletonObjects:用于存放完全初始化好的 bean,从该缓存中取出的 bean 可以直接使用 二级缓存 earlySingletonObjects:存放原始的 bean 对象(尚未填充属性),用于解决循环依赖 三级缓存 singletonFactories:存放进入实例化阶段的单例对象工厂,用于解决循环依赖 我们在创建bean的时候,首先想到的是从cache中获取这个单例的bean,这个缓存就是singletonObjects。主要调用方法就就是:
protected Object getSingleton(String beanName, boolean allowEarlyReference) { Object singletonObject = this.singletonObjects.get(beanName); //isSingletonCurrentlyInCreation()判断当前单例bean是否正在创建中 if (singletonObject == null && isSingletonCurrentlyInCreation(beanName)) { synchronized (this.singletonObjects) { // 从 earlySingletonObjects 中获取提前曝光的 bean singletonObject = this.earlySingletonObjects.get(beanName); //allowEarlyReference 是否允许从singletonFactories中通过getObject拿到对象 if (singletonObject == null && allowEarlyReference) { ObjectFactory<?> singletonFactory = this.singletonFactories.get(beanName); if (singletonFactory != null) { singletonObject = singletonFactory.getObject(); //从singletonFactories中移除,并放入earlySingletonObjects中。 //其实也就是从三级缓存移动到了二级缓存(提前曝光Bean) this.earlySingletonObjects.put(beanName, singletonObject); this.singletonFactories.remove(beanName); } } } } return (singletonObject != NULL_OBJECT ? singletonObject : null); }
isSingletonCurrentlyInCreation() :判断当前单例bean是否正在创建中,也就是没有初始化完成 (比如A的构造器依赖了B对象所以得先去创建B对象,或者在A的populateBean过程中依赖了B对象,得先去创建B对象,这时的A就是处于创建中的状态)。 分析getSingleton的整个过程,Spring首先从singletonObjects(一级缓存)中尝试获取,如果获取不到并且对象正在在创建中,则尝试从earlySingletonObjects(二级缓存)中获取,如果还是获取不到并且允许从singletonFactories通过getObject获取,则通过singletonFactory.getObject()(三级缓存)获取。如果获取到了则移除对应的singletonFactory,将singletonObject放入到earlySingletonObjects,其实就是将三级缓存提升到二级缓存中!
从上面三级缓存的分析,我们可以知道,Spring解决循环依赖的诀窍就在于singletonFactories这个三级cache。这个cache的类型是ObjectFactory,定义如下:
public interface ObjectFactory<T> { T getObject() throws BeansException; } 这个接口在AbstractBeanFactory里实现,并在核心方法doCreateBean()引用下面的方法: protected void addSingletonFactory(String beanName, ObjectFactory<?> singletonFactory) { Assert.notNull(singletonFactory, "Singleton factory must not be null"); synchronized (this.singletonObjects) { if (!this.singletonObjects.containsKey(beanName)) { this.singletonFactories.put(beanName, singletonFactory); this.earlySingletonObjects.remove(beanName); this.registeredSingletons.add(beanName); } } }
这段代码发生在createBeanInstance之后,populateBean()之前,也就是说单例对象此时已经被创建出来(调用了构造器)。这个对象已经被生产出来了,此时将这个对象提前曝光出来,让大家使用。
这样做有什么好处呢?让我们来分析一下“A的某个field或者setter依赖了B的实例对象,同时B的某个field或者setter依赖了A的实例对象”这种循环依赖的情况。A首先完成了初始化的第一步,并且将自己提前曝光到singletonFactories中,此时进行初始化的第二步,发现自己依赖对象B,此时就尝试去get(B),发现B还没有被create,所以走create流程,B在初始化第一步的时候发现自己依赖了对象A,于是尝试get(A),尝试一级缓存singletonObjects(肯定没有,因为A还没初始化完全),尝试二级缓存earlySingletonObjects(也没有),尝试三级缓存singletonFactories,由于A通过ObjectFactory将自己提前曝光了,所以B能够通过ObjectFactory.getObject拿到A对象(虽然A还没有初始化完全,但是总比没有好呀),B拿到A对象后顺利完成了初始化阶段1、2、3,完全初始化之后将自己放入到一级缓存singletonObjects中。此时返回A中,A此时能拿到B的对象顺利完成自己的初始化阶段2、3,最终A也完成了初始化,进去了一级缓存singletonObjects中,而且更加幸运的是,由于B拿到了A的对象引用,所以B现在hold住的A对象完成了初始化。
Spring循环依赖的理论依据其实是Java基于引用传递,当我们获取到对象的引用时,对象的field或者属性是可以延后设置的(但是构造器必须是在获取引用之前,所以1.1中的第一种场景spring如法解决)。
总结
Spring通过三级缓存加上“提前曝光”机制,配合Java的对象引用原理,比较完美地解决了某些情况下的循环依赖问题!