Spring源码解析(6)——循环依赖

回顾上篇

上篇文章《获取bean》已经分析完了bean是如何创建出来的，但是获取bean的逻辑远不止这么简单。我们分析bean的获取是直接从创建bean的代码开始分析的，其实在创建bean之前是会先从缓存中去获取bean,如果获取不到才会去创建这个bean,创建成功后会把这个bean放到缓存中。接下来我们看看什么时候会把bean缓存起来以及在什么地方会使用到这个缓存。

分析源码实现

在创建bean的过程中有两段放缓存的代码。

// 这里放入的是创建bean的工厂类，通过getObject()就能够获取这个bean,但是这个bean是还没有进行属性填充的bean
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);
		}
	}
}

// 这里放入的是创建完成了的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);
	}
}

我们可以看到这里面有三个map来保存我们创建的bean，那这里为什么需要三个map呢？我们先来看一下这两段代码分别在什么地方执行的。

//bean通过构造函数创建完成，还没有进行属性填充。
protected Object doCreateBean(final String beanName, final RootBeanDefinition mbd, final @Nullable Object[] args)
			throws BeanCreationException {
		BeanWrapper instanceWrapper = null;
		if (mbd.isSingleton()) {
			instanceWrapper = this.factoryBeanInstanceCache.remove(beanName);
		}
		if (instanceWrapper == null) {
			instanceWrapper = createBeanInstance(beanName, mbd, args);
		}
		final Object bean = instanceWrapper.getWrappedInstance();
		Class<?> beanType = instanceWrapper.getWrappedClass();
		if (beanType != NullBean.class) {
			mbd.resolvedTargetType = beanType;
		}
		synchronized (mbd.postProcessingLock) {
			if (!mbd.postProcessed) {
				try {
					applyMergedBeanDefinitionPostProcessors(mbd, beanType, beanName);
				}
				catch (Throwable ex) {
					throw new BeanCreationException(mbd.getResourceDescription(), beanName,
							"Post-processing of merged bean definition failed", ex);
				}
				mbd.postProcessed = true;
			}
		}
		//判断这个bean是否是单例，是否允许循环依赖，是否是正在创建的bean
		boolean earlySingletonExposure = (mbd.isSingleton() && this.allowCircularReferences &&
				isSingletonCurrentlyInCreation(beanName));
		if (earlySingletonExposure) {
			if (logger.isTraceEnabled()) {
				logger.trace("Eagerly caching bean '" + beanName +
						"' to allow for resolving potential circular references");
			}
			//这里将正在创建的工厂类加入到缓存，这个时候的bean是还没有进行属性填充的bean
			addSingletonFactory(beanName, () -> getEarlyBeanReference(beanName, mbd, bean));
		}
		Object exposedObject = bean;
		try {
			//这步就是对bean的属性进行填充
			populateBean(beanName, mbd, instanceWrapper);
			exposedObject = initializeBean(beanName, exposedObject, mbd);
		}
		catch (Throwable ex) {
			if (ex instanceof BeanCreationException && beanName.equals(((BeanCreationException) ex).getBeanName())) {
				throw (BeanCreationException) ex;
			}
			else {
				throw new BeanCreationException(
						mbd.getResourceDescription(), beanName, "Initialization of bean failed", ex);
			}
		}

		if (earlySingletonExposure) {
			Object earlySingletonReference = getSingleton(beanName, false);
			if (earlySingletonReference != null) {
				if (exposedObject == bean) {
					exposedObject = earlySingletonReference;
				}
				else if (!this.allowRawInjectionDespiteWrapping && hasDependentBean(beanName)) {
					String[] dependentBeans = getDependentBeans(beanName);
					Set<String> actualDependentBeans = new LinkedHashSet<>(dependentBeans.length);
					for (String dependentBean : dependentBeans) {
						if (!removeSingletonIfCreatedForTypeCheckOnly(dependentBean)) {
							actualDependentBeans.add(dependentBean);
						}
					}
					if (!actualDependentBeans.isEmpty()) {
						throw new BeanCurrentlyInCreationException(beanName,
								"Bean with name '" + beanName + "' has been injected into other beans [" +
								StringUtils.collectionToCommaDelimitedString(actualDependentBeans) +
								"] in its raw version as part of a circular reference, but has eventually been " +
								"wrapped. This means that said other beans do not use the final version of the " +
								"bean. This is often the result of over-eager type matching - consider using " +
								"'getBeanNamesForType' with the 'allowEagerInit' flag turned off, for example.");
					}
				}
			}
		}

		// Register bean as disposable.
		try {
			registerDisposableBeanIfNecessary(beanName, bean, mbd);
		}
		catch (BeanDefinitionValidationException ex) {
			throw new BeanCreationException(
					mbd.getResourceDescription(), beanName, "Invalid destruction signature", ex);
		}

		return exposedObject;
	}


public Object getSingleton(String beanName, ObjectFactory<?> singletonFactory) {
		Assert.notNull(beanName, "Bean name must not be null");
		synchronized (this.singletonObjects) {
			Object singletonObject = this.singletonObjects.get(beanName);
			if (singletonObject == null) {
				if (this.singletonsCurrentlyInDestruction) {
					throw new BeanCreationNotAllowedException(beanName,
							"Singleton bean creation not allowed while singletons of this factory are in destruction " +
							"(Do not request a bean from a BeanFactory in a destroy method implementation!)");
				}
				//标识beanName正在创建
				beforeSingletonCreation(beanName);
				boolean newSingleton = false;
				boolean recordSuppressedExceptions = (this.suppressedExceptions == null);
				if (recordSuppressedExceptions) {
					this.suppressedExceptions = new LinkedHashSet<>();
				}
				try {
					singletonObject = singletonFactory.getObject();
					newSingleton = true;
				}
				catch (IllegalStateException ex) {
					// Has the singleton object implicitly appeared in the meantime ->
					// if yes, proceed with it since the exception indicates that state.
					singletonObject = this.singletonObjects.get(beanName);
					if (singletonObject == null) {
						throw ex;
					}
				}
				catch (BeanCreationException ex) {
					if (recordSuppressedExceptions) {
						for (Exception suppressedException : this.suppressedExceptions) {
							ex.addRelatedCause(suppressedException);
						}
					}
					throw ex;
				}
				finally {
					if (recordSuppressedExceptions) {
						this.suppressedExceptions = null;
					}
					//移除beanName正在创建的标识
					afterSingletonCreation(beanName);
				}
				if (newSingleton) {
					//这个时候bean已经创建完成，属性也填充完毕，加入到缓存
					addSingleton(beanName, singletonObject);
				}
			}
			return singletonObject;
		}
	}

通过上面代码，我们知道在bean创建过程中，在bean通过构造函数创建出来了，但还没有填充属性的时候会把创建bean的工厂类（ObjectFactory）缓存起来，保存在singletonFactories这个map中，这个时候再去填充属性。等属性填充完，这个bean真正的创建完成之后，会把这个bean缓存起来，保存在singletonObjects这个map中。接下来我们看看在获取bean的时候判断是否存在缓存的这段代码。

protected <T> T doGetBean(final String name, @Nullable final Class<T> requiredType,
							  @Nullable final Object[] args, boolean typeCheckOnly) throws BeansException {

		final String beanName = transformedBeanName(name);
		Object bean;
		Object sharedInstance = getSingleton(beanName);
		if (sharedInstance != null && args == null) {
			bean = getObjectForBeanInstance(sharedInstance, name, beanName, null);
		}else {
			//这里就是我们之前分析的创建bean的逻辑
		}

在端代码中，首先是通过getSingleton(beanName)去缓存中获取bean,如果获取到了就不用在重新创建了，没有获取到的话就需要走创建bean的逻辑。
我们看看getSingleton(beanName)这个方法

@Nullable
	protected Object getSingleton(String beanName, boolean allowEarlyReference) {
		Object singletonObject = this.singletonObjects.get(beanName);
		if (singletonObject == null && isSingletonCurrentlyInCreation(beanName)) {
			synchronized (this.singletonObjects) {
				singletonObject = this.earlySingletonObjects.get(beanName);
				if (singletonObject == null && allowEarlyReference) {
					ObjectFactory<?> singletonFactory = this.singletonFactories.get(beanName);
					if (singletonFactory != null) {
						singletonObject = singletonFactory.getObject();
						this.earlySingletonObjects.put(beanName, singletonObject);
						this.singletonFactories.remove(beanName);
					}
				}
			}
		}
		return singletonObject;
	}

这段逻辑就是先从singletonObjects里面去拿这个bean,这里面保存的就是一场创建完成，属性也已经填充的bean.如果这里没拿到就会去earlySingletonObjects里面拿，这个里面存的也是这个bean，只是这bean是还没有填充属性的bean。如果earlySingletonObjects这里也没有，那就去singletonFactories这里那到这个bean的工厂类，通过getObject()方法来获得这个bean。然后再把这个bean放到earlySingletonObjects里面，下次就可以直接从earlySingletonObjects里面获得了。
那么这里为什么需要这么多个map来缓存呢？如果这个bean创建好了，把它放到一个map里面，下次再要获取，直接从这个map拿就好，一个bean的map可以了，为什么还要一个bean的工厂类的map呢？
这个就是为了解决循环依赖问题。
我们来看下面两个类

package com.guiji.bean;

public class A {

	private B b;

	public B getB() {
		return b;
	}

	public void setB(B b) {
		this.b = b;
	}
}

package com.guiji.bean;

public class B {

	private A a;

	public A getA() {
		return a;
	}

	public void setA(A a) {
		this.a = a;
	}
}

A类里面有个属性是B类，B类里面有个属性又是A类。
那么照着Spring 的创建逻辑，假设先创建A类，在通过构造函数把A类创建出来了，要给A的属性b填充值得时候，B类还没有创建，于是就去创建B，然后再通过构造函数去创建了B之后，就要给B的属性a填充值了，而这个时候A还在填充属性的阶段，并没有完全创建好，没有放入到缓存中，于是缓存中也拿不到，就导致了循环依赖。

所以Spring就多加了一个map,用来保存bean的工厂类，就是在bean刚通过构造函数创建好后，就将这个类的工类给加入到这个map中，那么这样上面A-》B-》A的循环依赖的问题就解决了。

在B要填充A的属性的时候，这个时候可以从缓存中获取到A的工厂类，然后调用getObject()方法获取到A了，这样B类中的属性就填充完毕，B就可以创建成功了，B创建成功了之后就可以给A类中填充b这个属性，A也就创建成功了。

到这里缓存和循环依赖问题就分析完了，主要就是通过一个map把还没有完成创建好的bean的工厂类给暴露出来，这样就能在bean还没完全创建完成之前就能够获取到这个bean。然后完全创建完成的bean也会被放到map中缓存起来，这样能够提高获取bean的效率。