5. Spring IOC源码深度剖析 好处:提高培养代码架构思维、深入理解框架
原则
读源码的方法和技巧
Spring源码构建
5.1 Spring IoC容器初始化主体流程 1. Spring IoC的容器体系 IoC容器是Spring的核心模块,是抽象了对象管理、依赖关系管理的框架解决方案。
Spring 提供了很多 的容器,其中 BeanFactory 是顶层容器(根容器),不能被实例化,它定义了所有 IoC 容器 必须遵从的一套原则,具体的容器实现可以增加额外的功能,比如我们常用到的ApplicationContext,其下更具体的实现如 ClassPathXmlApplicationContext 包含了解析 xml 等一系列的内容, AnnotationConfigApplicationContext 则是包含了注解解析等一系列的内容。Spring IoC 容器继承体系非常聪明,需要使用哪个层次用哪个层次即可,不必使用功能大而全的。
BeanFactory 顶级接口方法栈如下
容器体系
通过其接口设计,我们可以看到我们一贯使用的 ApplicationContext 除了继承BeanFactory的子接口, 还继承了ResourceLoader、MessageSource等接口,因此其提供的功能也就更丰富了。
下面我们以 ClasspathXmlApplicationContext 为例,深入源码说明 IoC 容器的初始化流程。
2. Bean生命周期关键时机点
思路:创建一个类 LagouBean ,让其实现几个特殊的接口,并分别在接口实现的构造器、接口方法中 断点,观察线程调用栈,分析出 Bean 对象创建和管理关键点的触发时机。
LagouBean类
public class LagouBean implements InitializingBean , ApplicationContextAware { private ItBean itBean; public void setItBean (ItBean itBean) { this .itBean = itBean; } public LagouBean () { System.out.println("LagouBean 构造器..." ); } public void afterPropertiesSet () throws Exception { System.out.println("LagouBean afterPropertiesSet..." ); } public void print () { System.out.println("print方法业务逻辑执行" ); } @Override public void setApplicationContext (ApplicationContext applicationContext) throws BeansException { System.out.println("setApplicationContext...." ); } }
public class MyBeanFactoryPostProcessor implements BeanFactoryPostProcessor { public MyBeanFactoryPostProcessor () { System.out.println("BeanFactoryPostProcessor的实现类构造函数..." ); } @Override public void postProcessBeanFactory (ConfigurableListableBeanFactory beanFactory) throws BeansException { System.out.println("BeanFactoryPostProcessor的实现方法调用中......" ); } }
public class MyBeanPostProcessor implements BeanPostProcessor { public MyBeanPostProcessor () { System.out.println("BeanPostProcessor 实现类构造函数..." ); } @Override public Object postProcessBeforeInitialization (Object bean, String beanName) throws BeansException { if ("lagouBean" .equals(beanName)) { System.out.println("BeanPostProcessor 实现类 postProcessBeforeInitialization 方法被调用中......" ); } return bean; } @Override public Object postProcessAfterInitialization (Object bean, String beanName) throws BeansException { if ("lagouBean" .equals(beanName)) { System.out.println("BeanPostProcessor 实现类 postProcessAfterInitialization 方法被调用中......" ); } return bean; } }
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns ="http://www.springframework.org/schema/beans" xmlns:xsi ="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation =" http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd " ><bean id ="lagouBean" class ="com.lagou.LagouBean" /> <bean id ="myBeanFactoryPostProcessor" class ="com.lagou.MyBeanFactoryPostProcessor" /><bean id ="myBeanPostProcessor" class ="com.lagou.MyBeanPostProcessor" /> </beans >
public class IocTest { @Test public void testIoC () { ApplicationContext applicationContext = new ClassPathXmlApplicationContext("classpath:applicationContext.xml" ); LagouBean lagouBean = applicationContext.getBean(LagouBean.class); System.out.println(lagouBean); } }
分析 Bean 的创建是在容器初始化时还是在 getBean 时 在未设置延迟加载的前提下,Bean 的创建是在容器初始化过程中完成的。
分析构造函数调用情况 发现Bean的构造函数的调用时机在AbstractApplicationContext类refresh方法的 finishBeanFactoryInitialization(beanFactory)处。
分析 InitializingBean 之 afterPropertiesSet 初始化方法调用情况 发现 InitializingBean中afterPropertiesSet 方法的调用时机也是在 AbstractApplicationContext类refresh方法的finishBeanFactoryInitialization(beanFactory);
分析BeanFactoryPostProcessor 初始化和调用情况 分别在构造函数、postProcessBeanFactory 方法处打断点,观察调用栈,发现 BeanFactoryPostProcessor 初始化和调用都发生在AbstractApplicationContext类refresh方法的invokeBeanFactoryPostProcessors(beanFactory);
分析 BeanPostProcessor 初始化和调用情况 分别在构造函数、postProcessBeanFactory 方法处打断点,观察调用栈,发现BeanPostProcessor 初始化在AbstractApplicationContext类refresh方法的 registerBeanPostProcessors(beanFactory); postProcessBeforeInitialization 调用在AbstractApplicationContext类refresh方法的 finishBeanFactoryInitialization(beanFactory); postProcessAfterInitialization 调用在AbstractApplicationContext类refresh方法的 finishBeanFactoryInitialization(beanFactory);
总结 根据上面的调试分析,我们发现 Bean对象创建的几个关键时机点代码层级的调用都在 AbstractApplicationContext 类的 refresh 方法中,可⻅这个方法对于Spring IoC 容器初始化来说相当关键,汇总如下:
3. BeanFactory初始化主流程分析 由以上分析可知,Spring IOC容器初始化的关键环节在AbstractApplicationContext#refresh()
方法中,我们查看refresh方法来俯瞰IOC创建的主题流程:
@Override public void refresh () throws BeansException, IllegalStateException { synchronized (this .startupShutdownMonitor) { prepareRefresh(); ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory(); prepareBeanFactory(beanFactory); try { postProcessBeanFactory(beanFactory); invokeBeanFactoryPostProcessors(beanFactory); registerBeanPostProcessors(beanFactory); initMessageSource(); initApplicationEventMulticaster(); onRefresh(); registerListeners(); finishBeanFactoryInitialization(beanFactory); finishRefresh(); } } }
5.2 BeanFactory创建流程 1. 获取BeanFactory子流程 时序图:
2. BeanDefinition加载解析及注册子流程 关键步骤 该子流程涉及到如下几个关键步骤:
Resource定位 :指对BeanDefinition的资源定位过程。通俗讲就是找到定义Javabean信息的XML文 件,并将其封装成Resource对象。
BeanDefinition载入 :把用户定义好的Javabean表示为IoC容器内部的数据结构,这个容器内部的数 据结构就是BeanDefinition。
注册BeanDefinition到 IoC 容器
过程分析 子流程入口在 AbstractRefreshableApplicationContext#refreshBeanFactory
依次调用多个类的 loadBeanDefinitions 方法 —> AbstractXmlApplicationContext —> AbstractBeanDefinitionReader —> XmlBeanDefinitionReader 一直执行到 XmlBeanDefinitionReader 的 doLoadBeanDefinitions 方法
我们重点观察XmlBeanDefinitionReader 类的 registerBeanDefinitions 方法,期间产生了多 次重载调用,我们定位到最后一个
此处我们关注两个地方:一个createRederContext方法,一个是 DefaultBeanDefinitionDocumentReader类的registerBeanDefinitions方法,先进入 createRederContext 方法看看
public XmlReaderContext createReaderContext (Resource resource) { return new XmlReaderContext(resource, this .problemReporter, this .eventListener, this .sourceExtractor, this , getNamespaceHandlerResolver()); } public NamespaceHandlerResolver getNamespaceHandlerResolver () { if (this .namespaceHandlerResolver == null ) { this .namespaceHandlerResolver = createDefaultNamespaceHandlerResolver(); } return this .namespaceHandlerResolver; } protected NamespaceHandlerResolver createDefaultNamespaceHandlerResolver () { ClassLoader cl = (getResourceLoader() != null ? getResourceLoader().getClassLoader() : getBeanClassLoader()); return new DefaultNamespaceHandlerResolver(cl); }
我们可以看到,此处 Spring 首先完成了 NamespaceHandlerResolver 的初始化。 我们再进入 registerBeanDefinitions 方法中追踪,调用了 DefaultBeanDefinitionDocumentReader#registerBeanDefinitions 方法
进入 doRegisterBeanDefinitions 方法
进入 parseBeanDefinitions 方法
进入 processBeanDefinition 方法
至此,注册流程结束,我们发现,所谓的注册就是把封装的 XML 中定义的 Bean信息封装为 BeanDefinition 对象之后放入一个Map中,BeanFactory 是以 Map 的结构组织这些 BeanDefinition 的。
可以在DefaultListableBeanFactory中看到此Map的定义
private final Map<String, BeanDefinition> beanDefinitionMap = new ConcurrentHashMap<>(256 );
时序图
5.3 Bean创建流程 通过最开始的关键时机点分析,我们知道Bean创建子流程入口在 AbstractApplicationContext#refresh()
方法的finishBeanFactoryInitialization(beanFactory)
处进入finishBeanFactoryInitialization
继续进入DefaultListableBeanFactory类的preInstantiateSingletons方法,我们找到下面部分的代码,看到工厂Bean或者普通豆,最终都是通过getBean的方法获取实例
AbstractBeanFactory类的doGetBean方法,这个方法中的代码很多,我们直接找到核心部分
protected <T> T doGetBean (final String name, @Nullable final Class<T> requiredType, @Nullable final Object[] args, boolean typeCheckOnly) throws BeansException { final String beanName = transformedBeanName(name); Object bean; Object sharedInstance = getSingleton(beanName); if (sharedInstance != null && args == null ) { if (logger.isTraceEnabled()) { if (isSingletonCurrentlyInCreation(beanName)) { logger.trace("Returning eagerly cached instance of singleton bean '" + beanName + "' that is not fully initialized yet - a consequence of a circular reference" ); } else { logger.trace("Returning cached instance of singleton bean '" + beanName + "'" ); } } bean = getObjectForBeanInstance(sharedInstance, name, beanName, null ); } else { if (isPrototypeCurrentlyInCreation(beanName)) { throw new BeanCurrentlyInCreationException(beanName); } BeanFactory parentBeanFactory = getParentBeanFactory(); if (parentBeanFactory != null && !containsBeanDefinition(beanName)) { String nameToLookup = originalBeanName(name); if (parentBeanFactory instanceof AbstractBeanFactory) { return ((AbstractBeanFactory) parentBeanFactory).doGetBean( nameToLookup, requiredType, args, typeCheckOnly); } else if (args != null ) { return (T) parentBeanFactory.getBean(nameToLookup, args); } else if (requiredType != null ) { return parentBeanFactory.getBean(nameToLookup, requiredType); } else { return (T) parentBeanFactory.getBean(nameToLookup); } } if (!typeCheckOnly) { markBeanAsCreated(beanName); } try { final RootBeanDefinition mbd = getMergedLocalBeanDefinition(beanName); checkMergedBeanDefinition(mbd, beanName, args); 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); try { getBean(dep); } catch (NoSuchBeanDefinitionException ex) { throw new BeanCreationException(mbd.getResourceDescription(), beanName, "'" + beanName + "' depends on missing bean '" + dep + "'" , ex); } } } if (mbd.isSingleton()) { sharedInstance = getSingleton(beanName, () -> { try { return createBean(beanName, mbd, args); } catch (BeansException ex) { destroySingleton(beanName); throw ex; } }); bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd); } else if (mbd.isPrototype()) { Object prototypeInstance = null ; try { beforePrototypeCreation(beanName); prototypeInstance = createBean(beanName, mbd, args); } finally { afterPrototypeCreation(beanName); } bean = getObjectForBeanInstance(prototypeInstance, name, beanName, mbd); } 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, () -> { 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; } } if (requiredType != null && !requiredType.isInstance(bean)) { try { T convertedBean = getTypeConverter().convertIfNecessary(bean, requiredType); if (convertedBean == null ) { throw new BeanNotOfRequiredTypeException(name, requiredType, bean.getClass()); } return convertedBean; } catch (TypeMismatchException ex) { if (logger.isTraceEnabled()) { logger.trace("Failed to convert bean '" + name + "' to required type '" + ClassUtils.getQualifiedName(requiredType) + "'" , ex); } throw new BeanNotOfRequiredTypeException(name, requiredType, bean.getClass()); } } return (T) bean; }
接着进入到AbstractAutowireCapableBeanFactory类的方法,找到以下代码部分
进入doCreateBean方法看看,该方法我们关注两块重点区域
if (instanceWrapper == null ) { instanceWrapper = createBeanInstance(beanName, mbd, args); }
给Bean填充属性,调用初始化方法,应用BeanPostProcessor后置处理器
5.4 lazy-init 延迟加载机制原理 普通 Bean 的初始化是在容器启动初始化阶段执行的,而被lazy-init=true修饰的 bean 则是在从容器里 第一次进行context.getBean() 时进行触发。Spring 启动的时候会把所有bean信息(包括XML和注解)解 析转化成Spring能够识别的BeanDefinition并存到Hashmap里供下面的初始化时用,然后对每个 BeanDefinition 进行处理,如果是懒加载的则在容器初始化阶段不处理,其他的则在容器初始化阶段进 行初始化并依赖注入。
public void preInstantiateSingletons () throws BeansException { if (logger.isTraceEnabled()) { logger.trace("Pre-instantiating singletons in " + this ); } List<String> beanNames = new ArrayList<>(this .beanDefinitionNames); for (String beanName : beanNames) { RootBeanDefinition bd = getMergedLocalBeanDefinition(beanName); if (!bd.isAbstract() && bd.isSingleton() && !bd.isLazyInit()) { if (isFactoryBean(beanName)) { Object bean = getBean(FACTORY_BEAN_PREFIX + beanName); if (bean instanceof FactoryBean) { final FactoryBean<?> factory = (FactoryBean<?>) bean; boolean isEagerInit; if (System.getSecurityManager() != null && factory instanceof SmartFactoryBean) { isEagerInit = AccessController.doPrivileged((PrivilegedAction<Boolean>) ((SmartFactoryBean<?>) factory)::isEagerInit, getAccessControlContext()); } else { isEagerInit = (factory instanceof SmartFactoryBean && ((SmartFactoryBean<?>) factory).isEagerInit()); } if (isEagerInit) { getBean(beanName); } } } else { getBean(beanName); } } } for (String beanName : beanNames) { Object singletonInstance = getSingleton(beanName); if (singletonInstance instanceof SmartInitializingSingleton) { final SmartInitializingSingleton smartSingleton = (SmartInitializingSingleton) singletonInstance; if (System.getSecurityManager() != null ) { AccessController.doPrivileged((PrivilegedAction<Object>) () -> { smartSingleton.afterSingletonsInstantiated(); return null ; }, getAccessControlContext()); } else { smartSingleton.afterSingletonsInstantiated(); } } } }
总结
对于被修饰为lazy-init的bean Spring 容器初始化阶段不会进行 init 并且依赖注入,当第一次进行getBean时候才进行初始化并依赖注入 对于非懒加载的bean,getBean的时候会从缓存里头获取,因为容器初始化阶段 Bean 已经初始化完成并缓存了起来 5.5 Spring IoC循环依赖问题 1. 什么是循环依赖 循环依赖其实就是循环引用,也就是两个或者两个以上的 Bean 互相持有对方,最终形成闭环。比如A 依赖于B,B依赖于C,C又依赖于A。
注意,这里不是函数的循环调用,是对象的相互依赖关系。循环调用其实就是一个死循环,除非有终结条件。
Spring中循环依赖场景有:
构造器的循环依赖(构造器注入) Field 属性的循环依赖(set注入) 其中,构造器的循环依赖问题无法解决,只能拋出 BeanCurrentlyInCreationException 异常,在解决
属性循环依赖时,spring采用的是提前暴露对象的方法。
2. 循环依赖处理机制 单例 bean 构造器参数循环依赖(无法解决) prototype 原型 bean循环依赖(无法解决) 对于原型bean的初始化过程中不论是通过构造器参数循环依赖还是通过setXxx方法产生循环依赖,Spring都会直接报错处理。
AbstractBeanFactory.doGetBean()
方法:
if (isPrototypeCurrentlyInCreation(beanName)) { throw new BeanCurrentlyInCreationException(beanName); } protected boolean isPrototypeCurrentlyInCreation (String beanName) { Object curVal = this .prototypesCurrentlyInCreation.get(); return (curVal != null && (curVal.equals(beanName) || (curVal instanceof Set && ((Set<?>) curVal).contains(beanName)))); }
在获取bean之前如果这个原型bean正在被创建则直接抛出异常。原型bean在创建之前会进行标记 这个beanName正在被创建,等创建结束之后会删除标记
try { beforePrototypeCreation(beanName); prototypeInstance = createBean(beanName, mbd, args); } finally { afterPrototypeCreation(beanName); }
总结:Spring 不支持原型 bean 的循环依赖。
单例bean通过setXxx或者@Autowired进行循环依赖 Spring 的循环依赖的理论依据基于 Java 的引用传递,当获得对象的引用时,对象的属性是可以延后设置的,但是构造器必须是在获取引用之前
Spring通过setXxx或者@Autowired方法解决循环依赖其实是通过提前暴露一个ObjectFactory对象来完成的,简单来说ClassA在调用构造器完成对象初始化之后,在调用ClassA的setClassB方法之前就把ClassA实例化的对象通过singletonFactory提前暴露到Spring容器中。
Spring容器初始化ClassA通过构造器初始化对象后提前暴露到Spring容器 ClassA调用setClassB方法,Spring首先尝试从容器中获取ClassB,此时ClassB不存在Spring容器中 Spring容器初始化ClassB,同时也会将ClassB提前暴露到Spring容器中 ClassB调用setClassA方法,Spring从容器中获取ClassA ,因为第一步中已经提前暴露了ClassA,因此可以获取到ClassA实例 ClassA通过spring容器获取到ClassB,完成了对象初始化操作。 这样ClassA和ClassB都完成了对象初始化操作,解决了循环依赖问题。