我們一起聊聊什么是Spring的循環(huán)依賴
1. 什么是循環(huán)依賴?
一般場景是一個(gè)Bean A依賴Bean B,而Bean B也依賴Bean A :Bean A → Bean B → Bean A當(dāng)然我們也可以添加更多的依賴層次,比如:Bean A → Bean B → Bean C → Bean D → Bean E → Bean A
2. Spring中的循環(huán)依賴
當(dāng)Spring上下文在加載所有的bean時(shí),他會(huì)嘗試按照他們他們關(guān)聯(lián)關(guān)系的順序進(jìn)行創(chuàng)建。比如,如果不存在循環(huán)依賴時(shí),例如:Bean A → Bean B → Bean CSpring會(huì)先創(chuàng)建Bean C,再創(chuàng)建Bean B(并將Bean C注入到Bean B中),最后再創(chuàng)建Bean A(并將Bean B注入到Bean A中)。但是,如果我們存在循環(huán)依賴,Spring上下文不知道應(yīng)該先創(chuàng)建哪個(gè)Bean,因?yàn)樗鼈円蕾囉诒舜?。在這種情況下,Spring會(huì)在加載上下文時(shí),拋出一個(gè)BeanCurrentlyInCreationException。當(dāng)我們使用構(gòu)造方法進(jìn)行注入時(shí),就會(huì)遇到這種情況。如果您使用其它類型的注入,你應(yīng)該不會(huì)遇到這個(gè)問題。因?yàn)樗窃谛枰獣r(shí)才會(huì)被注入,而不是上下文加載被要求注入。
3. 讓我們看一個(gè)例子
我們定義兩個(gè)Bean并且互相依賴(通過構(gòu)造函數(shù)注入)。
package com.test.demo.service;
import org.springframework.stereotype.Component;
import javax.annotation.Resource;
@Component
public class A {
private B b;
public A (B b) {
this.b = b;
}
}
package com.test.demo.service;
import org.springframework.stereotype.Component;
import javax.annotation.Resource;
@Component
public class B {
private A a ;
public B(A a) {
this.a = a;
}
}
這個(gè)時(shí)候我們我們啟動(dòng)項(xiàng)目就會(huì)發(fā)現(xiàn)項(xiàng)目啟動(dòng)不起來,如下提示信息
/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/bin/java -XX:TieredStopAtLevel=1 -noverify -Dspring.output.ansi.enabled=always -Dcom.sun.management.jmxremote -Dspring.jmx.enabled=true -Dspring.liveBeansView.mbeanDomain -Dspring.application.admin.enabled=true -javaagent:/private/var/folders/03/_9q6fw895913yznz6wq544_00000gn/T/AppTranslocation/332DF0A0-AF1B-49F1-8739-1BF4A9F4BAF7/d/IntelliJ IDEA.app/Contents/lib/idea_rt.jar=50456:/private/var/folders/03/_9q6fw895913yznz6wq544_00000gn/T/AppTranslocation/332DF0A0-AF1B-49F1-8739-1BF4A9F4BAF7/d/IntelliJ IDEA.app/Contents/bin -Dfile.encoding=UTF-8 -classpath /Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/jre/lib/charsets.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/jre/lib/deploy.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/jre/lib/ext/cldrdata.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/jre/lib/ext/dnsns.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/jre/lib/ext/jaccess.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/jre/lib/ext/jfxrt.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/jre/lib/ext/localedata.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/jre/lib/ext/nashorn.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/jre/lib/ext/sunec.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/jre/lib/ext/sunjce_provider.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/jre/lib/ext/sunpkcs11.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/jre/lib/ext/zipfs.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/jre/lib/javaws.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/jre/lib/jce.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/jre/lib/jfr.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/jre/lib/jfxswt.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/jre/lib/jsse.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/jre/lib/management-agent.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/jre/lib/plugin.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/jre/lib/resources.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/jre/lib/rt.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/lib/ant-javafx.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/lib/dt.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/lib/javafx-mx.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/lib/jconsole.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/lib/packager.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/lib/sa-jdi.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home/lib/tools.jar:/Users/haolonglong/IdeaProjects/project_boot/target/classes:/Users/haolonglong/.m2/repository/org/springframework/boot/spring-boot-starter-web/2.4.0-SNAPSHOT/spring-boot-starter-web-2.4.0-20200709.121446-178.jar:/Users/haolonglong/.m2/repository/org/springframework/boot/spring-boot-starter-json/2.4.0-SNAPSHOT/spring-boot-starter-json-2.4.0-20200709.121446-178.jar:/Users/haolonglong/.m2/repository/com/fasterxml/jackson/core/jackson-databind/2.11.1/jackson-databind-2.11.1.jar:/Users/haolonglong/.m2/repository/com/fasterxml/jackson/core/jackson-annotations/2.11.1/jackson-annotations-2.11.1.jar:/Users/haolonglong/.m2/repository/com/fasterxml/jackson/core/jackson-core/2.11.1/jackson-core-2.11.1.jar:/Users/haolonglong/.m2/repository/com/fasterxml/jackson/datatype/jackson-datatype-jdk8/2.11.1/jackson-datatype-jdk8-2.11.1.jar:/Users/haolonglong/.m2/repository/com/fasterxml/jackson/datatype/jackson-datatype-jsr310/2.11.1/jackson-datatype-jsr310-2.11.1.jar:/Users/haolonglong/.m2/repository/com/fasterxml/jackson/module/jackson-module-parameter-names/2.11.1/jackson-module-parameter-names-2.11.1.jar:/Users/haolonglong/.m2/repository/org/springframework/boot/spring-boot-starter-tomcat/2.4.0-SNAPSHOT/spring-boot-starter-tomcat-2.4.0-20200709.121446-178.jar:/Users/haolonglong/.m2/repository/org/apache/tomcat/embed/tomcat-embed-core/9.0.36/tomcat-embed-core-9.0.36.jar:/Users/haolonglong/.m2/repository/org/glassfish/jakarta.el/3.0.3/jakarta.el-3.0.3.jar:/Users/haolonglong/.m2/repository/org/apache/tomcat/embed/tomcat-embed-websocket/9.0.36/tomcat-embed-websocket-9.0.36.jar:/Users/haolonglong/.m2/repository/org/springframework/spring-web/5.3.0-M1/spring-web-5.3.0-M1.jar:/Users/haolonglong/.m2/repository/org/springframework/spring-beans/5.3.0-M1/spring-beans-5.3.0-M1.jar:/Users/haolonglong/.m2/repository/org/springframework/spring-webmvc/5.3.0-M1/spring-webmvc-5.3.0-M1.jar:/Users/haolonglong/.m2/repository/org/springframework/spring-aop/5.3.0-M1/spring-aop-5.3.0-M1.jar:/Users/haolonglong/.m2/repository/org/springframework/spring-context/5.3.0-M1/spring-context-5.3.0-M1.jar:/Users/haolonglong/.m2/repository/org/springframework/spring-expression/5.3.0-M1/spring-expression-5.3.0-M1.jar:/Users/haolonglong/.m2/repository/org/springframework/boot/spring-boot-starter/2.4.0-SNAPSHOT/spring-boot-starter-2.4.0-20200709.121446-178.jar:/Users/haolonglong/.m2/repository/org/springframework/boot/spring-boot/2.4.0-SNAPSHOT/spring-boot-2.4.0-20200709.121446-178.jar:/Users/haolonglong/.m2/repository/org/springframework/boot/spring-boot-autoconfigure/2.4.0-SNAPSHOT/spring-boot-autoconfigure-2.4.0-20200709.121446-178.jar:/Users/haolonglong/.m2/repository/org/springframework/boot/spring-boot-starter-logging/2.4.0-SNAPSHOT/spring-boot-starter-logging-2.4.0-20200709.121446-178.jar:/Users/haolonglong/.m2/repository/ch/qos/logback/logback-classic/1.2.3/logback-classic-1.2.3.jar:/Users/haolonglong/.m2/repository/ch/qos/logback/logback-core/1.2.3/logback-core-1.2.3.jar:/Users/haolonglong/.m2/repository/org/apache/logging/log4j/log4j-to-slf4j/2.13.3/log4j-to-slf4j-2.13.3.jar:/Users/haolonglong/.m2/repository/org/apache/logging/log4j/log4j-api/2.13.3/log4j-api-2.13.3.jar:/Users/haolonglong/.m2/repository/org/slf4j/jul-to-slf4j/1.7.30/jul-to-slf4j-1.7.30.jar:/Users/haolonglong/.m2/repository/jakarta/annotation/jakarta.annotation-api/1.3.5/jakarta.annotation-api-1.3.5.jar:/Users/haolonglong/.m2/repository/org/springframework/spring-core/5.3.0-M1/spring-core-5.3.0-M1.jar:/Users/haolonglong/.m2/repository/org/springframework/spring-jcl/5.3.0-M1/spring-jcl-5.3.0-M1.jar:/Users/haolonglong/.m2/repository/org/yaml/snakeyaml/1.26/snakeyaml-1.26.jar:/Users/haolonglong/.m2/repository/org/slf4j/slf4j-api/1.7.30/slf4j-api-1.7.30.jar com.test.demo.DemoApplication
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v2.4.0-SNAPSHOT)
2020-07-10 08:01:20.125 INFO 879 --- [ main] com.test.demo.DemoApplication : Starting DemoApplication using Java 1.8.0_211 on localhost with PID 879 (/Users/haolonglong/IdeaProjects/project_boot/target/classes started by haolonglong in /Users/haolonglong/IdeaProjects/project_boot)
2020-07-10 08:01:20.128 INFO 879 --- [ main] com.test.demo.DemoApplication : No active profile set, falling back to default profiles: default
2020-07-10 08:01:21.143 INFO 879 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat initialized with port(s): 8080 (http)
2020-07-10 08:01:21.155 INFO 879 --- [ main] o.apache.catalina.core.StandardService : Starting service [Tomcat]
2020-07-10 08:01:21.155 INFO 879 --- [ main] org.apache.catalina.core.StandardEngine : Starting Servlet engine: [Apache Tomcat/9.0.36]
2020-07-10 08:01:21.226 INFO 879 --- [ main] o.a.c.c.C.[Tomcat].[localhost].[/] : Initializing Spring embedded WebApplicationContext
2020-07-10 08:01:21.226 INFO 879 --- [ main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 1051 ms
2020-07-10 08:01:21.263 WARN 879 --- [ main] ConfigServletWebServerApplicationContext : Exception encountered during context initialization - cancelling refresh attempt: org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'a' defined in file [/Users/haolonglong/IdeaProjects/project_boot/target/classes/com/test/demo/service/A.class]: Unsatisfied dependency expressed through constructor parameter 0; nested exception is org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'b' defined in file [/Users/haolonglong/IdeaProjects/project_boot/target/classes/com/test/demo/service/B.class]: Unsatisfied dependency expressed through constructor parameter 0; nested exception is org.springframework.beans.factory.BeanCurrentlyInCreationException: Error creating bean with name 'a': Requested bean is currently in creation: Is there an unresolvable circular reference?
2020-07-10 08:01:21.265 INFO 879 --- [ main] o.apache.catalina.core.StandardService : Stopping service [Tomcat]
2020-07-10 08:01:21.276 INFO 879 --- [ main] ConditionEvaluationReportLoggingListener :
Error starting ApplicationContext. To display the conditions report re-run your application with 'debug' enabled.
2020-07-10 08:01:21.278 ERROR 879 --- [ main] o.s.b.d.LoggingFailureAnalysisReporter :
***************************
APPLICATION FAILED TO START
***************************
Description:
The dependencies of some of the beans in the application context form a cycle:
┌─────┐
| a defined in file [/Users/haolonglong/IdeaProjects/project_boot/target/classes/com/test/demo/service/A.class]
↑ ↓
| b defined in file [/Users/haolonglong/IdeaProjects/project_boot/target/classes/com/test/demo/service/B.class]
└─────┘
Process finished with exit code 1
4 解決方法
4.1 重新設(shè)計(jì)
當(dāng)你有一個(gè)循環(huán)依賴,很可能你有一個(gè)設(shè)計(jì)問題并且各責(zé)任沒有得到很好的分離。你應(yīng)該盡量正確地重新設(shè)計(jì)組件,以便它們的層次是精心設(shè)計(jì)的,也沒有必要循環(huán)依賴。如果不能重新設(shè)計(jì)組件(可能有很多的原因:遺留代碼,已經(jīng)被測試并不能修改代碼,沒有足夠的時(shí)間或資源來完全重新設(shè)計(jì)......),但有一些變通方法來解決這個(gè)問題。
4.2 使用 @Lazy
解決Spring 循環(huán)依賴的一個(gè)簡單方法就是對一個(gè)Bean使用延時(shí)加載。也就是說:這個(gè)Bean并沒有完全的初始化完,實(shí)際上他注入的是一個(gè)代理,只有當(dāng)他首次被使用的時(shí)候才會(huì)被完全的初始化。
package com.test.demo.service;
import org.springframework.context.annotation.Lazy;
import org.springframework.stereotype.Component;
import javax.annotation.Resource;
@Component
public class A {
private B b;
public A (@Lazy B b) {
this.b = b;
}
}
4.3 使用 Setter/Field 注入
其中最流行的解決方法,就是Spring文檔中建議,使用setter注入。簡單地說,你對你須要注入的bean是使用setter注入(或字段注入),而不是構(gòu)造函數(shù)注入。通過這種方式創(chuàng)建Bean,實(shí)際上它此時(shí)的依賴并沒有被注入,只有在你須要的時(shí)候他才會(huì)被注入進(jìn)來。
package com.test.demo.service;
import org.springframework.context.annotation.Lazy;
import org.springframework.stereotype.Component;
import javax.annotation.Resource;
@Component
public class A {
private B b;
public void setB(B b) {
this.b = b;
}
public B getB() {
return b;
}
}
package com.test.demo.service;
import org.springframework.stereotype.Component;
import javax.annotation.Resource;
@Component
public class B {
private A a ;
public void setA(A a) {
this.a = a;
}
public A getA() {
return a;
}
}
4.4 使用 @PostConstruct
打破循環(huán)的另一種方式是,在要注入的屬性(該屬性是一個(gè)bean)上使用 @Autowired ,并使用@PostConstruct 標(biāo)注在另一個(gè)方法,且該方法里設(shè)置對其他的依賴。我們的Bean將修改成下面的代碼:
4.5 實(shí)現(xiàn)ApplicationContextAware and InitializingBean接口
如果一個(gè)Bean實(shí)現(xiàn)了ApplicationContextAware,該Bean可以訪問Spring上下文,并可以從那里獲取到其他的bean。實(shí)現(xiàn)InitializingBean接口,表明這個(gè)bean在所有的屬性設(shè)置完后做一些后置處理操作(調(diào)用的順序?yàn)閕nit-method后調(diào)用);在這種情況下,我們需要手動(dòng)設(shè)置依賴。
@Component
public class CircularDependencyA implements ApplicationContextAware, InitializingBean {
private CircularDependencyB circB;
private ApplicationContext context;
public CircularDependencyB getCircB() {
return circB;
}
@Override
public void afterPropertiesSet() throws Exception {
circB = context.getBean(CircularDependencyB.class);
}
@Override
public void setApplicationContext(final ApplicationContext ctx) throws BeansException {
context = ctx;
}
}
public class CircularDependencyB {
private CircularDependencyA circA;
private String message = "Hi!";
@Autowired
public void setCircA(CircularDependencyA circA) {
this.circA = circA;
}
public String getMessage() {
return message;
}
}
同樣,我們可以運(yùn)行之前的測試,看看有沒有異常拋出,程序結(jié)果是否是我們所期望的那樣。綜上,一般采用第三種setter的方式和第二種@Lazy延遲加載的策略
5 實(shí)現(xiàn)原理
5.1. 過程演示
關(guān)于Spring bean的創(chuàng)建,其本質(zhì)上還是一個(gè)對象的創(chuàng)建,既然是對象,讀者朋友一定要明白一點(diǎn)就是,一個(gè)完整的對象包含兩部分:當(dāng)前對象實(shí)例化和對象屬性的實(shí)例化。在Spring中,對象的實(shí)例化是通過反射實(shí)現(xiàn)的,而對象的屬性則是在對象實(shí)例化之后通過一定的方式設(shè)置的。這個(gè)過程可以按照如下方式進(jìn)行理解:
然后我們看上面解決循環(huán)依賴注入的示例3
@Component
public class A {
private B b;
public void setB(B b) {
this.b = b;
}
public B getB() {
return b;
}
}
可以看到,這里A和B中各自都以對方為自己的全局屬性。這里首先需要說明的一點(diǎn)是,Spring實(shí)例化bean是通過ApplicationContext.getBean()方法來進(jìn)行的。如果要獲取的對象依賴了另一個(gè)對象,那么其首先會(huì)創(chuàng)建當(dāng)前對象,然后通過遞歸的調(diào)用ApplicationContext.getBean()方法來獲取所依賴的對象,最后將獲取到的對象注入到當(dāng)前對象中。這里我們以上面的首先初始化A對象實(shí)例為例進(jìn)行講解。
- 首先Spring嘗試通過ApplicationContext.getBean()方法獲取A對象的實(shí)例,由于Spring容器中還沒有A對象實(shí)例,因而其會(huì)創(chuàng)建一個(gè)A對象,然后發(fā)現(xiàn)其依賴了B對象,因而會(huì)嘗試遞歸的通過ApplicationContext.getBean()方法獲取B對象的實(shí)例。
- Spring容器中此時(shí)也沒有B對象的實(shí)例,因而其還是會(huì)先創(chuàng)建一個(gè)B對象的實(shí)例。需要注意這個(gè)時(shí)間點(diǎn),此時(shí)A對象和B對象都已經(jīng)創(chuàng)建了,并且保存在Spring容器中了,只不過A對象的屬性b和B對象的屬性a都還沒有設(shè)置進(jìn)去。
- 在Spring創(chuàng)建B對象之后,Spring發(fā)現(xiàn)B對象依賴了屬性A,因而此時(shí)還是會(huì)嘗試遞歸的調(diào)用ApplicationContext.getBean()方法獲取A對象的實(shí)例,因?yàn)镾pring中已經(jīng)有一個(gè)A對象的實(shí)例,雖然只是半成品(其屬性b還未初始化),但其也還是目標(biāo)bean,因而會(huì)將該A對象的實(shí)例返回。此時(shí),B對象的屬性a就設(shè)置進(jìn)去了。
- 然后還是ApplicationContext.getBean()方法遞歸的返回,也就是將B對象的實(shí)例返回,此時(shí)就會(huì)將該實(shí)例設(shè)置到A對象的屬性b中。
- 這個(gè)時(shí)候,注意A對象的屬性b和B對象的屬性a都已經(jīng)設(shè)置了目標(biāo)對象的實(shí)例了。讀者朋友可能會(huì)比較疑惑的是,前面在為對象B設(shè)置屬性a的時(shí)候,這個(gè)A類型屬性還是個(gè)半成品。但是需要注意的是,這個(gè)A是一個(gè)引用,其本質(zhì)上還是最開始就實(shí)例化的A對象。而在上面這個(gè)遞歸過程的最后,Spring將獲取到的B對象實(shí)例設(shè)置到了A對象的屬性b中了,這里的A對象其實(shí)和前面設(shè)置到實(shí)例B中的半成品A對象是同一個(gè)對象,其引用地址是同一個(gè),這里為A對象的b屬性設(shè)置了值,其實(shí)也就是為那個(gè)半成品的a屬性設(shè)置了值。下面我們通過一個(gè)流程圖來對這個(gè)過程進(jìn)行講解:
圖中g(shù)etBean()表示調(diào)用Spring的ApplicationContext.getBean()方法,而該方法中的參數(shù),則表示我們要嘗試獲取的目標(biāo)對象。圖中的黑色箭頭表示一開始的方法調(diào)用走向,走到最后,返回了Spring中緩存的A對象之后,表示遞歸調(diào)用返回了,此時(shí)使用綠色的箭頭表示。從圖中我們可以很清楚的看到,B對象的a屬性是在第三步中注入的半成品A對象,而A對象的b屬性是在第二步中注入的成品B對象,此時(shí)半成品的A對象也就變成了成品的A對象,因?yàn)槠鋵傩砸呀?jīng)設(shè)置完成了。
5.2 源碼解析
重點(diǎn)方法流程如下
對于Spring處理循環(huán)依賴問題的方式,我們這里通過上面的流程圖其實(shí)很容易就可以理解,需要注意的一個(gè)點(diǎn)就是,Spring是如何標(biāo)記開始生成的A對象是一個(gè)半成品,并且是如何保存A對象的。
- 標(biāo)記工作Spring是使用ApplicationContext的屬性Set<String> singletonsCurrentlyInCreation來保存的,
- 半成品的A對象則是通過Map<String, ObjectFactory<?>> singletonFactories來保存的,這里的ObjectFactory是一個(gè)工廠對象,可通過調(diào)用其getObject()方法來獲取目標(biāo)對象。
在AbstractBeanFactory.doGetBean()方法中獲取對象的方法如下:
protected <T> T doGetBean(final String name, @Nullable final Class<T> requiredType,
@Nullable final Object[] args, boolean typeCheckOnly) throws BeansException {
// 嘗試通過bean名稱獲取目標(biāo)bean對象,比如這里的A對象
Object sharedInstance = getSingleton(beanName);
// 我們這里的目標(biāo)對象都是單例的
if (mbd.isSingleton()) {
// 這里就嘗試創(chuàng)建目標(biāo)對象,第二個(gè)參數(shù)傳的就是一個(gè)ObjectFactory類型的對象,這里是使用Java8的lamada
// 表達(dá)式書寫的,只要上面的getSingleton()方法返回值為空,則會(huì)調(diào)用這里的getSingleton()方法來創(chuàng)建
// 目標(biāo)對象
sharedInstance = getSingleton(beanName, () -> {
try {
// 嘗試創(chuàng)建目標(biāo)對象
return createBean(beanName, mbd, args);
} catch (BeansException ex) {
throw ex;
}
});
}
return (T) bean;
}
這里的doGetBean()方法是非常關(guān)鍵的一個(gè)方法上面也主要有兩個(gè)步驟,
- 第一個(gè)步驟的getSingleton()方法的作用是嘗試從緩存中獲取目標(biāo)對象,如果沒有獲取到,則嘗試獲取半成品的目標(biāo)對象;如果第一個(gè)步驟沒有獲取到目標(biāo)對象的實(shí)例,那么就進(jìn)入第二個(gè)步驟,
- 第二個(gè)步驟的getSingleton()方法的作用是嘗試創(chuàng)建目標(biāo)對象,并且為該對象注入其所依賴的屬性。這里其實(shí)就是主干邏輯,我們前面圖中已經(jīng)標(biāo)明,在整個(gè)過程中會(huì)調(diào)用三次doGetBean方法。
- 第一次調(diào)用的時(shí)候會(huì)嘗試獲取A對象實(shí)例,此時(shí)走的是第一個(gè)getSingleton()方法,由于沒有已經(jīng)創(chuàng)建的A對象的成品或半成品,因而這里得到的是null,
- 然后就會(huì)調(diào)用第二個(gè)getSingleton()方法,創(chuàng)建A對象的實(shí)例,然后遞歸的調(diào)用doGetBean()方法,嘗試獲取B對象的實(shí)例以注入到A對象中,此時(shí)由于Spring容器中也沒有B對象的成品或半成品,因而還是會(huì)走到第二個(gè)getSingleton()方法,在該方法中創(chuàng)建B對象的實(shí)例,創(chuàng)建完成之后,嘗試獲取其所依賴的A的實(shí)例作為其屬性,因而還是會(huì)遞歸的調(diào)用doGetBean()方法。
- 此時(shí)需要注意的是,在前面由于已經(jīng)有了一個(gè)半成品的A對象的實(shí)例,因而這個(gè)時(shí)候,再嘗試獲取A對象的實(shí)例的時(shí)候,會(huì)走第一個(gè)getSingleton()方法,在該方法中會(huì)得到一個(gè)半成品的A對象的實(shí)例。然后將該實(shí)例返回,并且將其注入到B對象的屬性a中,此時(shí)B對象實(shí)例化完成。然后將實(shí)例化完成的B對象遞歸的返回,此時(shí)就會(huì)將該實(shí)例注入到A對象中,這樣就得到了一個(gè)成品的A對象。
第一個(gè)getSingleton()方法
@Nullable
protected Object getSingleton(String beanName, boolean allowEarlyReference) {
// 嘗試從緩存中獲取成品的目標(biāo)對象,如果存在,則直接返回
Object singletonObject = this.singletonObjects.get(beanName);
// 如果緩存中不存在目標(biāo)對象,則判斷當(dāng)前對象是否已經(jīng)處于創(chuàng)建過程中,
//在前面的講解中,第一次嘗試獲取A對象的實(shí)例之后,就會(huì)將A對象標(biāo)記為正在創(chuàng)建中,
//因而最后再嘗試獲取A對象的時(shí)候,這里的if判斷就會(huì)為true
if (singletonObject == null && isSingletonCurrentlyInCreation(beanName)) {
synchronized (this.singletonObjects) {
singletonObject = this.earlySingletonObjects.get(beanName);
if (singletonObject == null && allowEarlyReference) {
// 這里的singletonFactories是一個(gè)Map,其key是bean的名稱,
//而值是一個(gè)ObjectFactory類型的對象,
//這里對于A和B而言,調(diào)用圖其getObject()方法返回的就是A和B對象的實(shí)例,無論是否是半成品
ObjectFactory<?> singletonFactory = this.singletonFactories.get(beanName);
if (singletonFactory != null) {
// 獲取目標(biāo)對象的實(shí)例
singletonObject = singletonFactory.getObject();
this.earlySingletonObjects.put(beanName, singletonObject);
this.singletonFactories.remove(beanName);
}
}
}
}
return singletonObject;
}
這里我們會(huì)存在一個(gè)問題就是A的半成品實(shí)例是如何實(shí)例化的,然后是如何將其封裝為一個(gè)ObjectFactory類型的對象,并且將其放到上面的singletonFactories屬性中的。
這主要是在前面的第二個(gè)getSingleton()方法中,其最終會(huì)通過其傳入的第二個(gè)參數(shù),從而調(diào)用
createBean()方法,該方法的最終調(diào)用是委托給了另一個(gè)doCreateBean()方法進(jìn)行的,這里面有如下一段代碼:
protected Object doCreateBean(final String beanName, final RootBeanDefinition mbd, final @Nullable Object[] args)
throws BeanCreationException {
// 實(shí)例化當(dāng)前嘗試獲取的bean對象,比如A對象和B對象都是在這里實(shí)例化的
BeanWrapper instanceWrapper = null;
if (mbd.isSingleton()) {
instanceWrapper = this.factoryBeanInstanceCache.remove(beanName);
}
if (instanceWrapper == null) {
instanceWrapper = createBeanInstance(beanName, mbd, args);
}
// 判斷Spring是否配置了支持提前暴露目標(biāo)bean,也就是是否支持提前暴露半成品的bean
boolean earlySingletonExposure = (mbd.isSingleton() && this.allowCircularReferences
&& isSingletonCurrentlyInCreation(beanName));
if (earlySingletonExposure) {
// 如果支持,為了解決循環(huán)依賴,再bean初始化完成前將創(chuàng)建實(shí)例的objectFactory加入工廠
addSingletonFactory(beanName, () -> getEarlyBeanReference(beanName, mbd, bean));
}
try {
// 在初始化實(shí)例之后,這里就是判斷當(dāng)前bean是否依賴了其他的bean,如果依賴了,
// 就會(huì)遞歸的調(diào)用getBean()方法嘗試獲取目標(biāo)bean
populateBean(beanName, mbd, instanceWrapper);
} catch (Throwable ex) {
// 省略...
}
return exposedObject;
}
到這里,Spring整個(gè)解決循環(huán)依賴問題的實(shí)現(xiàn)思路已經(jīng)比較清楚了。對于整體過程,讀者朋友只要理解兩點(diǎn):
- Spring是通過遞歸的方式獲取目標(biāo)bean及其所依賴的bean的;
- Spring實(shí)例化一個(gè)bean的時(shí)候,是分兩步進(jìn)行的,首先實(shí)例化目標(biāo)bean,然后為其注入屬性。
- 結(jié)合這兩點(diǎn),也就是說,Spring在實(shí)例化一個(gè)bean的時(shí)候,是首先遞歸的實(shí)例化其所依賴的所有bean,直到某個(gè)bean沒有依賴其他bean,此時(shí)就會(huì)將該實(shí)例返回,然后反遞歸的將獲取到的bean設(shè)置為各個(gè)上層bean的屬性的。
5.3 三級(jí)緩存分析
對于單例來說,在Spring容器整個(gè)生命周期內(nèi),有且只有一個(gè)對象,所以很容易想到這個(gè)對象應(yīng)該存在Cache中,Spring為了解決單例的循環(huán)依賴問題,使用了三級(jí)緩存。
首先我們看源碼,三級(jí)緩存主要指:
/** Cache of singleton objects: bean name --> bean instance */
private final Map<String, Object> singletonObjects = new ConcurrentHashMap<String, Object>(256);
/** Cache of singleton factories: bean name --> ObjectFactory */
private final Map<String, ObjectFactory<?>> singletonFactories = new HashMap<String, ObjectFactory<?>>(16);
/** Cache of early singleton objects: bean name --> bean instance */
private final Map<String, Object> earlySingletonObjects = new HashMap<String, Object>(16);
這三級(jí)緩存分別指:
- 一級(jí)緩存:singletonObjects:存放完全實(shí)例化屬性賦值完成的Bean,直接可以使用。
- 二級(jí)緩存:earlySingletonObjects:存放早期Bean的引用,尚未屬性裝配的Bean。
- 三級(jí)緩存:singletonFactories:存放可以生成Bean的工廠,可以通過工廠獲取需要的bean。
我們在創(chuàng)建bean的時(shí)候,首先想到的是從cache中獲取這個(gè)單例的bean,這個(gè)緩存就是singletonObjects。主要調(diào)用方法就就是:getSingleton(String beanName, boolean allowEarlyReference)
分析getSingleton()的整個(gè)過程,Spring首先從一級(jí)緩存singletonObjects中獲取。如果獲取不到,并且對象正在創(chuàng)建中,就再從二級(jí)緩存earlySingletonObjects中獲取。如果還是獲取不到且允許singletonFactories通過getObject()獲取,就從三級(jí)緩存singletonFactory.getObject()(三級(jí)緩存)獲取,如果獲取到了則從singletonFactories中移除,并放入earlySingletonObjects中。其實(shí)也就是從三級(jí)緩存移動(dòng)到了二級(jí)緩存。
6 問題
1 為什么使用三級(jí)緩存
1 使用一級(jí)緩存
- 實(shí)例化A -> 將半成品的A放入singletonObjects中。
- 填充A的屬性時(shí)發(fā)現(xiàn)取不到B->實(shí)例化B。
- 從singletonObjects中取出A填充B的屬性。
- 將成品B放入singletonObjects->將B填充到A的屬性中。
- 將成品A放入singletonObjects。
問題:這種基本流程是通的,但是如果在整個(gè)流程進(jìn)行中,有另一個(gè)線程要來取A,那么有可能拿到的只是一個(gè)屬性都為null的半成品A,這樣就會(huì)有問題。
2 使用二級(jí)緩存
a)使用singletonObjects和earlySingletonObjects
成品放在singletonObjects中,半成品放在earlySingletonObjects中,流程如下:
- 實(shí)例化A ->將半成品的A放入earlySingletonObjects中。
- 填充A的屬性時(shí)發(fā)現(xiàn)取不到B->實(shí)例化B->將半成品的A放入earlySingletonObjects中
- 從earlySingletonObjects中取出A填充B的屬性->將成品B放入singletonObjects
- 并從earlySingletonObjects中刪除B->將B填充到A的屬性中。
- 將成品A放入singletonObjects并刪除earlySingletonObjects。
問題:這樣的流程是線程安全的,不過如果A上加個(gè)切面(AOP),這種做法就沒法滿足需求了,因?yàn)閑arlySingletonObjects中存放的都是原始對象,而我們需要注入的其實(shí)是A的代理對象。
b)使用singletonObjects和singletonFactories
成品放在singletonObjects中,半成品通過singletonFactories來獲取,流程如下:
- 實(shí)例化A ->創(chuàng)建A的對象工廠并放入singletonFactories中
- 填充A的屬性時(shí)發(fā)現(xiàn)取不到B->實(shí)例化B->創(chuàng)建B的對象工廠并放入singletonFactories中
- 從singletonFactories中獲取A的對象工廠并獲取A填充到B中->將成品B放入singletonObjects并從singletonFactories中刪除B的對象工廠
- 將B填充到A的屬性中->將成品A放入singletonObjects并刪除A的對象工廠。
問題:這樣的流程也適用于普通的IOC以及有并發(fā)的場景,但如果A上加個(gè)切面(AOP)的話,這種情況也無法滿足需求。因?yàn)椴豢赡苊看螆?zhí)行singleFactory.getObject()方法都給我產(chǎn)生一個(gè)新的代理對象,所以還要借助另外一個(gè)緩存來保存產(chǎn)生的代理對象。