Spring的循环依赖

鱼跃鹰飞

已于 2023-04-05 21:45:12 修改

阅读量432

点赞数

文章标签： spring java 后端

于 2023-04-05 21:43:50 首次发布

本文链接：https://blog.csdn.net/Chang_Yafei/article/details/129975797

版权

以前比较懒，每次复习的时候对于Spring的循环依赖都需要去视频网站找视频或者到各个博客网站找帖子，每次都要浪费时间，现在我把我所学到的总结一下

Spring循环依赖的三种方式

引言：循环依赖就是N个类中循环嵌套引用，如果在日常开发中我们用new 对象的方式发生这种循环依赖的话程序会在运行时一直循环调用，直至内存溢出报错。下面说一下Spring是如果解决循环依赖的。

第一种：构造器参数循环依赖 Spring容器会将每一个正在创建的Bean 标识符放在一个“当前创建Bean池”中，Bean标识符在创建过程中将一直保持在这个池中，因此如果在创建Bean过程中发现自己已经在“当前创建Bean池”里时将抛出 BeanCurrentlyInCreationException异常表示循环依赖；而对于创建完毕的Bean将从“当前创建Bean池” 中清除掉。首先我们先初始化三个Bean。

public class StudentA {
private StudentB studentB;
public void setStudentB(StudentB studentB) {
this.studentB = studentB;
}
public StudentA() {}
public StudentA(StudentB studentB) {
this.studentB = studentB;
}
}
public class StudentB {
private StudentC studentC;
public void setStudentC(StudentC studentC) {
this.studentC = studentC;
}
public StudentB() {}
public StudentB(StudentC studentC) {
this.studentC = studentC;
}
}
public class StudentC {
private StudentA studentA;
public void setStudentA(StudentA studentA) {
this.studentA = studentA;
}
public StudentC() {}
}

OK，上面是很基本的3个类，，StudentA有参构造是StudentB。StudentB的有参构造是StudentC， StudentC的有参构造是StudentA ，这样就产生了一个循环依赖的情况，我们都把这三个Bean交给Spring管理，并用有参构造实例化

<bean id="a" class="com.zfx.student.StudentA">
    <constructor-arg index="0" ref="b"></constructor-arg>
</bean>
<bean id="b" class="com.zfx.student.StudentB">
    <constructor-arg index="0" ref="c"></constructor-arg>
</bean>
<bean id="c" class="com.zfx.student.StudentC">
    <constructor-arg index="0" ref="a"></constructor-arg>
</bean>

下面是测试类：

public class Test {
    public static void main(String[] args) {
        ApplicationContext context = new
        ClassPathXmlApplicationContext("com/zfx/student/applicationContext.xml");
        //System.out.println(context.getBean("a", StudentA.class));
    }
}

执行结果报错信息为：

Caused by: org.springframework.beans.factory.BeanCurrentlyInCreationException:
Error creating bean with name 'a': Requested bean is currently in creation:
Is there an unresolvable circular reference?

如果大家理解开头那句话的话，这个报错应该不惊讶，Spring容器先创建单例StudentA，StudentA依赖 StudentB，然后将A放在“当前创建Bean池”中，此时创建StudentB,StudentB依赖StudentC ,然后将B放在“当前创建Bean池”中,此时创建StudentC，StudentC又依赖StudentA，但是，此时Student已经在池中，所以会报错，，因为在池中的Bean都是未初始化完的，所以会依赖错误，（初始化完的Bean会从池中移除）

第二种：setter方式单例，默认方式如果要说setter方式注入的话，我们最好先看一张Spring中Bean实例化的图（我画的生命周期图的一部分，阅读破1000我会将整图贴到底部）

如图中前两步骤得知：*Spring是先将Bean对象实例化之后再设置对象属性的* * * 修改配置文件为set方式注入

<!--scope="singleton"(默认就是单例方式) -->
<bean id="a" class="com.zfx.student.StudentA" scope="singleton">
    <property name="studentB" ref="b"></property>
</bean>
<bean id="b" class="com.zfx.student.StudentB" scope="singleton">
    <property name="studentC" ref="c"></property>
</bean>
<bean id="c" class="com.zfx.student.StudentC" scope="singleton">
    <property name="studentA" ref="a"></property>
</bean>

下面是测试类：

public class Test {
    public static void main(String[] args) {
        ApplicationContext context = new
        ClassPathXmlApplicationContext("com/zfx/student/applicationContext.xml");
        System.out.println(context.getBean("a", StudentA.class));
    }
}

打印结果为

com.zfx.student.StudentA@1fbfd6

为什么用set方式就不报错了呢？我们结合上面那张图看，Spring先是用构造实例化Bean对象，此时Spring会将这个实例化结束的对象放到一个Map中，并且Spring提供了获取这个未设置属性的实例化对象引用的方法。结合我们的实例来看，，当Spring实例化了StudentA、StudentB、StudentC后，紧接着会去设置对象的属性，此时StudentA依赖StudentB，就会去Map中取出存在里面的单例StudentB对象，以此类推，不会出来循环的问题喽、

** ** 下面是Spring源码中的实现方法，。以下的源码在Spring的Bean包中的 *DefaultSingletonBeanRegistry*.java类中

/**
	 * 一级缓存
	 * 用于保存BeanName和创建bean实例之间的关系
	 *
	 * Cache of singleton objects: bean name to bean instance. */
//	private final Map<String, Object> singletonObjects = new ConcurrentHashMap<>(256);
	public final Map<String, Object> singletonObjects = new ConcurrentHashMap<>(256);

	/**
	 * 三级缓存
	 * 用于保存BeanName和创建bean的工厂之间的关系
	 *
	 * Cache of singleton factories: bean name to ObjectFactory. */
//	private final Map<String, ObjectFactory<?>> singletonFactories = new HashMap<>(16);
	public final Map<String, ObjectFactory<?>> singletonFactories = new HashMap<>(16);

	/**
	 * 二级缓存
	 * 保存BeanName和创建bean实例之间的关系，与singletonFactories的不同之处在于，当一个单例bean被放到这里之后，那么当bean还在创建过程中
	 * 就可以通过getBean方法获取到，可以方便进行循环依赖的检测
	 *
	 * Cache of early singleton objects: bean name to bean instance. */
//	private final Map<String, Object> earlySingletonObjects = new ConcurrentHashMap<>(16);
	public final Map<String, Object> earlySingletonObjects = new ConcurrentHashMap<>(16);

/**
	 * 将beanName和singletonObject的映射关系添加到该工厂的单例缓存中
	 *
	 * Add the given singleton object to the singleton cache of this factory.
	 * <p>To be called for eager registration of singletons.
	 * @param beanName the name of the bean
	 * @param singletonObject the singleton object
	 */
	protected void addSingleton(String beanName, Object singletonObject) {
		synchronized (this.singletonObjects) {
			// 将映射关系添加到单例对象的高速缓存中
			this.singletonObjects.put(beanName, singletonObject);
			// 移除beanName在单例工厂缓存中的数据
			this.singletonFactories.remove(beanName);
			// 移除beanName在早期单例对象的高速缓存的数据
			this.earlySingletonObjects.remove(beanName);
			// 将beanName添加到已注册的单例集中
			this.registeredSingletons.add(beanName);
		}
	}

	/**
	 * 如果需要，添加给定的单例对象工厂来构建指定的单例对象
	 *
	 * Add the given singleton factory for building the specified singleton
	 * if necessary.
	 * <p>To be called for eager registration of singletons, e.g. to be able to
	 * resolve circular references.
	 * @param beanName the name of the bean
	 * @param singletonFactory the factory for the singleton object
	 */
	protected void addSingletonFactory(String beanName, ObjectFactory<?> singletonFactory) {
		Assert.notNull(singletonFactory, "Singleton factory must not be null");
		// 使用singletonObjects进行加锁，保证线程安全
		synchronized (this.singletonObjects) {
			// 如果单例对象的高速缓存【beam名称-bean实例】没有beanName的对象
			if (!this.singletonObjects.containsKey(beanName)) {
				// 将beanName,singletonFactory放到单例工厂的缓存【bean名称 - ObjectFactory】
				this.singletonFactories.put(beanName, singletonFactory);
				// 从早期单例对象的高速缓存【bean名称-bean实例】 移除beanName的相关缓存对象
				this.earlySingletonObjects.remove(beanName);
				// 将beanName添加已注册的单例集中
				this.registeredSingletons.add(beanName);
			}
		}
	}

第三种：setter方式原型，prototype 修改配置文件为：

<bean id="a" class="com.zfx.student.StudentA" scope="prototype">
    <property name="studentB" ref="b"></property>
</bean>
<bean id="b" class="com.zfx.student.StudentB" scope="prototype">
    <property name="studentC" ref="c"></property>
</bean>
<bean id="c" class="com.zfx.student.StudentC" scope="prototype">
    <property name="studentA" ref="a"></property>
</bean>

scope="prototype" 意思是每次请求都会创建一个实例对象。两者的区别是：有状态的bean都使用 Prototype作用域，无状态的一般都使用singleton单例作用域。

测试用例：

public class Test {
    public static void main(String[] args) {
        ApplicationContext context = new
        ClassPathXmlApplicationContext("com/zfx/student/applicationContext.xml");
        //此时必须要获取Spring管理的实例，因为现在scope="prototype" 只有请求获取的时候才会
        实例化对象
        System.out.println(context.getBean("a", StudentA.class));
    }
}

打印结果：

Caused by: org.springframework.beans.factory.BeanCurrentlyInCreationException:
Error creating bean with name 'a': Requested bean is currently in creation:
Is there an unresolvable circular reference

为什么原型模式就报错了呢？对于“prototype”作用域Bean，Spring容器无法完成依赖注入，因为“prototype”作用域的Bean， Spring容器不进行缓存，因此无法提前暴露一个创建中的Bean。

未完待续

鱼跃鹰飞

关注

0
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
Spring的循环依赖

如果大家理解开头那句话的话，这个报错应该不惊讶，Spring容器先创建单例StudentA，StudentA依赖 StudentB，然后将A放在“当前创建Bean池”中，此时创建StudentB,StudentB依赖StudentC ,然后将B放在“当前创建Bean池”中,此时创建StudentC，StudentC又依赖StudentA，但是，此时Student已经在池中，所以会报错，，因为在池中的Bean都是未初始化完的，所以会依赖错误，（初始化完的Bean会从池中移除）
复制链接

扫一扫