目录
什么是循环依赖?
所谓循环依赖就是A依赖B的同时B又依赖A,二者互相依赖,形成环路。试想,SpringIOC在初始化容器的时候,先实例化BeanA,发现BeanA依赖于BeanB,于是先去实例化BeanB,发现BeanB又依赖于BeanA,这就造成了循环依赖,如果程序不处理这种情况,就会陷入死循环,无限执行下去,直到程序崩溃。
我们今天要解决的问题就是摸清spring在初始化容器的时候是怎么解决循环依赖这个问题的。这里将以annotation注解注入的方式分析SpringIOC初始化整个过程,然后对循环依赖进行分析。本文篇幅很长,耐心看完,相信还是有所收获的。
引入依赖:
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>4.3.11.RELEASE</version>
</dependency>
新建测试类:
@Component
public class AnnotationLeader {
@Autowired
private LeaderDepender leaderDepender;
public AnnotationLeader() {
System.out.println("Leader started........");
}
public void output() {
System.out.println("my id is :" + leaderDepender.getId());
}
}
@Component
public class LeaderDepender {
private String id ;
@Autowired
private AnnotationLeader annotationLeader;
public LeaderDepender() {
this.id = "123456";
System.out.println("Depender started........");
}
public String getId() {
return id;
}
}
public class AnnotationAppStartTest {
public static void main(String[] args) {
ApplicationContext context = new AnnotationConfigApplicationContext("com.cf.spring.code");
AnnotationLeader leader = context.getBean(AnnotationLeader.class);
leader.output();
}
}
Bean注册
开始之前看下springIOC容器类图,对类的关系有个大致了解,在阅读源码的过程中,不熟悉的类多点进去看一看,降低晕车的严重程度。
进入容器启动构造方法:new AnnotationConfigApplicationContext("com.cf.spring.code");
public AnnotationConfigApplicationContext(String... basePackages) {
// 注册bean扫描器和bean读取器
this();
// 这一步很关键,扫描包路径下所有的class文件,解析成BeanDefinition并注册BeanDefinition
scan(basePackages);
refresh();
}
public AnnotationConfigApplicationContext() {
this.reader = new AnnotatedBeanDefinitionReader(this);
this.scanner = new ClassPathBeanDefinitionScanner(this);
}
与此同时,子类执行构造方法之前会执行父类GenericApplicationContext的构造方法
public GenericApplicationContext() {
// 初始化bean工厂
this.beanFactory = new DefaultListableBeanFactory();
}
回过头来看scan(basePackages):
public void scan(String... basePackages) {
Assert.notEmpty(basePackages, "At least one base package must be specified");
this.scanner.scan(basePackages);
}
public int scan(String... basePackages) {
// 获取已注册bean的数量
int beanCountAtScanStart = this.registry.getBeanDefinitionCount();
// 重点,往下看
doScan(basePackages);
// Register annotation config processors, if necessary.
if (this.includeAnnotationConfig) {
AnnotationConfigUtils.registerAnnotationConfigProcessors(this.registry);
}
return (this.registry.getBeanDefinitionCount() - beanCountAtScanStart);
}
doScan在ClassPathBeanDefinitionScanner中
protected Set<BeanDefinitionHolder> doScan(String... basePackages) {
Assert.notEmpty(basePackages, "At least one base package must be specified");
// 定义容器存储要返回的beanDefinition包装类
Set<BeanDefinitionHolder> beanDefinitions = new LinkedHashSet<BeanDefinitionHolder>();
// 可能有多个包扫描路径,遍历要扫描的路径
for (String basePackage : basePackages) {
// 在这里得到了BeanDefinition,足以说明此方法的重要性,下面方法先忽略,先跟进去看看
Set<BeanDefinition> candidates = findCandidateComponents(basePackage);
for (BeanDefinition candidate : candidates) {
ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(candidate);
candidate.setScope(scopeMetadata.getScopeName());
String beanName = this.beanNameGenerator.generateBeanName(candidate, this.registry);
if (candidate instanceof AbstractBeanDefinition) {
postProcessBeanDefinition((AbstractBeanDefinition) candidate, beanName);
}
if (candidate instanceof AnnotatedBeanDefinition) {
AnnotationConfigUtils.processCommonDefinitionAnnotations((AnnotatedBeanDefinition) candidate);
}
if (checkCandidate(beanName, candidate)) {
BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(candidate, beanName);
definitionHolder =
AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry);
beanDefinitions.add(definitionHolder);
registerBeanDefinition(definitionHolder, this.registry);
}
}
}
return beanDefinitions;
}
public Set<BeanDefinition> findCandidateComponents(String basePackage) {
Set<BeanDefinition> candidates = new LinkedHashSet<BeanDefinition>();
try {
// 组装包扫描路径,将包名转换成路径(最终格式:classpath*:com/cf/spring/code/**/*.class)
String packageSearchPath = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX +
resolveBasePackage(basePackage) + '/' + this.resourcePattern;
// 根据扫描路径得到资源对象数组
Resource[] resources = this.resourcePatternResolver.getResources(packageSearchPath);
boolean traceEnabled = logger.isTraceEnabled();
boolean debugEnabled = logger.isDebugEnabled();
// 遍历资源对象数组,根据每个资源对象获取beanDefinition
for (Resource resource : resources) {
if (traceEnabled) {
logger.trace("Scanning " + resource);
}
if (resource.isReadable()) {
try {
// MetadataReader这个类里面包含了类的元数据和注解的元数据信息,可以点进去类里面看看
MetadataReader metadataReader = this.metadataReaderFactory.getMetadataReader(resource);
// 是否为候选组件,判断是否满足bean注入条件,如果有@Conditional注解,则跳过。判断是否有@Component、@Repository、@Service、@Controller标注
if (isCandidateComponent(metadataReader)) {
// 根据matadateReader构造BeanDefinition
ScannedGenericBeanDefinition sbd = new ScannedGenericBeanDefinition(metadataReader);
sbd.setResource(resource);
sbd.setSource(resource);
if (isCandidateComponent(sbd)) {
if (debugEnabled) {
logger.debug("Identified candidate component class: " + resource);
}
// 添加到BeanDefinition集合中,用于返回数据
candidates.add(sbd);
}
else {
if (debugEnabled) {
logger.debug("Ignored because not a concrete top-level class: " + resource);
}
}
}
else {
if (traceEnabled) {
logger.trace("Ignored because not matching any filter: " + resource);
}
}
}
catch (Throwable ex) {
throw new BeanDefinitionStoreException(
"Failed to read candidate component class: " + resource, ex);
}
}
else {
if (traceEnabled) {
logger.trace("Ignored because not readable: " + resource);
}
}
}
}
catch (IOException ex) {
throw new BeanDefinitionStoreException("I/O failure during classpath scanning", ex);
}
return candidates;
}
现在我们回到doScan这里
protected Set<BeanDefinitionHolder> doScan(String... basePackages) {
Assert.notEmpty(basePackages, "At least one base package must be specified");
// 定义容器存储要返回的beanDefinition包装类
Set<BeanDefinitionHolder> beanDefinitions = new LinkedHashSet<BeanDefinitionHolder>();
// 可能有多个包扫描路径,遍历要扫描的路径
for (String basePackage : basePackages) {
// 在这里得到了BeanDefinition,足以说明此方法的重要性,下面方法先忽略,先跟进去看看
Set<BeanDefinition> candidates = findCandidateComponents(basePackage);
for (BeanDefinition candidate : candidates) {
// 这两步为BeanDefinition绑定scope,不详细说
ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(candidate);
candidate.setScope(scopeMetadata.getScopeName());
// 查看注解的value是否指定bean的名称,在没有指定beanName的情况下,以类名首字母小写作为beanName
String beanName = this.beanNameGenerator.generateBeanName(candidate, this.registry);
// 下面两步判断处理Autowired、initMethod、destroyMethod、lazy、Dependency on...这些配置的
if (candidate instanceof AbstractBeanDefinition) {
postProcessBeanDefinition((AbstractBeanDefinition) candidate, beanName);
}
if (candidate instanceof AnnotatedBeanDefinition) {
AnnotationConfigUtils.processCommonDefinitionAnnotations((AnnotatedBeanDefinition) candidate);
}
// 再检查下这个bean是否需要被注册
if (checkCandidate(beanName, candidate)) {
// BeanDefinitionHolder里面就几个关键属性: beanDefinition、beanName、aliases(别名,即可以根据别名找到BeanDefinition)
BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(candidate, beanName);
definitionHolder =
AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry);
// 添加到集合
beanDefinitions.add(definitionHolder);
// 重点来了,注册bean
registerBeanDefinition(definitionHolder, this.registry);
}
}
}
return beanDefinitions;
}
重点跟进这个registerBeanDefinition方法
protected void registerBeanDefinition(BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry) {
// 继续跟进
BeanDefinitionReaderUtils.registerBeanDefinition(definitionHolder, registry);
}
public static void registerBeanDefinition(
BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
throws BeanDefinitionStoreException {
// Register bean definition under primary name.
String beanName = definitionHolder.getBeanName();
// 看这里,注册BeanDefinition
registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
// 如果有别名,为bean注册别名
String[] aliases = definitionHolder.getAliases();
if (aliases != null) {
for (String alias : aliases) {
registry.registerAlias(beanName, alias);
}
}
}
这里调用的registerBeanDefinition其实是DefaultListableBeanFactory的方法,这个类很关键,他为spring做了很多事情,话不多说,我们细看
public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
throws BeanDefinitionStoreException {
Assert.hasText(beanName, "Bean name must not be empty");
Assert.notNull(beanDefinition, "BeanDefinition must not be null");
if (beanDefinition instanceof AbstractBeanDefinition) {
try {
((AbstractBeanDefinition) beanDefinition).validate();
}
catch (BeanDefinitionValidationException ex) {
throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName,
"Validation of bean definition failed", ex);
}
}
// 定义容器中已存在的旧的Bean
BeanDefinition oldBeanDefinition;
// Bean注册后就是存放在beanDefinitionMap在,先从这里面取,看下是否已存在
oldBeanDefinition = this.beanDefinitionMap.get(beanName);
if (oldBeanDefinition != null) {
// 如果不允许覆盖
if (!isAllowBeanDefinitionOverriding()) {
throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName,
"Cannot register bean definition [" + beanDefinition + "] for bean '" + beanName +
"': There is already [" + oldBeanDefinition + "] bound.");
}
else if (oldBeanDefinition.getRole() < beanDefinition.getRole()) {
// e.g. was ROLE_APPLICATION, now overriding with ROLE_SUPPORT or ROLE_INFRASTRUCTURE
if (this.logger.isWarnEnabled()) {
this.logger.warn("Overriding user-defined bean definition for bean '" + beanName +
"' with a framework-generated bean definition: replacing [" +
oldBeanDefinition + "] with [" + beanDefinition + "]");
}
}
else if (!beanDefinition.equals(oldBeanDefinition)) {
if (this.logger.isInfoEnabled()) {
this.logger.info("Overriding bean definition for bean '" + beanName +
"' with a different definition: replacing [" + oldBeanDefinition +
"] with [" + beanDefinition + "]");
}
}
else {
if (this.logger.isDebugEnabled()) {
this.logger.debug("Overriding bean definition for bean '" + beanName +
"' with an equivalent definition: replacing [" + oldBeanDefinition +
"] with [" + beanDefinition + "]");
}
}
// 如果允许覆盖的话,最终就是要覆盖
this.beanDefinitionMap.put(beanName, beanDefinition);
}
else {
// 判断是否有别的bean开始初始化了;注意,这里的bean都还没有初始化,只是注册BeanDefinition
if (hasBeanCreationStarted()) {
// Cannot modify startup-time collection elements anymore (for stable iteration)
synchronized (this.beanDefinitionMap) {
this.beanDefinitionMap.put(beanName, beanDefinition);
List<String> updatedDefinitions = new ArrayList<String>(this.beanDefinitionNames.size() + 1);
updatedDefinitions.addAll(this.beanDefinitionNames);
updatedDefinitions.add(beanName);
this.beanDefinitionNames = updatedDefinitions;
if (this.manualSingletonNames.contains(beanName)) {
Set<String> updatedSingletons = new LinkedHashSet<String>(this.manualSingletonNames);
updatedSingletons.remove(beanName);
this.manualSingletonNames = updatedSingletons;
}
}
}
else {
// 正常流程应该是走到这个分支,将BeanDefinition放入这个map中存起来
this.beanDefinitionMap.put(beanName, beanDefinition);
// 这个ArrayList,所以spring会按照加载bean的顺序保存beanname
this.beanDefinitionNames.add(beanName);
// spring会在后面手动注册一些bean,如“environment”等
this.manualSingletonNames.remove(beanName);
}
this.frozenBeanDefinitionNames = null;
}
if (oldBeanDefinition != null || containsSingleton(beanName)) {
resetBeanDefinition(beanName);
}
}
Bean实例化
这一步已经到达了一个分水岭,BeanDefinition已经成功注册到容器中。这个时候我们回到AnnotationConfigApplicationContext的构造方法
public AnnotationConfigApplicationContext(String... basePackages) {
// 注册bean扫描器和bean读取器
this();
// 这一步很关键,扫描包路径下所有的class文件,解析成BeanDefinition并注册BeanDefinition
scan(basePackages);
// 就只有这个方法了,我们进去看看
refresh();
}
public void refresh() throws BeansException, IllegalStateException {
// 先来个锁,不然容器还没refresh,你又启动个容器,那不得炸了,要知道是可以启动多个容器的
synchronized (this.startupShutdownMonitor) {
// 记录下容器启动时间,标记为“已启动”
prepareRefresh();
// 这一步针对不同方式注入采取不同实现
// 如果是xml方式,是在这一步初始化beanfactory,解析xml配置文件得到bean定义,
// 扫描@component,@service,@repository,完成bean注册
// 如果为annotation方式,在执行refresh之前就已经完成了BeanFactory的初始化
// 和Bean容器注册,此时里面的逻辑是非常简单的,我们进去看看
ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
// 设置beanfactory的类加载器
prepareBeanFactory(beanFactory);
try {
// Bean如果实现了BeanFactoryPostProcessor,容器在初始化以后会调用postProcessBeanFactory方法,并且子类可以对这步进行扩展
postProcessBeanFactory(beanFactory);
// 调用BeanFactoryPostProcessor实现类的postProcessBeanFactory回调
invokeBeanFactoryPostProcessors(beanFactory);
// 注册BeanPostProcessor实现类
registerBeanPostProcessors(beanFactory);
// 初始化MessageSource,国际化
initMessageSource();
// 初始化事件广播器
initApplicationEventMulticaster();
// 模版方法,子类可以在这一步初始化一些bean
onRefresh();
// 注册监听器(实现ApplicationListener)
registerListeners();
// 实例化所有非懒加载的singleton benas
finishBeanFactoryInitialization(beanFactory);
// 初始化完成广播事件
finishRefresh();
}
catch (BeansException ex) {
if (logger.isWarnEnabled()) {
logger.warn("Exception encountered during context initialization - " +
"cancelling refresh attempt: " + ex);
}
// Destroy already created singletons to avoid dangling resources.
destroyBeans();
// Reset 'active' flag.
cancelRefresh(ex);
// Propagate exception to caller.
throw ex;
}
finally {
// Reset common introspection caches in Spring's core, since we
// might not ever need metadata for singleton beans anymore...
resetCommonCaches();
}
}
}
进入obtainFreshBeanFactory()
protected ConfigurableListableBeanFactory obtainFreshBeanFactory() {
// 跟进去看看
refreshBeanFactory();
ConfigurableListableBeanFactory beanFactory = getBeanFactory();
if (logger.isDebugEnabled()) {
logger.debug("Bean factory for " + getDisplayName() + ": " + beanFactory);
}
return beanFactory;
}
这里说一下,AnnotationConfigApplicationContext继承自GenericApplicationContext,而xml方式继承自AbstractRefreshableApplicationContext。所以这里我们找到GenericApplicationContext的refreshBeanFactory()
protected final void refreshBeanFactory() throws IllegalStateException {
if (!this.refreshed.compareAndSet(false, true)) {
throw new IllegalStateException(
"GenericApplicationContext does not support multiple refresh attempts: just call 'refresh' once");
}
this.beanFactory.setSerializationId(getId());
}
看看这里面多简单,里面啥也没干,set了个序列化id就返回了。当然如果是xml配置方式注入的话,这里面就复杂多了,这个看看以后有空补充吧。
回到refresh()中,考虑到篇幅问题,中间过程就不详细说了,我们直接跳到finishBeanFactoryInitialization(beanFactory)这个重头戏,这里负责初始化所有的singleton beans.
protected void finishBeanFactoryInitialization(ConfigurableListableBeanFactory beanFactory) {
// 初始化ConversionService的bean
if (beanFactory.containsBean(CONVERSION_SERVICE_BEAN_NAME) &&
beanFactory.isTypeMatch(CONVERSION_SERVICE_BEAN_NAME, ConversionService.class)) {
beanFactory.setConversionService(
beanFactory.getBean(CONVERSION_SERVICE_BEAN_NAME, ConversionService.class));
}
// Register a default embedded value resolver if no bean post-processor
// (such as a PropertyPlaceholderConfigurer bean) registered any before:
// at this point, primarily for resolution in annotation attribute values.
if (!beanFactory.hasEmbeddedValueResolver()) {
beanFactory.addEmbeddedValueResolver(new StringValueResolver() {
@Override
public String resolveStringValue(String strVal) {
return getEnvironment().resolvePlaceholders(strVal);
}
});
}
// 初始化 LoadTimeWeaverAware类型的beans 属于Aspectj的内容,直接过
String[] weaverAwareNames = beanFactory.getBeanNamesForType(LoadTimeWeaverAware.class, false, false);
for (String weaverAwareName : weaverAwareNames) {
getBean(weaverAwareName);
}
// Stop using the temporary ClassLoader for type matching.
beanFactory.setTempClassLoader(null);
// 这个时候不希望再出现bean的加载、注册、解析
beanFactory.freezeConfiguration();
// 重点,开始初始化,往下看
beanFactory.preInstantiateSingletons();
}
这里又回到了DefaultListableBeanFactory中
public void preInstantiateSingletons() throws BeansException {
if (this.logger.isDebugEnabled()) {
this.logger.debug("Pre-instantiating singletons in " + this);
}
// Iterate over a copy to allow for init methods which in turn register new bean definitions.
// 存储beanName
List<String> beanNames = new ArrayList<String>(this.beanDefinitionNames);
// 触发所有非懒加载的singleton beans初始化
for (String beanName : beanNames) {
//合并父bean中配置
RootBeanDefinition bd = getMergedLocalBeanDefinition(beanName);
//非抽象、非懒加载 的singletons
if (!bd.isAbstract() && bd.isSingleton() && !bd.isLazyInit()) {
// 处理Bean Factory
if (isFactoryBean(beanName)) {
final FactoryBean<?> factory = (FactoryBean<?>) getBean(FACTORY_BEAN_PREFIX + beanName);
// 判断Bean Factory是否为SmartFactoryBean的实现,跳过
boolean isEagerInit;
if (System.getSecurityManager() != null && factory instanceof SmartFactoryBean) {
isEagerInit = AccessController.doPrivileged(new PrivilegedAction<Boolean>() {
@Override
public Boolean run() {
return ((SmartFactoryBean<?>) factory).isEagerInit();
}
}, getAccessControlContext());
}
else {
isEagerInit = (factory instanceof SmartFactoryBean &&
((SmartFactoryBean<?>) factory).isEagerInit());
}
if (isEagerInit) {
// 初始化Bean
getBean(beanName);
}
}
else {
// 对于普通的Bean,正常流程是走到这个分支,调用getBean进行初始化,跟进去
getBean(beanName);
}
}
}
// SmartInitializingSingleton实现的回调,跳过
for (String beanName : beanNames) {
Object singletonInstance = getSingleton(beanName);
if (singletonInstance instanceof SmartInitializingSingleton) {
final SmartInitializingSingleton smartSingleton = (SmartInitializingSingleton) singletonInstance;
if (System.getSecurityManager() != null) {
AccessController.doPrivileged(new PrivilegedAction<Object>() {
@Override
public Object run() {
smartSingleton.afterSingletonsInstantiated();
return null;
}
}, getAccessControlContext());
}
else {
smartSingleton.afterSingletonsInstantiated();
}
}
}
}
跟进去看到doGetBean
// getBean这个方法我们经常用来获取Bean实例,如果已经初始化直接从容器中返回
public Object getBean(String name) throws BeansException {
// 继续往下
return doGetBean(name, null, null, false);
}
protected <T> T doGetBean(
final String name, final Class<T> requiredType, final Object[] args, boolean typeCheckOnly)
throws BeansException {
// 处理别名和FactoryBean,得到正确的BeanName
final String beanName = transformedBeanName(name);
// 这个就是返回的bean
Object bean;
// 检查下早期singleton缓存中是否已经存在这个bean,也就是这个bean是不是已经创建过了,如果不为空,返回这个bean实例
// 后面讲ioc循环依赖会用到
Object sharedInstance = getSingleton(beanName);
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直接返回sharedInstance,Factory Bean返回它创建的实例
bean = getObjectForBeanInstance(sharedInstance, name, beanName, null);
}
else {
// 如果此bean的scope为prototype,并且已经创建过了
// 抛出异常,这时多半是陷入了循环引用,而spring并不能处理prototype类型的循环引用
if (isPrototypeCurrentlyInCreation(beanName)) {
throw new BeanCurrentlyInCreationException(beanName);
}
// 检查 bean definition 在容器中是否存在
BeanFactory parentBeanFactory = getParentBeanFactory();
if (parentBeanFactory != null && !containsBeanDefinition(beanName)) {
// 没有的话,去父容器中找
String nameToLookup = originalBeanName(name);
if (args != null) {
// 返回父容器结果
return (T) parentBeanFactory.getBean(nameToLookup, args);
}
else {
// No args -> delegate to standard getBean method.
return parentBeanFactory.getBean(nameToLookup, requiredType);
}
}
if (!typeCheckOnly) {
markBeanAsCreated(beanName);
}
try {
final RootBeanDefinition mbd = getMergedLocalBeanDefinition(beanName);
checkMergedBeanDefinition(mbd, beanName, args);
// 初始化depends-on中定义的依赖
String[] dependsOn = mbd.getDependsOn();
if (dependsOn != null) {
for (String dep : dependsOn) {
if (isDependent(beanName, dep)) {
throw new BeanCreationException(mbd.getResourceDescription(), beanName,
"Circular depends-on relationship between '" + beanName + "' and '" + dep + "'");
}
// 注册依赖关系
registerDependentBean(dep, beanName);
getBean(dep);
}
}
// 如果scope为singleton,创建singleton的实例
if (mbd.isSingleton()) {
// spring处理循环依赖的一个步骤,后面讲
sharedInstance = getSingleton(beanName, new ObjectFactory<Object>() {
@Override
public Object getObject() throws BeansException {
try {
// 真正执行Bean实例化的方法,先别急后面重点说
return createBean(beanName, mbd, args);
}
catch (BeansException ex) {
// Explicitly remove instance from singleton cache: It might have been put there
// eagerly by the creation process, to allow for circular reference resolution.
// Also remove any beans that received a temporary reference to the bean.
destroySingleton(beanName);
throw ex;
}
}
});
bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd);
}
// 如果scope为prototype,创建prototype的实例
else if (mbd.isPrototype()) {
// It's a prototype -> create a new instance.
Object prototypeInstance = null;
try {
beforePrototypeCreation(beanName);
// 创建prototype实例
prototypeInstance = createBean(beanName, mbd, args);
}
finally {
afterPrototypeCreation(beanName);
}
bean = getObjectForBeanInstance(prototypeInstance, name, beanName, mbd);
}
// 如果非scope也非prototype,委托给他的实现类
else {
String scopeName = mbd.getScope();
final Scope scope = this.scopes.get(scopeName);
if (scope == null) {
throw new IllegalStateException("No Scope registered for scope name '" + scopeName + "'");
}
try {
Object scopedInstance = scope.get(beanName, new ObjectFactory<Object>() {
@Override
public Object getObject() throws BeansException {
beforePrototypeCreation(beanName);
try {
// 创建实例
return createBean(beanName, mbd, args);
}
finally {
afterPrototypeCreation(beanName);
}
}
});
bean = getObjectForBeanInstance(scopedInstance, name, beanName, mbd);
}
catch (IllegalStateException ex) {
throw new BeanCreationException(beanName,
"Scope '" + scopeName + "' is not active for the current thread; consider " +
"defining a scoped proxy for this bean if you intend to refer to it from a singleton",
ex);
}
}
}
catch (BeansException ex) {
cleanupAfterBeanCreationFailure(beanName);
throw ex;
}
}
// Check if required type matches the type of the actual bean instance.
if (requiredType != null && bean != null && !requiredType.isInstance(bean)) {
try {
return getTypeConverter().convertIfNecessary(bean, requiredType);
}
catch (TypeMismatchException ex) {
if (logger.isDebugEnabled()) {
logger.debug("Failed to convert bean '" + name + "' to required type '" +
ClassUtils.getQualifiedName(requiredType) + "'", ex);
}
throw new BeanNotOfRequiredTypeException(name, requiredType, bean.getClass());
}
}
return (T) bean;
}
没错,接下来我们就是要研究createBean方法了
protected abstract Object createBean(String beanName, RootBeanDefinition mbd, Object[] args)
throws BeanCreationException;
又是抽象方法,这个方法的实现在AbstractAutowireCapableBeanFactory中,这个类可以处理注解和xml两种方式混合使用的场景
protected Object createBean(String beanName, RootBeanDefinition mbd, Object[] args) throws BeanCreationException {
if (logger.isDebugEnabled()) {
logger.debug("Creating instance of bean '" + beanName + "'");
}
RootBeanDefinition mbdToUse = mbd;
// 确保bean中class确实被加载了
Class<?> resolvedClass = resolveBeanClass(mbd, beanName);
if (resolvedClass != null && !mbd.hasBeanClass() && mbd.getBeanClassName() != null) {
mbdToUse = new RootBeanDefinition(mbd);
mbdToUse.setBeanClass(resolvedClass);
}
// 准备方法复写,如果类中有定义lookup-method和replaced-method
try {
mbdToUse.prepareMethodOverrides();
}
catch (BeanDefinitionValidationException ex) {
throw new BeanDefinitionStoreException(mbdToUse.getResourceDescription(),
beanName, "Validation of method overrides failed", ex);
}
try {
// Give BeanPostProcessors a chance to return a proxy instead of the target bean instance.
// 让BeanPostProcessors有机会返回代理,跳过
Object bean = resolveBeforeInstantiation(beanName, mbdToUse);
if (bean != null) {
return bean;
}
}
catch (Throwable ex) {
throw new BeanCreationException(mbdToUse.getResourceDescription(), beanName,
"BeanPostProcessor before instantiation of bean failed", ex);
}
// 这里才是重点,创建bean实例的地方
Object beanInstance = doCreateBean(beanName, mbdToUse, args);
if (logger.isDebugEnabled()) {
logger.debug("Finished creating instance of bean '" + beanName + "'");
}
return beanInstance;
}
到这里为止,bean注册已经完成,但还没有完成初始化。在整个分析过程中,我们还没有谈及到任何有关IOC循环依赖的问题,那么接下来请注意,前方高能,请坐稳扶好。
进入到doCreateBean中
protected Object doCreateBean(final String beanName, final RootBeanDefinition mbd, final Object[] args)
throws BeanCreationException {
// Instantiate the bean.
BeanWrapper instanceWrapper = null;
if (mbd.isSingleton()) {
// 如果是factory Bean则从缓存中移除
instanceWrapper = this.factoryBeanInstanceCache.remove(beanName);
}
if (instanceWrapper == null) {
// 如果不是factory Bean, 实例化bean,这里很关键,重点分析
instanceWrapper = createBeanInstance(beanName, mbd, args);
}
// 获取bean实例
final Object bean = (instanceWrapper != null ? instanceWrapper.getWrappedInstance() : null);
// 类型
Class<?> beanType = (instanceWrapper != null ? instanceWrapper.getWrappedClass() : null);
mbd.resolvedTargetType = beanType;
// 这里建议还是跳过吧
// Allow post-processors to modify the merged bean definition.
synchronized (mbd.postProcessingLock) {
if (!mbd.postProcessed) {
try {
applyMergedBeanDefinitionPostProcessors(mbd, beanType, beanName);
}
catch (Throwable ex) {
throw new BeanCreationException(mbd.getResourceDescription(), beanName,
"Post-processing of merged bean definition failed", ex);
}
mbd.postProcessed = true;
}
}
// 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.isDebugEnabled()) {
logger.debug("Eagerly caching bean '" + beanName +
"' to allow for resolving potential circular references");
}
// 将bean实例添加到singletonFactories缓存,并从earlySingletonObjects中移除
// 暴露早期的对象引用(这个时候bean实例还没有初始化完全)
addSingletonFactory(beanName, new ObjectFactory<Object>() {
@Override
public Object getObject() throws BeansException {
return getEarlyBeanReference(beanName, mbd, bean);
}
});
}
// Initialize the bean instance.
Object exposedObject = bean;
try {
// 这一步非常关键,负责装配属性,给属性设值
// 也就是在这之前,bean只是完成实例化,但属性还没有赋值
// spring 解决循环依赖最巧妙的地方就是把bean初始化的过程分成了两步
// bean实例化和属性赋值
populateBean(beanName, mbd, instanceWrapper);
if (exposedObject != null) {
// 处理bean初始化完成后的各种回调
exposedObject = initializeBean(beanName, exposedObject, mbd);
}
}
catch (Throwable ex) {
if (ex instanceof BeanCreationException && beanName.equals(((BeanCreationException) ex).getBeanName())) {
throw (BeanCreationException) ex;
}
else {
throw new BeanCreationException(
mbd.getResourceDescription(), beanName, "Initialization of bean failed", ex);
}
}
if (earlySingletonExposure) {
Object earlySingletonReference = getSingleton(beanName, false);
if (earlySingletonReference != null) {
if (exposedObject == bean) {
exposedObject = earlySingletonReference;
}
else if (!this.allowRawInjectionDespiteWrapping && hasDependentBean(beanName)) {
String[] dependentBeans = getDependentBeans(beanName);
Set<String> actualDependentBeans = new LinkedHashSet<String>(dependentBeans.length);
for (String dependentBean : dependentBeans) {
if (!removeSingletonIfCreatedForTypeCheckOnly(dependentBean)) {
actualDependentBeans.add(dependentBean);
}
}
if (!actualDependentBeans.isEmpty()) {
throw new BeanCurrentlyInCreationException(beanName,
"Bean with name '" + beanName + "' has been injected into other beans [" +
StringUtils.collectionToCommaDelimitedString(actualDependentBeans) +
"] in its raw version as part of a circular reference, but has eventually been " +
"wrapped. This means that said other beans do not use the final version of the " +
"bean. This is often the result of over-eager type matching - consider using " +
"'getBeanNamesOfType' with the 'allowEagerInit' flag turned off, for example.");
}
}
}
}
// Register bean as disposable.
try {
registerDisposableBeanIfNecessary(beanName, bean, mbd);
}
catch (BeanDefinitionValidationException ex) {
throw new BeanCreationException(
mbd.getResourceDescription(), beanName, "Invalid destruction signature", ex);
}
return exposedObject;
}
这里有几个比较重要的方法:createBeanInstance(创建bean实例)、addSingletonFactory(暴露早期对象引用)、populateBean(依赖注入),里面一些代码也是比较复杂的,这里我们挑重点部分分析就好。
首先来看一下创建实例:createBeanInstance
protected BeanWrapper createBeanInstance(String beanName, RootBeanDefinition mbd, Object[] args) {
// 确保这个时候class已经完成加载
Class<?> beanClass = resolveBeanClass(mbd, beanName);
// 检查一下类的访问权限
if (beanClass != null && !Modifier.isPublic(beanClass.getModifiers()) && !mbd.isNonPublicAccessAllowed()) {
throw new BeanCreationException(mbd.getResourceDescription(), beanName,
"Bean class isn't public, and non-public access not allowed: " + beanClass.getName());
}
if (mbd.getFactoryMethodName() != null) {
// 采用工厂方法实例化
return instantiateUsingFactoryMethod(beanName, mbd, args);
}
// Shortcut when re-creating the same bean...
// 是否第一次创建,主要用于scope为prototype的情况下,
// 在第二次创建的时候,可以从第一次实例化知道实例化的方式:构造函数依赖注入 || 无参构造函数
boolean resolved = false;
boolean autowireNecessary = false;
if (args == null) {
synchronized (mbd.constructorArgumentLock) {
if (mbd.resolvedConstructorOrFactoryMethod != null) {
resolved = true;
autowireNecessary = mbd.constructorArgumentsResolved;
}
}
}
if (resolved) {
if (autowireNecessary) {
// 构造函数依赖注入
return autowireConstructor(beanName, mbd, null, null);
}
else {
// 调用无参构造函数实例化
return instantiateBean(beanName, mbd);
}
}
// 需要判断是否采用有参构造函数
Constructor<?>[] ctors = determineConstructorsFromBeanPostProcessors(beanClass, beanName);
if (ctors != null ||
mbd.getResolvedAutowireMode() == RootBeanDefinition.AUTOWIRE_CONSTRUCTOR ||
mbd.hasConstructorArgumentValues() || !ObjectUtils.isEmpty(args)) {
// 构造函数依赖注入
return autowireConstructor(beanName, mbd, ctors, args);
}
// 正常情况下,是走到这里,调用无参构造函数实例化
return instantiateBean(beanName, mbd);
}
来看下这个无参构造函数实例化:
protected BeanWrapper instantiateBean(final String beanName, final RootBeanDefinition mbd) {
try {
Object beanInstance;
final BeanFactory parent = this;
if (System.getSecurityManager() != null) {
beanInstance = AccessController.doPrivileged(new PrivilegedAction<Object>() {
@Override
public Object run() {
return getInstantiationStrategy().instantiate(mbd, beanName, parent);
}
}, getAccessControlContext());
}
else {
// 直接看这里,具体实例化的实现,走
beanInstance = getInstantiationStrategy().instantiate(mbd, beanName, parent);
}
// 包装一层,返回这个
BeanWrapper bw = new BeanWrapperImpl(beanInstance);
initBeanWrapper(bw);
return bw;
}
catch (Throwable ex) {
throw new BeanCreationException(
mbd.getResourceDescription(), beanName, "Instantiation of bean failed", ex);
}
}
我们直接进入到instantiate里面,这个方法在SimpleInstantiationStrategy这个类中:
public Object instantiate(RootBeanDefinition bd, String beanName, BeanFactory owner) {
// 如果这个类不存在方法覆写,使用java反射实例化,否则使用CGLIB
if (bd.getMethodOverrides().isEmpty()) {
Constructor<?> constructorToUse;
synchronized (bd.constructorArgumentLock) {
constructorToUse = (Constructor<?>) bd.resolvedConstructorOrFactoryMethod;
if (constructorToUse == null) {
final Class<?> clazz = bd.getBeanClass();
if (clazz.isInterface()) {
throw new BeanInstantiationException(clazz, "Specified class is an interface");
}
try {
if (System.getSecurityManager() != null) {
constructorToUse = AccessController.doPrivileged(new PrivilegedExceptionAction<Constructor<?>>() {
@Override
public Constructor<?> run() throws Exception {
return clazz.getDeclaredConstructor((Class[]) null);
}
});
}
else {
constructorToUse = clazz.getDeclaredConstructor((Class[]) null);
}
bd.resolvedConstructorOrFactoryMethod = constructorToUse;
}
catch (Throwable ex) {
throw new BeanInstantiationException(clazz, "No default constructor found", ex);
}
}
}
// 直接看这里,使用构造方法实例化
return BeanUtils.instantiateClass(constructorToUse);
}
else {
// 存在方法覆写,必需使用CGLIB实现实例化,因为jdk没有提供override相应实例化支持
return instantiateWithMethodInjection(bd, beanName, owner);
}
}
去这个实例化的工具类里面看下instantiateClass方法
public static <T> T instantiateClass(Constructor<T> ctor, Object... args) throws BeanInstantiationException {
Assert.notNull(ctor, "Constructor must not be null");
try {
ReflectionUtils.makeAccessible(ctor);
// 就是这里了,最终实例化的操作,调用构造器的newInstance实例化
return ctor.newInstance(args);
}
catch (InstantiationException ex) {
throw new BeanInstantiationException(ctor, "Is it an abstract class?", ex);
}
catch (IllegalAccessException ex) {
throw new BeanInstantiationException(ctor, "Is the constructor accessible?", ex);
}
catch (IllegalArgumentException ex) {
throw new BeanInstantiationException(ctor, "Illegal arguments for constructor", ex);
}
catch (InvocationTargetException ex) {
throw new BeanInstantiationException(ctor, "Constructor threw exception", ex.getTargetException());
}
}
到这里,bean实例化总算是完成了,我们看下暴露早期对象引用的过程
暴露早期对象引用(addSingletonFactory):
addSingletonFactory(beanName, new ObjectFactory<Object>() {
@Override
public Object getObject() throws BeansException {
// 这里返回的就是早期bean的引用
return getEarlyBeanReference(beanName, mbd, bean);
}
});
// 看看这里做了些什么
protected void addSingletonFactory(String beanName, ObjectFactory<?> singletonFactory) {
Assert.notNull(singletonFactory, "Singleton factory must not be null");
// singletonObjects:存放实例化完全的bean实例
// 锁起来,这个时候你肯定不能往singletonObjects里塞东西了
synchronized (this.singletonObjects) {
if (!this.singletonObjects.containsKey(beanName)) {
// singletonFactories:singleton bean工厂缓存
// 把获取bean实例的ObjectFactory放进这个缓存
this.singletonFactories.put(beanName, singletonFactory);
// earlySingletonObjects:存放早期singleton beans 实例
// 把bean从这个缓存中移除
this.earlySingletonObjects.remove(beanName);
this.registeredSingletons.add(beanName);
}
}
}
在这里面我们看到了spring ioc的三级缓存
/** 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);
-
singletonObjects(一级缓存):存放实例化完全的singleton bean实例
-
earlySingletonObjects(二级缓存):存放提前曝光的实例对象(尚未填充属性)
-
singletonFactories(三级缓存):存放singleton bean工厂对象
到这一步,已经得到了属性未赋值的bean实例,并且将bean实例对象工厂放入三级缓存singletonFactories中。我们接着看populateBean
属性注入(populateBean):
protected void populateBean(String beanName, RootBeanDefinition mbd, BeanWrapper bw) {
// bean实例所有属性
PropertyValues pvs = mbd.getPropertyValues();
if (bw == null) {
if (!pvs.isEmpty()) {
throw new BeanCreationException(
mbd.getResourceDescription(), beanName, "Cannot apply property values to null instance");
}
else {
// Skip property population phase for null instance.
return;
}
}
// InstantiationAwareBeanPostProcessors子类可以在这步修改bean状态,先跳过
boolean continueWithPropertyPopulation = true;
if (!mbd.isSynthetic() && hasInstantiationAwareBeanPostProcessors()) {
for (BeanPostProcessor bp : getBeanPostProcessors()) {
if (bp instanceof InstantiationAwareBeanPostProcessor) {
InstantiationAwareBeanPostProcessor ibp = (InstantiationAwareBeanPostProcessor) bp;
if (!ibp.postProcessAfterInstantiation(bw.getWrappedInstance(), beanName)) {
continueWithPropertyPopulation = false;
break;
}
}
}
}
if (!continueWithPropertyPopulation) {
return;
}
if (mbd.getResolvedAutowireMode() == RootBeanDefinition.AUTOWIRE_BY_NAME ||
mbd.getResolvedAutowireMode() == RootBeanDefinition.AUTOWIRE_BY_TYPE) {
MutablePropertyValues newPvs = new MutablePropertyValues(pvs);
// Add property values based on autowire by name if applicable.
if (mbd.getResolvedAutowireMode() == RootBeanDefinition.AUTOWIRE_BY_NAME) {
// 通过名字装配,如果是bean依赖,初始化依赖的bean并且记录依赖关系
autowireByName(beanName, mbd, bw, newPvs);
}
// Add property values based on autowire by type if applicable.
if (mbd.getResolvedAutowireMode() == RootBeanDefinition.AUTOWIRE_BY_TYPE) {
// 通过类型装配
autowireByType(beanName, mbd, bw, newPvs);
}
pvs = newPvs;
}
boolean hasInstAwareBpps = hasInstantiationAwareBeanPostProcessors();
boolean needsDepCheck = (mbd.getDependencyCheck() != RootBeanDefinition.DEPENDENCY_CHECK_NONE);
if (hasInstAwareBpps || needsDepCheck) {
PropertyDescriptor[] filteredPds = filterPropertyDescriptorsForDependencyCheck(bw, mbd.allowCaching);
if (hasInstAwareBpps) {
for (BeanPostProcessor bp : getBeanPostProcessors()) {
if (bp instanceof InstantiationAwareBeanPostProcessor) {
InstantiationAwareBeanPostProcessor ibp = (InstantiationAwareBeanPostProcessor) bp;
// 这里有个非常有用的BeanPostProcessor:AutowiredAnnotationBeanPostProcessor
// 对使用@Autowired、@Value注解的依赖进行注入
pvs = ibp.postProcessPropertyValues(pvs, filteredPds, bw.getWrappedInstance(), beanName);
if (pvs == null) {
return;
}
}
}
}
if (needsDepCheck) {
checkDependencies(beanName, mbd, filteredPds, pvs);
}
}
// 最后设置bean属性值
applyPropertyValues(beanName, mbd, bw, pvs);
}
至此,属性赋值完毕,bean初始化已经完成。现在我们分析一下循环依赖的过程,回到刚开始创建bean实例的doGetBean方法中。
//AbstractBeanFactory:235行
protected <T> T doGetBean(
......
// 检查下早期singleton缓存中是否已经存在这个bean,也就是这个bean是不是已经创建过了,如果不为空,返回这个bean实例
// 后面讲ioc循环依赖会用到
Object sharedInstance = getSingleton(beanName);
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直接返回sharedInstance,Factory Bean返回它创建的实例
bean = getObjectForBeanInstance(sharedInstance, name, beanName, null);
}
......
// 如果scope为singleton,创建singleton的实例
if (mbd.isSingleton()) {
// spring处理循环依赖的一个步骤,后面讲
sharedInstance = getSingleton(beanName, new ObjectFactory<Object>() {
@Override
public Object getObject() throws BeansException {
try {
// 真正执行Bean实例化的方法,先别急后面重点说
return createBean(beanName, mbd, args);
}
catch (BeansException ex) {
// Explicitly remove instance from singleton cache: It might have been put there
// eagerly by the creation process, to allow for circular reference resolution.
// Also remove any beans that received a temporary reference to the bean.
destroySingleton(beanName);
throw ex;
}
}
});
bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd);
}
......
}
这里有两个getSingleton,一个是 getSingleton(beanName),一个是getSingleton(beanName, new ObjectFactory<Object>()),先看第一个getSingleton(beanName)
public Object getSingleton(String beanName) {
return getSingleton(beanName, true);
}
protected Object getSingleton(String beanName, boolean allowEarlyReference) {
// 先到一级缓存中获取初始化完全的bean实例
Object singletonObject = this.singletonObjects.get(beanName);
// 一级缓存中没有
if (singletonObject == null && isSingletonCurrentlyInCreation(beanName)) {
synchronized (this.singletonObjects) {
// 到二级缓存中获取未初始化完全的bean实例(属性未赋值)
singletonObject = this.earlySingletonObjects.get(beanName);
// 二级缓存中也没有
if (singletonObject == null && allowEarlyReference) {
// 那就只能到三级缓存中获取bean实例工厂对象了
ObjectFactory<?> singletonFactory = this.singletonFactories.get(beanName);
if (singletonFactory != null) {
// 从bean工厂中获取bean实例
singletonObject = singletonFactory.getObject();
// 把bean实例放入二级缓存中
this.earlySingletonObjects.put(beanName, singletonObject);
// 二级缓存中有了,singletonFactories中就没必要存在了,所以移除掉
this.singletonFactories.remove(beanName);
}
}
}
}
return (singletonObject != NULL_OBJECT ? singletonObject : null);
}
如果第一步getSingleton拿不到bean实例说明该对象还没有实例化,就需要创建bean实例,这个时候就调用了getSingleton(beanName, new ObjectFactory<Object>())
sharedInstance = getSingleton(beanName, new ObjectFactory<Object>() {
@Override
public Object getObject() throws BeansException {
try {
return createBean(beanName, mbd, args);
}
......
}
});
public Object getSingleton(String beanName, ObjectFactory<?> singletonFactory) {
Assert.notNull(beanName, "'beanName' must not be null");
// 这里要singletonObjects进行操作,先锁起来
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<Exception>();
}
try {
// 主要就是这一步,调用singletonFactory.getObject获取bean实例
// 本质上就是调用外层的createBean方法创建bean实例
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) {
// 解决循环依赖的步骤,就是在这一步把初始化完整(属性已赋值)的bean实例添加到一级缓存中,我们跟进去看看这个方法
addSingleton(beanName, singletonObject);
}
}
return (singletonObject != NULL_OBJECT ? singletonObject : null);
}
}
在这一步里,得到了实例化完整的bean实例,并调用addSingleton把bean实例put到singletonObjects中,来看看addSingleton
protected void addSingleton(String beanName, Object singletonObject) {
synchronized (this.singletonObjects) {
// 将bean实例放入到一级缓存中
this.singletonObjects.put(beanName, (singletonObject != null ? singletonObject : NULL_OBJECT));
// 将bean实例工厂对象从三级缓存中移除
this.singletonFactories.remove(beanName);
// 将ben实例从二级缓存中移除
this.earlySingletonObjects.remove(beanName);
this.registeredSingletons.add(beanName);
}
}
springIOC循环依赖总结
springIOC解决循环依赖的核心在于两点:
- 把bean实例初始化分成两个部分:创建bean实例和属性赋值;这个是必要前提。
- 三级缓存:singletonObjects、earlySingletonObjects、singletonFactories
假设有A、B两个对象循环依赖,先实例化A对象。
- 1.执行new AnnotationConfigApplicationContext()构造方法,扫描包路径,调用DefaultListableBeanFactory.registerBeanDefinition完成bean注册
- 2.调用AnnotationConfigApplicationContext.refresh(),调用getBean,getBean是个空壳,真正获取实例的方法是doGetBean,调用doGetBean获取beanA实例
- 3.在doGetBean中执行Object sharedInstance = getSingleton(beanName),此时缓存中是没有beanA实例的,于是调用创建bean实例的方法sharedInstance = getSingleton(beanName, new ObjectFactory<Object>())。
// doGetBean
protected <T> T doGetBean(
......
// 检查下早期singleton缓存中是否已经存在这个bean,也就是这个bean是不是已经创建过了,如果不为空,返回这个bean实例
// 后面讲ioc循环依赖会用到
Object sharedInstance = getSingleton(beanName);
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直接返回sharedInstance,Factory Bean返回它创建的实例
bean = getObjectForBeanInstance(sharedInstance, name, beanName, null);
}
......
// 如果scope为singleton,创建singleton的实例
if (mbd.isSingleton()) {
sharedInstance = getSingleton(beanName, new ObjectFactory<Object>() {
@Override
public Object getObject() throws BeansException {
try {
// 真正执行Bean实例化的方法,先别急后面重点说
return createBean(beanName, mbd, args);
}
catch (BeansException ex) {
// Explicitly remove instance from singleton cache: It might have been put there
// eagerly by the creation process, to allow for circular reference resolution.
// Also remove any beans that received a temporary reference to the bean.
destroySingleton(beanName);
throw ex;
}
}
});
bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd);
}
......
}
- 4.调用createBean,在doCreateBean中获取beanA实例(属性未赋值),在instanceWrapper = createBeanInstance(beanName, mbd, args)这一步就得到了beanA实例
// doCreateBean
if (instanceWrapper == null) {
instanceWrapper = createBeanInstance(beanName, mbd, args);// 获取bean实例
}
- 5.暴露beanA早期对象引用,在这一步把属性未赋值的beanA实例工厂对象,放入了springIOC的三级缓存singletonFactories中
// doCreateBean
addSingletonFactory(beanName, new ObjectFactory<Object>() {
@Override
public Object getObject() throws BeansException {
return getEarlyBeanReference(beanName, mbd, bean);
}
});
- 6.给beanA属性赋值,即执行populateBean(beanName, mbd, instanceWrapper);
// doCreateBean
try {
populateBean(beanName, mbd, instanceWrapper);// 属性注入
if (exposedObject != null) {
exposedObject = initializeBean(beanName, exposedObject, mbd);
}
}
- 7.beanA属性赋值的过程中,发现beanA依赖beanB,要先初始化beanB,于是调用BeanFactory.getBean.getBean,getBean会调用doGetBean,再执行getSingleton(beanName),发现一、二、三级缓存中都没有beanB实例,执行createBean方法,调用doCreateBean
// doGetBean
protected <T> T doGetBean(
......
// 检查下早期singleton缓存中是否已经存在这个bean,也就是这个bean是不是已经创建过了,如果不为空,返回这个bean实例
// 后面讲ioc循环依赖会用到
Object sharedInstance = getSingleton(beanName);
......
// 如果scope为singleton,创建singleton的实例
if (mbd.isSingleton()) {
sharedInstance = getSingleton(beanName, new ObjectFactory<Object>() {
@Override
public Object getObject() throws BeansException {
try {
// 真正执行Bean实例化的方法,先别急后面重点说
return createBean(beanName, mbd, args);
}
......
}
}
});
bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd);
}
......
}
- 8.获取beanB实例(属性未赋值),调用addSingletonFactory暴露beanB早期对象引用,把属性未赋值的beanB实例工厂对象,放入了springIOC的三级缓存singletonFactories中,此时singletonFactories中已经缓存了beanA和beanB的工厂对象
// doCreateBean
protected Object doCreateBean(final String beanName, final RootBeanDefinition mbd, final Object[] args)
throws BeanCreationException {
......
if (instanceWrapper == null) {
// 如果不是factory Bean, 实例化bean,这里很关键,重点分析
instanceWrapper = createBeanInstance(beanName, mbd, args);
}
// 获取bean实例
final Object bean = (instanceWrapper != null ? instanceWrapper.getWrappedInstance() : null);
......
// 解决循环依赖的重点,待会儿细说
boolean earlySingletonExposure = (mbd.isSingleton() && this.allowCircularReferences &&
isSingletonCurrentlyInCreation(beanName));
if (earlySingletonExposure) {
......
// 将bean实例添加到singletonFactories缓存,并从earlySingletonObjects中移除
// 暴露早期的对象引用(这个时候bean实例还没有初始化完全)
addSingletonFactory(beanName, new ObjectFactory<Object>() {
@Override
public Object getObject() throws BeansException {
return getEarlyBeanReference(beanName, mbd, bean);
}
});
}
......
}
- 9.给beanB进行属性赋值,发现beanB依赖beanA,执行populateBean进行属性赋值,里面最终会BeanFactory.getBean去获取beanA实例
// doCreateBean
protected Object doCreateBean(final String beanName, final RootBeanDefinition mbd, final Object[] args)
throws BeanCreationException {
......
Object exposedObject = bean;
try {
// 这一步非常关键,负责装配属性,给属性设值
// 也就是在这之前,bean只是完成实例化,但属性还没有赋值
// spring 解决循环依赖最巧妙的地方就是把bean初始化的过程分成了两步
// bean实例化和属性赋值
populateBean(beanName, mbd, instanceWrapper);
if (exposedObject != null) {
// 处理bean初始化完成后的各种回调
exposedObject = initializeBean(beanName, exposedObject, mbd);
}
}
......
}
- 10.getBean会调用doGetBean,执行getSingleton。
- 尝试从一级缓存singletonObjects中获取初始化完全的beanA实例,发现没有。
- 再从二级缓存earlySingletonObjects中获取属性未赋值的beanA实例,也没有。
- 最终在三级缓存singletonFactories拿到了beanA实例(属性未赋值),将beanA实例放入二级缓存earlySingletonObjects中
- 这个时候beanB注入beanA属性成功,beanB初始化完成。
// doGetBean
protected <T> T doGetBean(
......
// 检查下早期singleton缓存中是否已经存在这个bean,也就是这个bean是不是已经创建过了,如果不为空,返回这个bean实例
// 后面讲ioc循环依赖会用到
Object sharedInstance = getSingleton(beanName);
if (sharedInstance != null && args == null) {
......
}
// 普通bean直接返回sharedInstance,Factory Bean返回它创建的实例
bean = getObjectForBeanInstance(sharedInstance, name, beanName, null);
}
......
}
- 11.到上一步为止,已经通过createBean方法完成了beanB的初始化,现在回到实例化beanB时调用的getSingleton(beanName, new ObjectFactory<Object>() )。在beanB的实例化完成后,会执行addSingleton把beanB实例放入一级缓存singletonObjects中,并从二级和三级缓存中移除。
// doGetBean
protected <T> T doGetBean(
......
// 如果scope为singleton,创建singleton的实例
if (mbd.isSingleton()) {
sharedInstance = getSingleton(beanName, new ObjectFactory<Object>() {
@Override
public Object getObject() throws BeansException {
try {
// 真正执行Bean实例化的方法,先别急后面重点说
return createBean(beanName, mbd, args);
}
.......
}
});
bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd);
}
......
}
public Object getSingleton(String beanName, ObjectFactory<?> singletonFactory) {
......
try {
// 主要就是这一步,调用singletonFactory.getObject获取bean实例
// 本质上就是调用外层的createBean方法创建bean实例
singletonObject = singletonFactory.getObject();
newSingleton = true;
}
......
if (newSingleton) {
// 解决循环依赖的步骤,就是在这一步把初始化完整(属性已赋值)的bean实例添加到一级缓存中,我们跟进去看看这个方法
addSingleton(beanName, singletonObject);
}
}
return (singletonObject != NULL_OBJECT ? singletonObject : null);
}
}
- 12.同样的,此时beanB初始化已完成。beanA也拿到了beanB实例,属性依赖注入成功,beanA初始化完成,同样会执行addSingleton把beanA实例放入一级缓存singletonObjects中。至此beanA和beanB都已实例化完全。
验证
还有最后一个疑问,在分析springIOC解决循环依赖的过程中,我们说在执行属性注入方法populateBean的时候会调BeanFactory.getBean获取依赖的bean属性。那么真的是这样么?我们来验证一下:
本文例子中是使用@Autowired进行属性注入,前面我们说过AutowiredAnnotationBeanPostProcessor,它是专门用来给使用@Autowired、@Value注解的依赖进行注入
// populateBean
protected void populateBean(String beanName, RootBeanDefinition mbd, BeanWrapper bw) {
......
if (hasInstAwareBpps || needsDepCheck) {
PropertyDescriptor[] filteredPds = filterPropertyDescriptorsForDependencyCheck(bw, mbd.allowCaching);
if (hasInstAwareBpps) {
for (BeanPostProcessor bp : getBeanPostProcessors()) {
if (bp instanceof InstantiationAwareBeanPostProcessor) {
InstantiationAwareBeanPostProcessor ibp = (InstantiationAwareBeanPostProcessor) bp;
// 这里有个非常有用的BeanPostProcessor:AutowiredAnnotationBeanPostProcessor
// 对使用@Autowired、@Value注解的依赖进行注入
pvs = ibp.postProcessPropertyValues(pvs, filteredPds, bw.getWrappedInstance(), beanName);
if (pvs == null) {
return;
}
}
}
}
......
}
我们可以在populateBean方法的InstantiationAwareBeanPostProcessor ibp = (InstantiationAwareBeanPostProcessor) bp
这一行打个断点,加上过滤条件,根进下面这一行,一个个点进去看看
pvs = ibp.postProcessPropertyValues(pvs, filteredPds, bw.getWrappedInstance(), beanName);
一路跟踪下去,会先调用beanFactory.resolveDependency
// AutowiredAnnotationBeanPostProcessor:585行
protected void inject(Object bean, String beanName, PropertyValues pvs) throws Throwable {
// ......
try {
value = beanFactory.resolveDependency(desc, beanName, autowiredBeanNames, typeConverter);
}
catch (BeansException ex) {
// ......
}
}
debug进去,发现又回到了DefaultListableBeanFactory这个类,执行doResolveDependency
// DefaultListableBeanFactory
public Object resolveDependency(DependencyDescriptor descriptor, String requestingBeanName,
Set<String> autowiredBeanNames, TypeConverter typeConverter) throws BeansException {
......
else {
Object result = getAutowireCandidateResolver().getLazyResolutionProxyIfNecessary(
descriptor, requestingBeanName);
if (result == null) {
// 就是这里了,解析依赖
result = doResolveDependency(descriptor, requestingBeanName, autowiredBeanNames, typeConverter);
}
return result;
}
}
继续跟进,在doResolveDependency中会调用descriptor.resolveCandidate
// DefaultListableBeanFactory
public Object doResolveDependency(DependencyDescriptor descriptor, String beanName,
Set<String> autowiredBeanNames, TypeConverter typeConverter) throws BeansException {
......
return (instanceCandidate instanceof Class ?
// 就是这里了,解析候选bean
descriptor.resolveCandidate(autowiredBeanName, type, this) : instanceCandidate);
}
finally {
ConstructorResolver.setCurrentInjectionPoint(previousInjectionPoint);
}
}
再debug进descriptor.resolveCandidate
// DependencyDescriptor
public Object resolveCandidate(String beanName, Class<?> requiredType, BeanFactory beanFactory)
throws BeansException {
// 最终又回到了getBean
return beanFactory.getBean(beanName, requiredType);
}
看到了什么?没错,最终还是调的getBean去实例化依赖bean属性。好了,验证完毕,没毛病。
这是@Autowire方式的依赖注入,感兴趣的朋友也可以试下别的依赖注入方式。