《Yangzai的知识地图》- Spring循环依赖

╰+哭是因爲堅強的太久メ 2022-10-29 10:23 132阅读 0赞

# Spring如何解决循环依赖 #

系类文章  
1、[Spring源码分析][Spring]  
2、[Spring开篇][Spring]  
3、[Bean的生命周期][Bean]

--------------------

### 文章目录 ###

*  Spring如何解决循环依赖
 *  前言
 *  一、什么是循环依赖？
 *   *  0.Spring容器启动时初始化Bean是哪种
     *  1.构造函数的循环依赖
     *  2.Setter和属性注入的循环依赖
 *  二、为什么使用三级缓存
 *   *  0.三级缓存都是什么
     *  1.两级缓存
     *  2.为什么使用三级缓存
     *   *  2.1 后置处理可能会产生代理

--------------------

# 前言 #

这是个人技术学习总结的相关文章，是对自己的查缺补漏。

--------------------

# 一、什么是循环依赖？ #

> 简单的说就是A类中拥有B类的成员变量，而B类中也拥有A类的成员变量，由于Spring的机制是所有的Bean都交给容器进行管理，如果没有解决循环以来就会出现这样的问题，在创建A的时候 因为A拥有B类的成员变量所以在属性填充的时候就会去创建B类，而在创建B类的时候又由于B类中拥有A类的成员变量，所以会想要创建A类的成员变量，如果这个时候不想办法解决，那么就是一致依赖创建下去。而Spring循环依赖机制就是来解决这个的。

## 0.Spring容器启动时初始化Bean是哪种 ##

> Spring容器在初始化容器的时候只会对所有的单例非懒加载的实例进行初始化。

## 1.构造函数的循环依赖 ##

> 首先Spring是解决不了构造函数的循环依赖的问题的，这是因为Spring解决循环依赖是通过三级缓存的方式来达成的，而所谓的第二级缓存存放的是实例化而未进行属性填充和初始化的不完整Bean实例，通过提前暴露ObjectFactory对象到三级缓存中来进行解决。而构造函数的循环依赖需要使用所依赖的对象来实例化自己，而这时是拿不到所依赖的对象的实例化后的不完整Bean，除非我们将这个Bean设置为懒加载，这样在进行构造函数注入的时候就可以避免循环依赖的问题了。【因为懒加载的Bean是不需要实例化的只有在用的时候才会进行相关操作】

## 2.Setter和属性注入的循环依赖 ##

> Setter和属性注入类似，我们就拿属性注入来说比如A依赖B ，B依赖A。

1.  当创建A的时候首先会对A去一级缓存里面找，当然了第一次是找不到的。
2.  在一级缓存找不到A ，就会设置A为创建状态，然后创建A
3.  getSingleton(String beanName, ObjectFactory<?> singletonFactory) 是用来创建A对象的，通过传入的lamda表达式进行创建
4.  首先会先实例化A对象 ，实例化之后会调用addSingletonFactory(beanName, () -> getEarlyBeanReference(beanName, mbd, bean));将A放入三级缓存

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);
    			}
    		}
    	}

1.  然后对A进行属性填充，因为B是A的成员变量所以会进行填充

if (pvs != null) { 
    			applyPropertyValues(beanName, mbd, bw, pvs);
    		}

1.  上面的方法会去调用工厂类的getBean方法去创建B

if (value instanceof RuntimeBeanReference) { 
    			RuntimeBeanReference ref = (RuntimeBeanReference) value;
    			return resolveReference(argName, ref);
    		}

1.  同样的B也会将自己及一个lamda表达式放入三级缓存内，
2.  此时进行到B的属性填充B要去获取A【就像上面5那样】同样的由于6部分的处理因为A也是RuntimeBeanReference所以回去调用A的创建而这时在1处我们一开始是获取不到A的，但是现在

@Nullable
    	protected Object getSingleton(String beanName, boolean allowEarlyReference) { 
    		//因为A还没有完成初始化所以一级缓存里没有A的Bean实例
    		Object singletonObject = this.singletonObjects.get(beanName);
    	　　//因为singletonObject 为null并且2的位置我们已经设置了A的创建状态所以可以进入到内层
    		if (singletonObject == null && isSingletonCurrentlyInCreation(beanName)) { 
    			synchronized (this.singletonObjects) { 
    				//我们放入二级缓存的操作所以此处为null，可以进入下一层
    				singletonObject = this.earlySingletonObjects.get(beanName);
    				if (singletonObject == null && allowEarlyReference) { 
    					//这个地方就是从三级缓存里获取我们4处放入的lamda表达式，因为已经放入所以不为null，可以进入下一层
    					ObjectFactory<?> singletonFactory = this.singletonFactories.get(beanName);
    					if (singletonFactory != null) { 
    						//这块就是执行我们放入的lamda方法，可以见第9处的说明，该方法返回的可能是Bean本身或代理对象
    						singletonObject = singletonFactory.getObject();
    						//将A放入二级缓存
    						this.earlySingletonObjects.put(beanName, singletonObject);
    						//删除A的三级缓存
    						this.singletonFactories.remove(beanName);
    					}
    				}
    			}
    		}
    		return singletonObject;
    	}

1.  先看一下三级缓存中匿名类的方法体

protected Object getEarlyBeanReference(String beanName, RootBeanDefinition mbd, Object bean) { 
    		Object exposedObject = bean;
    		if (!mbd.isSynthetic() && hasInstantiationAwareBeanPostProcessors()) { 
    			for (BeanPostProcessor bp : getBeanPostProcessors()) { 
    				if (bp instanceof SmartInstantiationAwareBeanPostProcessor) { 
    					SmartInstantiationAwareBeanPostProcessor ibp = (SmartInstantiationAwareBeanPostProcessor) bp;
    					//这个位置的方法跟下去回进行代理
    					exposedObject = ibp.getEarlyBeanReference(exposedObject, beanName);
    				}
    			}
    		}
    		return exposedObject;
    	}

1.  因为从三级缓存中找到了A所以通过bean = getObjectForBeanInstance(sharedInstance, name, beanName, null);返回了二级缓存中的A【这是一个不完整的Bean】
2.  然后继续进行B类的初始化然后B初始化完成也就是说B实例创建完了此时回到

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!)");
    				}
    				if (logger.isDebugEnabled()) { 
    					logger.debug("Creating shared instance of singleton bean '" + beanName + "'");
    				}
    				beforeSingletonCreation(beanName);
    				boolean newSingleton = false;
    				boolean recordSuppressedExceptions = (this.suppressedExceptions == null);
    				if (recordSuppressedExceptions) { 
    					this.suppressedExceptions = new LinkedHashSet<>();
    				}
    				try { 
    					//此时B实例获取完毕
    					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;
    					}
    					afterSingletonCreation(beanName);
    				}
    				if (newSingleton) { 
    					//将B 的 Bean放入单例池
    					addSingleton(beanName, singletonObject);
    				}
    			}
    			return singletonObject;
    		}
    	}
    
    
    	protected void addSingleton(String beanName, Object singletonObject) { 
    		synchronized (this.singletonObjects) { 
    			//将B放入一级缓存
    			this.singletonObjects.put(beanName, singletonObject);
    			//删除B在二级缓存的内容，其实这个位置并没有存在B，因为并没有像A一样的触发操作
    			this.singletonFactories.remove(beanName);
    			//删除B 在三级缓存中的值
    			this.earlySingletonObjects.remove(beanName);
    			this.registeredSingletons.add(beanName);
    		}
    	}

1.  这时A的属性填充已经完毕 ，开始进行A的初始化A初始化完成后，会像11处的那样将A放入一级缓存然后删除A的二级缓存。
2.  这样就解决了AB的循环依赖问题

# 二、为什么使用三级缓存 #

## 0.三级缓存都是什么 ##

public class DefaultSingletonBeanRegistry extends SimpleAliasRegistry implements SingletonBeanRegistry { 
    
    	/** Cache of singleton objects: bean name to bean instance. */
    	//单例对象缓存，beanName-Bean实例 【一级缓存】
    	private final Map<String, Object> singletonObjects = new ConcurrentHashMap<>(256);
    
    	/** Cache of singleton factories: bean name to ObjectFactory. */
    	//单例工厂缓存，beanName-ObjectFactory【三级缓存】
    	private final Map<String, ObjectFactory<?>> singletonFactories = new HashMap<>(16);
    
    	/** Cache of early singleton objects: bean name to bean instance. */
    	//初期的单例对象缓存【也就是只进行了实例化而未初始化的】这个是二级缓存
    	private final Map<String, Object> earlySingletonObjects = new HashMap<>(16);
    }

## 1.两级缓存 ##

> 如果只有两级缓存也就是没有singletonFactories ，那么其实对于普通的bean【所谓的普通的bean其实就是不需要进行代理的bean对象】两级缓存本身已经解决了循环依赖。

> 其实只需要singletonObjects 存放已经初始化完全的单例对象  
> earlySingletonObjects 存放未初始化完全的对象，当我们需要提前暴露依赖对象的时候就放在earlySingletonObjects 里就可以，如果初始化完全了就丢在singletonObjects这里，这样就可以解决循环依赖

## 2.为什么使用三级缓存 ##

> 想要明白这个地方首先要知道Bean的生命周期具体可以参考[Bean的生命周期][Bean]

### 2.1 后置处理可能会产生代理 ###

> 我们知道一个bean的生命周期主要是包括bean由xml或注解进行解析为Bean Definition然后注册到容器，之后就是实例化、属性填充、初始化，对于初始化之后如果实现了BeanPostProcessor接口则会执行postProcessAfterInitialization方法  
> org.springframework.aop.framework.autoproxy.AbstractAutoProxyCreator\#postProcessAfterInitialization  
> 这个类的
> 
>     @Override
>      public Object postProcessAfterInitialization(@Nullable Object >bean, String beanName) { 
>      	if (bean != null) { 
>      		Object cacheKey = getCacheKey(bean.getClass(), >beanName);
>      		//注意这个earlyProxyReferences
>      		//这块的逻辑就是如果早期代理引用缓存中有直接返回原始的实例化bean'【注意不是代理对象】没有的话或者不想等则正常进行代理
>      		if (this.earlyProxyReferences.remove(cacheKey) != bean) { 
>      			return wrapIfNecessary(bean, beanName, cacheKey);
>      		}
>      	}
>      	return bean;
>      }

> 我们回想一下1.2.9 也就是 一部分中的第九步，将A放入三级缓存的时候我们是将A对象和一个匿名内部类放在了三级缓存中，我们现在在会看一下这个lamda表达式

// Eagerly cache singletons to be able to resolve circular references
    		// even when triggered by lifecycle interfaces like BeanFactoryAware.
    		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");
    			}
    			addSingletonFactory(beanName, () -> getEarlyBeanReference(beanName, mbd, bean));
    		}

protected Object getEarlyBeanReference(String beanName, RootBeanDefinition mbd, Object bean) { 
    		Object exposedObject = bean;
    		if (!mbd.isSynthetic() && hasInstantiationAwareBeanPostProcessors()) { 
    			for (BeanPostProcessor bp : getBeanPostProcessors()) { 
    				if (bp instanceof SmartInstantiationAwareBeanPostProcessor) { 
    					SmartInstantiationAwareBeanPostProcessor ibp = (SmartInstantiationAwareBeanPostProcessor) bp;
    					//我们跟进去这个方法
    					exposedObject = ibp.getEarlyBeanReference(exposedObject, beanName);
    				}
    			}
    		}
    		return exposedObject;
    	}

default Object getEarlyBeanReference(Object bean, String beanName) throws BeansException { 
    		return bean;
    	}

*  这个方法有三个实现类 但是只有一个是有用的就是

@Override
    	public Object getEarlyBeanReference(Object bean, String beanName) { 
    		Object cacheKey = getCacheKey(bean.getClass(), beanName);
    		//就是在这个地方put的这样就避免了被代理两次的尴尬
    		this.earlyProxyReferences.put(cacheKey, bean);
    		return wrapIfNecessary(bean, beanName, cacheKey);
    	}

> 总之就是三级缓存是为了bean后置处理器部分代理时的问题产生的，如果没有三级代理，只有两级，那二级缓存放的时实例化后的对象，这样在执行后置处理的时候就会出现覆盖，而使用了三级缓存后，就保证了只有一个代理对象。

--------------------

[Spring]: https://blog.csdn.net/YangzaiLeHeHe/article/details/113390665
[Bean]: https://blog.csdn.net/YangzaiLeHeHe/article/details/113396586