Happyjava's blog site

Happyjava's blog site,分享编程知识,顺便发发牢骚

0%

Spring中解决循环依赖报错的问题

什么是循环依赖

当一个ClassA依赖于ClassB,然后ClassB又反过来依赖ClassA,这就形成了一个循环依赖:

ClassA -> ClassB -> ClassA

Spring的循环依赖问题

当你使用构造注入依赖的时候,就有可能发生循环依赖然后报错的问题。什么是构造注入呢?可以看如下代码:

假设有ClassA和ClassB如下:

ClassA.java

1
2
3
4
5
6
7
8
9
10
11
@Data
@Component
public class ClassA {

private final ClassB classB;

public ClassA(ClassB classB) {
this.classB = classB;
}
}

ClassB.java

1
2
3
4
5
6
7
8
9
10
@Data
@Component
public class ClassB {

private final ClassA classA;

public ClassB(ClassA classA) {
this.classA = classA;
}
}

就是在类的构造方法里,把依赖注入,这就是所说的构造注入。

构造注入,也是Spring团队推荐的Spring依赖注入的方式(依赖来自IDEA的提示):

虽然是Spring的官方推荐,但是这种方式就是容易出现循环依赖导致程序跑不起来的情况:

当然,也存在多种解决循环依赖的办法,下面一一演示。

重新设计代码

当出现循环依赖的时候,可以考虑重新设计下代码。一般来说,当循环依赖问题出现的时候,往往其原因是设计上分层没有处理好,各个类的耦合度高,各自的职责不够单一。

当然,很多时候,我们也没有那么多时间去重新设计代码。那么,我们可以采取别的方式。

使用懒加载

可以通过Spring提供的@Lazy注解,让Spring懒加载,即当真正需要使用到该bean的时候,再去加载。如,我给上面的示例代码的ClassB的构造方法加入@Lazy注解:

1
2
3
4
5
6
7
8
9
10
@Data
@Component
public class ClassB {

private final ClassA classA;

public ClassB(@Lazy ClassA classA) {
this.classA = classA;
}
}

再次启动,就会发现循环依赖报错问题不存在了。

直接使用Autowired单独注入

直接使用@Autowired注入依赖,不要使用构造器的方式注入

1
2
3
4
5
6
7
8
@Data
@Component
public class ClassB {

@Autowired
private ClassA classA;

}
1
2
3
4
5
6
7
8
9
@Data
@Component
public class ClassA {

@Autowired
private ClassB classB;

}

这种方式,也可以解决Spring循环依赖的问题。

使用Setter注入

除了以上两种方式,还可以通过setter的方式来注入依赖。如下:

ClassA.class

1
2
3
4
5
6
7
8
9
10
11
@Data
@Component
public class ClassA {

private ClassB classB;

@Autowired
public void setClassB(ClassB classB) {
this.classB = classB;
}
}

ClassB.class

1
2
3
4
5
6
7
8
9
10
11
12
@Data
@Component
public class ClassB {

private ClassA classA;

@Autowired
public void setClassA(ClassA classA) {
this.classA = classA;
}
}

通过Setter注入依赖的方式,一样可以解决Spring循环依赖的问题。

总结

使用Spring作为开发框架,一不小心就会碰到循环依赖,程序启动不了的问题。如果真的出现了循环依赖的问题,可以尝试采用上面的几种方式解决。当然,解决的办法还有很多,比如,还可以通过PostConstruct注解来解决(摘抄baeldung的博客):

方法可能有很多种,就不太深入探讨了。