Spring源码剖析之Spring处理循环依赖的问题

public class BeanA {

    private BeanB beanB;

    public BeanA(BeanB beanB){
        this.beanB = beanB;
    }
}

public class BeanB {

    private BeanA beanA;

    public BeanB(BeanA beanA){
        this.beanA = beanA;
    }
}

<bean id="beanA" class="cn.itsource._01_di.BeanA" >
        <constructor-arg type="cn.itsource._01_di.BeanB" ref="beanB"  />
 </bean>


 <bean id="beanB" class="cn.itsource._01_di.BeanB"  >
         <constructor-arg type="cn.itsource._01_di.BeanA" ref="beanA" />
 </bean>

public class BeanA {

    private BeanB beanB;

    public void setBeanB(BeanB beanB){
        this.beanB = beanB;
    }
}

@Data
public class BeanB {

    private BeanA beanA;

    public void setBeanA(BeanA beanA){
        this.beanA = beanA;
    }
}

<bean id="beanA" class="cn.itsource._01_di.BeanA" >
    <property name="beanB" ref="beanB" />
</bean>

<bean id="beanB" class="cn.itsource._01_di.BeanB">
    <property name="beanA" ref="beanA" />
</bean>

public abstract class AbstractRefreshableApplicationContext extends AbstractApplicationContext {

	@Nullable
	private Boolean allowBeanDefinitionOverriding;
	//是否允许循环依赖
	@Nullable
	private Boolean allowCircularReferences;
	
	//设置循环依赖
	public void setAllowCircularReferences(boolean allowCircularReferences) {
		this.allowCircularReferences = allowCircularReferences;
	}

ClassPathXmlApplicationContext applicationContext = new ClassPathXmlApplicationContext("bean.xml");
//禁用循环依赖
applicationContext.setAllowCircularReferences(false);
//刷新容器
applicationContext.refresh();
...

//正在创建中的Bean
private final Set<String> singletonsCurrentlyInCreation =
			Collections.newSetFromMap(new ConcurrentHashMap<>(16));

public Object getSingleton(String beanName, ObjectFactory<?> singletonFactory) {
		...省略...
		//把该Bean的名字加入 singletonsCurrentlyInCreation 正在创建池 中
		beforeSingletonCreation(beanName);
		boolean newSingleton = false;
		boolean recordSuppressedExceptions = (this.suppressedExceptions == null);
		if (recordSuppressedExceptions) {
			this.suppressedExceptions = new LinkedHashSet<>();
		}
		try {
			//调用ObjectFactory创建Bean的实例
			singletonObject = singletonFactory.getObject();
			newSingleton = true;
		}
...省略...


//如果singletonsCurrentlyInCreation中没该Ｂｅａｎ，就把该Bean存储到singletonsCurrentlyInCreation中，
//如果 singletonsCurrentlyInCreation 中有 该Bean，就报错循环依赖异常BeanCurrentlyInCreationException
//也就意味着同一个beanName进入该方法2次就会抛异常
protected void beforeSingletonCreation(String beanName) {
		if (!this.inCreationCheckExclusions.contains(beanName) && !this.singletonsCurrentlyInCreation.add(beanName)) {
			throw new BeanCurrentlyInCreationException(beanName);
		}
	}

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;

		// Eagerly check singleton cache for manually registered singletons.
		//缓存中获取Bean,解决了循环依赖问题
		Object sharedInstance = getSingleton(beanName);
     	...缓存中没有走下面...
		if (mbd.isSingleton()) {
					//走 DefaultSingletonBeanRegistry#getSingleton ，方法会把bean加入“正在创建bean池”
					//然后调用ObjectFactory实例化Bean
					sharedInstance = getSingleton(beanName, () -> {
						try {
							return createBean(beanName, mbd, args);
						}
						catch (BeansException ex) {
							// Explicitly remove instance from singleton cache: It might have been put there
							// eagerly by the creation process, to allow for circular reference resolution.
							// Also remove any beans that received a temporary reference to the bean.
							destroySingleton(beanName);
							throw ex;
						}
					});
					bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd);
				}

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

		// Instantiate the bean.
		BeanWrapper instanceWrapper = null;
		if (mbd.isSingleton()) {
			instanceWrapper = this.factoryBeanInstanceCache.remove(beanName);
		}
		if (instanceWrapper == null) {
		//实例化Bean
			instanceWrapper = createBeanInstance(beanName, mbd, args);
		}
		...省略...
		//如果是单利 ，如果是允许循环依赖，如果 beanName 出于创建中，已经被添加到“创建中的bean池”
boolean earlySingletonExposure = (mbd.isSingleton() && this.allowCircularReferences &&
				isSingletonCurrentlyInCreation(beanName));
		if (earlySingletonExposure) {
			if (logger.isDebugEnabled()) {
				logger.debug("Eagerly caching bean '" + beanName +
						"' to allow for resolving potential circular references");
			}
			//把ObjectFactory 添加到 singletonFactories 中。
			addSingletonFactory(beanName, () -> getEarlyBeanReference(beanName, mbd, bean));
		}
		
	try {
		//走依赖注入流程
			populateBean(beanName, mbd, instanceWrapper);
			exposedObject = initializeBean(beanName, exposedObject, mbd);
		}


//缓存单利Bean的创建工厂，用于解决循环依赖
protected void addSingletonFactory(String beanName, ObjectFactory<?> singletonFactory) {
		Assert.notNull(singletonFactory, "Singleton factory must not be null");
		synchronized (this.singletonObjects) {
			//singletonObjects单利缓存中是否包含Bean
			if (!this.singletonObjects.containsKey(beanName)) {
				//提前暴露ObjectFactory，把ObjectFactory放到singletonFactories中，
				//后面解决循环依赖，获取Bean实例的时候会用到
				this.singletonFactories.put(beanName, singletonFactory);
				//早期单利bean缓存中移除Bean
				this.earlySingletonObjects.remove(beanName);
				//把注册的Bean加入registeredSingletons中
				this.registeredSingletons.add(beanName);
			}
		}
	}

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;

		// Eagerly check singleton cache for manually registered singletons.
		//从缓存中获取Bean
		Object sharedInstance = getSingleton(beanName);

		...省略...

		//如果缓存中没有Bean，就创建Bean
		if (mbd.isSingleton()) {
					sharedInstance = getSingleton(beanName, () -> {
						try {
							return createBean(beanName, mbd, args);
						}
						catch (BeansException ex) {
							// Explicitly remove instance from singleton cache: It might have been put there
							// eagerly by the creation process, to allow for circular reference resolution.
							// Also remove any beans that received a temporary reference to the bean.
							destroySingleton(beanName);
							throw ex;
						}
					});
					bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd);
				}

//allowEarlyReference ：是否创建早期应用，主要用来解决循环依赖
	@Nullable
	protected Object getSingleton(String beanName, boolean allowEarlyReference) {
		// Quick check for existing instance without full singleton lock
		//从Map中 singletonObjects = new ConcurrentHashMap<>(256); 获取单利Bean

		//【一级缓存】singletonObject缓存中是否有Bean , 它存储的是已经实例化好的Bean
		Object singletonObject = this.singletonObjects.get(beanName);

		//如果singletonObjects中没有Bean，但是Bean出于正在创建池中，即： Set<String> singletonsCurrentlyInCreation中有Bean，
		if (singletonObject == null && isSingletonCurrentlyInCreation(beanName)) {
			
			//【二级缓存】从早期单例对象的缓存 earlySingletonObjects 中获取
			singletonObject = this.earlySingletonObjects.get(beanName);
			
			//早期单利对象缓存中也没有，但是允许循环依赖
			if (singletonObject == null && allowEarlyReference) {
				
				synchronized (this.singletonObjects) {
					// Consistent creation of early reference within full singleton lock
					singletonObject = this.singletonObjects.get(beanName);
					if (singletonObject == null) {
						singletonObject = this.earlySingletonObjects.get(beanName);
						if (singletonObject == null) {
							
							//【三级缓存】获取ObjectFactory ， 对象创建工厂,得到Bean创建过程中提前暴露的工厂。
							ObjectFactory<?> singletonFactory = this.singletonFactories.get(beanName);
							if (singletonFactory != null) {
								//通过工厂ObjectFactory 获取对象实例
								singletonObject = singletonFactory.getObject();
								//把对象存储到早期缓存中
								this.earlySingletonObjects.put(beanName, singletonObject);
								//把ObjectFactory移除
								this.singletonFactories.remove(beanName);
							}
						}
					}
				}
			}
		}
		return singletonObject;
	}