Spring容器如何解決循環依賴的原理

Spring容器如何解決循環依賴的原理

最近看源碼在研究類似如下配置的循環依賴是怎么解決的？

<bean id="a" class="com.project.demo.A" scope="singleton">
      <property name="b" ref="b"/>
</bean>
<bean id="b" class="com.project.demo.B" scope="singleton">
      <property name="a" ref="a"/>
</bean>

 

說明：

　　1、Spring容器解決循環依賴的問題配置類必須是單例模式scope="singleton"才支持，如果是scope="prototype"是無法解決循環依賴的。

　　2、Spring容器解決循環依賴主要依靠三級緩存機制

　　　　2.1 一級緩存使用的map： private final Map<String, Object> singletonObjects = new ConcurrentHashMap(256);

　　　　2.2 二級緩存使用的map： private final Map<String, Object> earlySingletonObjects = new HashMap(16); 

　　　　2.3 三級緩存使用的map： private final Map<String, ObjectFactory<?>> singletonFactories = new HashMap(16);

　　3、Spring容器解決循環依賴簡潔概述主要有四大流程方法：獲取對象 getSingleton()、 創建對象（實例化） doCreateBean()、填充屬性（初始化） populateBean()、返回對象 addSingleton()

 

在系統啟動獲取配置文件后，程序是依次讀取並加載的，所以當執行上面配置文件時，先獲取a對象，如果獲取不到則先實例化a對象，然后初始化a對象即給a添加b屬性，在添加b屬性的時候先獲取b，如果b存在則直接給a設置，不存在則實例化b，並且初始化b對象即給b添加對應的屬性。

那么在代碼執行過程中，先調用getSingleton()方法，我們查看源碼

    @Nullable
    public Object getSingleton(String beanName) {
           // 調用下方重載方法
        return this.getSingleton(beanName, true);
    }

    @Nullable
    protected Object getSingleton(String beanName, boolean allowEarlyReference) {
　　　　　　 // 先從一級緩存中獲取a對象的實例
        Object singletonObject = this.singletonObjects.get(beanName);
           // 如果從一級緩存中獲取不到a對象，那么檢查該對象是否正在被創建，如果正在被創建，則進入if循環中
        if (singletonObject == null && this.isSingletonCurrentlyInCreation(beanName)) {
            synchronized(this.singletonObjects) {
　　　　　　　　　　　 // 從二級緩存中獲取該對象
                singletonObject = this.earlySingletonObjects.get(beanName);
                   // 如果二級緩存中無法獲取該對象，那么一定會進入如下if方法，因為allowEarlyReference傳過來的時候就是true
                if (singletonObject == null && allowEarlyReference) {
　　　　　　　　　　　　　　// 從三級緩存中獲取該對象
                    ObjectFactory<?> singletonFactory = (ObjectFactory)this.singletonFactories.get(beanName);
                    if (singletonFactory != null) {
                           // 如果獲取到了該對象，就將三級緩存中的對象放到二級緩存中，並且將三級緩存中的對象刪除
                        singletonObject = singletonFactory.getObject();
                        this.earlySingletonObjects.put(beanName, singletonObject);
                        this.singletonFactories.remove(beanName);
                    }
                }
            }
        }

        return singletonObject;
    }

從三面的源碼發現，如果a第一次獲取，那么第9行的if語句為false,將直接放回為null，這時回到創建對象doCreateBean()方法，該方法使用反射的方式生成a對象，並且該對象在三級緩存中，對象生成后就需要對a對象進行屬性填充：

protected Object doCreateBean(String beanName, RootBeanDefinition mbd, @Nullable Object[] args) throws BeanCreationException {
        // 省略多行代碼，大致就是調用各種方法，通過反射創建對象
        try {
            // a對象創建完成，調用屬性填充方法，對a進行屬性填充
            this.populateBean(beanName, mbd, instanceWrapper);
            exposedObject = this.initializeBean(beanName, exposedObject, mbd);
        } catch (Throwable var18) {
            if (var18 instanceof BeanCreationException && beanName.equals(((BeanCreationException)var18).getBeanName())) {
                throw (BeanCreationException)var18;
            }

            throw new BeanCreationException(mbd.getResourceDescription(), beanName, "Initialization of bean failed", var18);
        }

        if (earlySingletonExposure) {
            Object earlySingletonReference = this.getSingleton(beanName, false);
            if (earlySingletonReference != null) {
                // 省略多行代碼
            }
        }
        // 省略多行代碼
    }

在上面代碼doCreateBean()方法中先創建a對象，創建完成后會調用this.populateBean(beanName, mbd, instanceWrapper)方法對a進行屬性填出，這個時候會獲取配置文件中所有<bean id="a">里面的所有屬性，發現會存在一個b屬性，下面貼出部分源碼

protected void populateBean(String beanName, RootBeanDefinition mbd, @Nullable BeanWrapper bw) {
        if (bw == null) {
            if (mbd.hasPropertyValues()) {
                throw new BeanCreationException(mbd.getResourceDescription(), beanName, "Cannot apply property values to null instance");
            }
        } else {
            boolean continueWithPropertyPopulation = true;
            if (!mbd.isSynthetic() && this.hasInstantiationAwareBeanPostProcessors()) {
                // 刪除大量代碼
            }

            if (continueWithPropertyPopulation) {
                // 刪除大量源代碼，applyPropertyValues方法中beanName為a,pvs為狀態各種屬性的PropertyValues對象，pvs就裝有b這個屬性
                if (pvs != null) {
                    this.applyPropertyValues(beanName, mbd, bw, (PropertyValues)pvs);
                }

            }
        }
    }

繼續跟進applyPropertyValues方法的源碼

protected void applyPropertyValues(String beanName, BeanDefinition mbd, BeanWrapper bw, PropertyValues pvs) {
        if (!pvs.isEmpty()) {
            if (System.getSecurityManager() != null && bw instanceof BeanWrapperImpl) {
                ((BeanWrapperImpl)bw).setSecurityContext(this.getAccessControlContext());
            }
            MutablePropertyValues mpvs = null;
            List original;
            if (pvs instanceof MutablePropertyValues) {
                // 省略大量代碼
            } else {
                original = Arrays.asList(pvs.getPropertyValues());
            }
            // 省略大量代碼 大致過程是將屬性對象pvs 轉化成original List對象，然后在使用迭代器在下面進行迭代
            Iterator var11 = original.iterator();
            while(true) {
                while(var11.hasNext()) {
                    PropertyValue pv = (PropertyValue)var11.next();
                    if (pv.isConverted()) {
                        deepCopy.add(pv);
                    } else {
                        String propertyName = pv.getName();
                        Object originalValue = pv.getValue();
                        // 通過下面方法解決依賴的b,整個方法在迭代器中，外層在while(true)中，可能有多個屬性，循環直到所有屬性都解決了就return;或者拋出異常
                        Object resolvedValue = valueResolver.resolveValueIfNecessary(pv, originalValue);
                        // 省略大量代碼
                    }
                }

                if (mpvs != null && !resolveNecessary) {
                    mpvs.setConverted();
                }

                try {
                    bw.setPropertyValues(new MutablePropertyValues(deepCopy));
                    return;
                } catch (BeansException var19) {
                    throw new BeanCreationException(mbd.getResourceDescription(), beanName, "Error setting property values", var19);
                }
            }
        }
    }

繼續跟進上面紅色方法

public Object resolveValueIfNecessary(Object argName, @Nullable Object value) {
        if (value instanceof RuntimeBeanReference) {
            RuntimeBeanReference ref = (RuntimeBeanReference)value;
            return this.resolveReference(argName, ref);
        } else if (value instanceof RuntimeBeanNameReference) {
            // 省略多行代碼
        } 
        // 省略多行代碼
    }

繼續跟進紅色部分的代碼

private Object resolveReference(Object argName, RuntimeBeanReference ref) {
        try {
            String refName = ref.getBeanName();
            refName = String.valueOf(this.doEvaluate(refName));
            Object bean;
            if (ref.isToParent()) {
                // 省略多行代碼
            } else {
                // 通過refName的值b又去工廠找b對象
                bean = this.beanFactory.getBean(refName);
                this.beanFactory.registerDependentBean(refName, this.beanName);
            }

            // 省略多行代碼
            return bean;
        } catch (BeansException var5) {
            throw new BeanCreationException(this.beanDefinition.getResourceDescription(), this.beanName, "Cannot resolve reference to bean '" + ref.getBeanName() + "' while setting " + argName, var5);
        }
    }

    public Object getBean(String name) throws BeansException {
        return this.doGetBean(name, (Class)null, (Object[])null, false);
    }

    protected <T> T doGetBean(String name, @Nullable Class<T> requiredType, @Nullable Object[] args, boolean typeCheckOnly) throws BeansException {
        String beanName = this.transformedBeanName(name);
        // 跟了這么就，最終表明在實例化a對象后，在裝載a的屬性b時，會經過各種校驗最終到getSingleton(),及先獲取b對象，如果b對象不存在則會對b完成創建的過程
        Object sharedInstance = this.getSingleton(beanName);
        // 省略多行代碼
    }

上面整個過程概括：在檢測到需要實例化a時，先去獲取a對象，看a是否已經存在，獲取去先從一級緩存中獲取，如果沒有並且如果a也沒有正在實例化，那么直接返回null，表明獲取不到a對象，那么此時調用doCreateBean()方法完成對a對象的實例化過程（通過反射創建a對象），並且將創建的a對象放在三級緩存中，然后繼續執行doCreateBean中的populateBean()方法完成對a進行初始化即添加屬性b，經過一系列校驗，最終又會調用getSingleton()方法來獲取b對象，同樣會返回null，這個時候就會去執行doCreateBean()方法創建b對象，同樣過反射創建b，當b對象創建完成時也會存放在三級緩存中，在實例化b對象完成，然后繼續執行doCreateBean中的populateBean()方法，也需要初始化b對象，填充b的屬性，這時發現b對象的屬性是a，同樣再次通過getSingleton()方法獲取a，獲取a的過程如第一個源碼部分，先從一級緩存中獲取，獲取不到，然后判斷a正在創建中，然后就從二級、三級緩存中獲取，最終在三級緩存中獲取到了a，並且將三級緩存中的a對象放到二級緩存中，並將刪除三級緩存中的a，此時b對象初始化也完成。

在a對象初始化的流程中，將b對象也實例化和初始化了，在b的初始化過程中，將a從三級緩存移到了二級緩存中，當b初始化完成后繼續向下執行，會執行到addSingleton()，查看源碼

    protected void addSingleton(String beanName, Object singletonObject) {
        synchronized(this.singletonObjects) {
　　　　　　　// 將b加入到1級緩存
            this.singletonObjects.put(beanName, singletonObject);
            // 將b從三級緩存中刪除
            this.singletonFactories.remove(beanName);
            // 將b從二級緩存中刪除（b在二級緩存中沒有，即空刪除）
            this.earlySingletonObjects.remove(beanName);
            this.registeredSingletons.add(beanName);
        }
    }

從上面代碼可以看出在，並創建完成並且初始化后，會將B從三級緩存中直接放到一級緩存中，並且刪除三級緩存中的數據。

所有b工作做完后返回到a初始化屬性b的代碼

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

        // 省略大量代碼
        try {
            // 完成a對於屬性b的檢查裝配工作后返回到方法populateBean(),繼續向下執行
            this.populateBean(beanName, mbd, instanceWrapper);
            exposedObject = this.initializeBean(beanName, exposedObject, mbd);
        } catch (Throwable var18) {
            if (var18 instanceof BeanCreationException && beanName.equals(((BeanCreationException)var18).getBeanName())) {
                throw (BeanCreationException)var18;
            }

            throw new BeanCreationException(mbd.getResourceDescription(), beanName, "Initialization of bean failed", var18);
        }

        if (earlySingletonExposure) {
            // a執行到該方法getSingleton(),這里面會將a從二級緩存中取出來
            Object earlySingletonReference = this.getSingleton(beanName, false);
            if (earlySingletonReference != null) {
                // 省略大量代碼
            }
        }
        // 省略大量代碼
    }

繼續執行，最終也會到addSingleton()方法，將a也加入一級緩存，並且從二級緩存中刪除a。

這樣a和b兩個循環依賴的bean都被放入到一級緩存中。