Spring循環(huán)依賴正確性及Bean注入的順序關(guān)系詳解
一、前言
我們知道 Spring 可以是懶加載的，就是當(dāng)真正使用到 Bean 的時候才實例化 Bean。當(dāng)然也不全是這樣，例如配置 Bean 的 lazy-init 屬性，可以控制 Spring 的加載時機。現(xiàn)在機器的性能、內(nèi)存等都比較高，基本上也不使用懶加載，在容器啟動時候來加載bean，啟動時間稍微長一點兒，這樣在實際獲取 bean 供業(yè)務(wù)使用時，就可以減輕不少負擔(dān)，這個后面再做分析。 我們使用到 Bean 的時候，最直接的方式就是從 Factroy 中獲取，這個就是加載 Bean 實例的源頭。
最近在做項目時候遇到一個奇葩問題，就是bean依賴注入的正確性與bean直接注入的順序有關(guān)系，但是正常情況下明明是和順序沒關(guān)系的啊，究竟啥情況那，不急，讓我一一道來。
二、普通Bean循環(huán)依賴-與注入順序無關(guān)
2.1 循環(huán)依賴例子與原理
public class BeanA {
private BeanB beanB;
public BeanB getBeanB() {
return beanB;
}
public void setBeanB(BeanB beanB) {
this.beanB = beanB;
}
}
public class BeanB {
private BeanA beanA;
public BeanA getBeanA() {
return beanA;
}
public void setBeanA(BeanA beanA) {
this.beanA = beanA;
}
}
<bean id="beanA" class="com.alibaba.test.circle.BeanA"> <property name="beanB"> <ref bean="beanB" /> </property> </bean>
<bean id="beanB" class="com.alibaba.test.circle.BeanB"> <property name="beanA"> <ref bean="beanA" /> </property> </bean>
上述循環(huán)依賴注入能夠正常工作，這是因為Spring提供了EarlyBeanReference功能，首先Spring里面有個名字為singletonObjects的并發(fā)map用來存放所有實例化并且初始化好的bean，singletonFactories則用來存放需要解決循環(huán)依賴的bean信息（beanName,和一個回調(diào)工廠）。當(dāng)實例化beanA時候會觸發(fā)getBean(“beanA”);首先看singletonObjects中是否有beanA有則返回:
（1）
Object sharedInstance = getSingleton(beanName);//getSingleton(beanName,true);
if (sharedInstance != null && args == null) {
if (logger.isDebugEnabled()) {
if (isSingletonCurrentlyInCreation(beanName)) {
logger.debug("Returning eagerly cached instance of singleton bean '" + beanName +
"' that is not fully initialized yet - a consequence of a circular reference");
}
else {
logger.debug("Returning cached instance of singleton bean '" + beanName + "'");
}
}
// 如果是普通bean直接返回，工廠bean則返回sharedInstance.getObject();
bean = getObjectForBeanInstance(sharedInstance, name, beanName, null);
}
protected Object getSingleton(String beanName, boolean allowEarlyReference) {
Object singletonObject = this.singletonObjects.get(beanName);
if (singletonObject == null) {
synchronized (this.singletonObjects) {
singletonObject = this.earlySingletonObjects.get(beanName);
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 != NULL_OBJECT ? singletonObject : null);
}
一開始肯定沒有所以會實例化beanA，如果設(shè)置了allowCircularReferences=true（默認為true）并且當(dāng)前bean為單件并且該bean目前在創(chuàng)建中，則初始化屬性前把該bean信息放入singletonFactories單件map里面：
（2）
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");
}
addSingletonFactory(beanName, new ObjectFactory() {
public Object getObject() throws BeansException {
return getEarlyBeanReference(beanName, mbd, 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);
}
}
}
然后對該實例進行屬性注入beanB，屬性注入時候會getBean(“beanB”) ,發(fā)現(xiàn)beanB 不在singletonObjects中，就會實例化beanB,然后放入singletonFactories，然后進行屬性注入beanA,然后觸發(fā)getBean(“beanA”);這時候會到（1）getSingleton返回實例化的beanA。到此beanB初始化完畢添加beanB 到singletonObjects然后返回，然后beanA 初始化完畢，添加beanA到singletonObjects然后返回
2.2 允許循環(huán)依賴的開關(guān)
public class TestCircle2 {
private final static ClassPathXmlApplicationContext moduleContext;
private static Test test;
static {
moduleContext = new ClassPathXmlApplicationContext(new String[]{"beans-circile.xml"});
moduleContext.setAllowCircularReferences(false);
test = (Test) moduleContext.getBean("test");
}
public static void main(String[] args) {
System.out.println(test.name);
}
}
ClassPathXmlApplicationContext類中有個屬性allowCircularReferences用來控制是否允許循環(huán)依賴默認為true，這里設(shè)置為false后發(fā)現(xiàn)循環(huán)依賴還是可以正常運行，翻看源碼：
public ClassPathXmlApplicationContext(String[] configLocations) throws BeansException {
this(configLocations, true, null);
}
public ClassPathXmlApplicationContext(String[] configLocations, boolean refresh, ApplicationContext parent)
throws BeansException {
super(parent);
setConfigLocations(configLocations);
if (refresh) {
refresh();
}
}
public ClassPathXmlApplicationContext(String[] configLocations, boolean refresh, ApplicationContext parent)
throws BeansException {
super(parent);
setConfigLocations(configLocations);
if (refresh) {
refresh();
}
}
知道默認構(gòu)造ClassPathXmlApplicationContext時候會刷新容器。
refresh方法會調(diào)用refreshBeanFactory：
protected final void refreshBeanFactory() throws BeansException {
if (hasBeanFactory()) {
destroyBeans();
closeBeanFactory();
}
try {
// 創(chuàng)建bean工廠
DefaultListableBeanFactory beanFactory = createBeanFactory();
//定制bean工廠屬性
customizeBeanFactory(beanFactory);
loadBeanDefinitions(beanFactory);
synchronized (this.beanFactoryMonitor) {
this.beanFactory = beanFactory;
}
}
catch (IOException ex) {
throw new ApplicationContextException(
"I/O error parsing XML document for application context [" + getDisplayName() + "]", ex);
}
}
protected void customizeBeanFactory(DefaultListableBeanFactory beanFactory) {
if (this.allowBeanDefinitionOverriding != null) {
beanFactory.setAllowBeanDefinitionOverriding(this.allowBeanDefinitionOverriding.booleanValue());
}
if (this.allowCircularReferences != null) {
beanFactory.setAllowCircularReferences(this.allowCircularReferences.booleanValue());
}
}
到這里就知道了，我們在調(diào)用 moduleContext.setAllowCircularReferences(false)前，spring留出的設(shè)置bean工廠的回調(diào)customizeBeanFactory已經(jīng)執(zhí)行過了，最終原因是，調(diào)用設(shè)置前，bean工廠已經(jīng)refresh了，所以測試代碼改為：
public class TestCircle {
private final static ClassPathXmlApplicationContext moduleContext;
private static Test test;
static {
//初始化容器上下文，但是不刷新容器
moduleContext = new ClassPathXmlApplicationContext(new String[]{"beans-circile.xml"},false);
moduleContext.setAllowCircularReferences(false);
//刷新容器
moduleContext.refresh();
test = (Test) moduleContext.getBean("test");
}
public static void main(String[] args) {
System.out.println(test.name);
}
}
現(xiàn)在測試就會拋出異常：
Caused by: org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'beanA' defined in class path resource [beans-circile.xml]: Cannot resolve reference to bean 'beanB' while setting bean property 'beanB'; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'beanB' defined in class path resource [beans-circile.xml]: Cannot resolve reference to bean 'beanA' while setting bean property 'beanA'; nested exception is org.springframework.beans.factory.BeanCurrentlyInCreationException: Error creating bean with name 'beanA': Requested bean is currently in creation: Is there an unresolvable circular reference?
三、工廠Bean與普通Bean循環(huán)依賴-與注入順序有關(guān)
3.1 測試代碼
工廠bean
public class MyFactoryBean implements FactoryBean,InitializingBean{
private String name;
private Test test;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public DependentBean getDepentBean() {
return depentBean;
}
public void setDepentBean(DependentBean depentBean) {
this.depentBean = depentBean;
}
private DependentBean depentBean;
public Object getObject() throws Exception {
return test;
}
public Class getObjectType() {
// TODO Auto-generated method stub
return Test.class;
}
public boolean isSingleton() {
// TODO Auto-generated method stub
return true;
}
public void afterPropertiesSet() throws Exception {
System.out.println("name:" + this.name);
test = new Test();
test.name = depentBean.doSomething() + this.name;
}
}
為了簡化，只寫一個public的變量
public class Test {
public String name;
}
public class DependentBean {
public String doSomething(){
return "hello:";
}
@Autowired
private Test test;
}
xml配置
<bean id="test" class="com.alibaba.test.circle.MyFactoryBean"> <property name="depentBean"> <bean class="com.alibaba.test.circle.DependentBean"></bean> </property> <property name="name" value="zlx"></property> </bean>
其中工廠Bean MyFactoryBean作用是對Test類的包裝，首先對MyFactoryBean設(shè)置屬性，然后在MyFactoryBean的afterPropertiesSet方法中創(chuàng)建一個Test實例，并且設(shè)置屬性，實例化MyFactoryBean最終會調(diào)用getObject方法返回創(chuàng)建的Test對象。這里MyFactoryBean依賴了DepentBean，而depentBean本身有依賴了Test，所以這是個循環(huán)依賴
測試：
public class TestCircle2 {
private final static ClassPathXmlApplicationContext moduleContext;
private static Test test;
static {
moduleContext = new ClassPathXmlApplicationContext(new String[]{"beans-circile.xml"});
test = (Test) moduleContext.getBean("test");
}
public static void main(String[] args) {
System.out.println(test.name);
}
}
結(jié)果：
Caused by: org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'com.alibaba.test.circle.DependentBean#1c701a27': Autowiring of fields failed; nested exception is org.springframework.beans.factory.BeanCreationException: Could not autowire field: private com.alibaba.test.circle.Test com.alibaba.test.circle.DependentBean.test; nested exception is org.springframework.beans.factory.BeanCurrentlyInCreationException: Error creating bean with name 'test': FactoryBean which is currently in creation returned null from getObject
3.2 分析原因
當(dāng)實例化test時候會觸發(fā)getBean(“test”) ，會看當(dāng)前bean是否存在
不存在則創(chuàng)建Test 的實例，創(chuàng)建完畢后會把當(dāng)前bean信息放入singletonFactories單件map里面
然后對該實例進行屬性注入depentBean，屬性注入時候會getBean(“depentBean”) ,
發(fā)現(xiàn)depentBean 不存在，就會實例化depentBean,然后放入singletonFactories，
然后進行autowired注入test,然后觸發(fā)getBean(“test”);這時候會到（1）getSingleton返回實例化的test。由于test是工廠bean所以返回test.getObject（）;
而MyFactoryBean的afterPropertiesSet還沒被調(diào)用，所以test.getObject（）返回null.
下面列下Spring bean創(chuàng)建的流程：
getBean()->創(chuàng)建實例->autowired->set屬性->afterPropertiesSet
也就是調(diào)用getObject方法早于afterPropertiesSet方法被調(diào)用了。
那么我們修改下MyFactoryBean為如下：
public Object getObject() throws Exception {
// TODO Auto-generated method stub
if(null == test){
afterPropertiesSet();
}
return test;
}
public void afterPropertiesSet() throws Exception {
if(null == test){
System.out.println("name:" + this.name);
test = new Test();
test.name = depentBean.doSomething() + this.name;
}
}
也就是getObject內(nèi)部先判斷不如test==null那調(diào)用下afterPropertiesSet，然后afterPropertiesSet內(nèi)部如果test==null在創(chuàng)建Test實例，看起來貌似不錯，好想可以解決我們的問題。但是實際上還是不行的，因為afterPropertiesSet內(nèi)部使用了depentBean，而此時depentBean=null。
3.3 思考如何解決
3.2分析原因是先創(chuàng)建了MyFactoryBean，并在在創(chuàng)建MyFactoryBean的過程中有創(chuàng)建了DepentBean，而創(chuàng)建DepentBean時候需要autowired MyFactoryBean的實例，然后要調(diào)用afterPropertiesSet前調(diào)用getObject方法所以返回null。
那如果先創(chuàng)建DepentBean，然后在創(chuàng)建MyFactoryBean那？下面分析下過程：
首先會實例化DepentBean，并且加入到singletonFactories
DepentBean實例會autowired Test,所以會先創(chuàng)建Test實例
創(chuàng)建Test實例，然后加入singletonFactories
Test實例會屬性注入DepentBean實例，所以會getBean(“depentBean”);
getBean(“depentBean”) 發(fā)現(xiàn)singletonFactories中已經(jīng)有depentBean了，則返回depentBean對象
因為depentBean不是工廠bean所以直接返回depentBean
Test實例會屬性注入DepentBean實例成功，Test實例初始化OK
DepentBean實例會autowired Test實例OK
按照這分析先創(chuàng)建DepentBean，然后在實例化MyFactoryBean是可行的，修改xml為如下：
<bean id="dependentBean" class="com.alibaba.test.circle.DependentBean"></bean> <bean id="test" class="com.alibaba.test.circle.MyFactoryBean"> <property name="depentBean"> <ref bean="dependentBean" /> </property> <property name="name" value="zlx"></property> </bean>
測試運行結(jié)果：
name:zlx
hello:zlx
果真可以了，那按照這分析，上面XML配置如果調(diào)整了聲明順序，肯定也是會出錯的，因為test創(chuàng)建比dependentBean早，測試下果然如此。另外可想而知工廠bean循環(huán)依賴工廠bean時候無論聲明順序如何必然也會失敗。
3.3 一個思考
上面先注入了MyFactoryBean中需要使用的dependentBean，然后注入MyFactoryBean，問題就解決了。那么如果需要在另外一個Bean中使用創(chuàng)建的id=”test”的對象時候，這個Bean該如何注入那？
類似下面的方式，會成功？留給大家思考^^
public class UseTest {
@Autowired
private Test test;
}
<bean id="useTest" class="com.alibaba.test.circle.UseTest"></bean> <bean id="dependentBean" class="com.alibaba.test.circle.DependentBean"></bean> <bean id="test" class="com.alibaba.test.circle.MyFactoryBean"> <property name="depentBean"> <ref bean="dependentBean" /> </property> <property name="name" value="zlx"></property> </bean>
四、 總結(jié)
普通Bean之間相互依賴時候Bean注入順序是沒有關(guān)系的，但是工廠Bean與普通Bean相互依賴時候則必須先實例化普通bean,這是因為工廠Bean的特殊性，也就是其有個getObject方法的緣故。
好了，以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，如果有疑問大家可以留言交流，謝謝大家對腳本之家的支持。
相關(guān)文章
這篇文章主要介紹了mybatis打印SQL,并顯示參數(shù)的實例，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-12-12
Java泛型（generics）是JDK5中引入的一個新特性，泛型提供了 編譯時類型安全監(jiān)測機制，該機制允許我們在編譯時檢測到非法的類型數(shù)據(jù)結(jié)構(gòu),這篇文章主要介紹了java泛型的基本概念及使用詳解，感興趣的朋友跟隨小編一起看看吧2022-10-10
這篇文章主要介紹了Java反射 Field類的使用全方位解析，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2021-04-04
Java是一門純面向?qū)ο蟮恼Z言（Object?Oriented?Program,繼承OOP），在面對對象的世界里面，一切皆為對象。面向?qū)ο笫墙鉀Q問題的一種思想，主要依靠對象之間的交互完成一件事情2022-03-03
這篇文章主要為大家詳細介紹了java spark文件讀取亂碼問題的相關(guān)解決方法,文中的示例代碼講解詳細,感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2024-10-10
泛型機制在項目中一直都在使用，不僅如此，很多源碼中都用到了泛型機制。本文將通過一些示例帶大家深入了解一下Java的泛型機制，需要的可以了解一下2022-10-10
這篇文章主要介紹了Java如何通過Socket同時發(fā)送文本和文件問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-08-08
Mybatis分頁插件PageHelper的配置和簡單使用方法(推薦)
在使用Java Spring開發(fā)的時候，Mybatis算是對數(shù)據(jù)庫操作的利器了。這篇文章主要介紹了Mybatis分頁插件PageHelper的配置和使用方法,需要的朋友可以參考下2017-12-12
Java協(xié)程編程之Loom項目實戰(zhàn)記錄
這篇文章主要介紹了Java協(xié)程編程之Loom項目嘗鮮,如果用嘗鮮的角度去使用Loom項目，可以提前窺探JVM開發(fā)者們是如何基于協(xié)程這個重大特性進行開發(fā)的，這對于提高學(xué)習(xí)JDK內(nèi)核代碼的興趣有不少幫助，需要的朋友可以參考下2021-08-08
這篇文章主要給大家介紹了關(guān)于Java中短路運算符與邏輯運算符的相關(guān)資料，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-01-01