声明
1.建议先阅读《Spring源码分析专题 —— 阅读指引》
2.强烈建议阅读过程中要参照调用过程图,每篇都有对应的调用过程图
3.写文不易,转载请标明出处
前言
在上文《Spring源码分析专题 —— IOC容器启动过程(上篇)》中我们已经寻找到 Spring IOC 启动过程的核心方法 refresh() ,本篇我们将详细讲解启动流程 「定位 -> 加载 -> 注册 -> 实例化」 中的加载与注册环节。
(定位的作用是获取到配置文件,通常我们spring的配置文件是 application.xml 或自定义的 spring-xxx.xml ,定位过程的细节不少,而对我们的主流程影响不大,所以关于定位过程将放在下篇补充讲解)
本篇继续使用上篇中的调用过程图☞ IOC容器启动调用过程图.jpg
加载与注册
我们再看一眼 refresh() 方法
1 | public void refresh() throws BeansException, IllegalStateException { |
在这个 refresh() 方法中,我们首先关注的是 obtainFreshBeanFactory()
1 | protected ConfigurableListableBeanFactory obtainFreshBeanFactory() { |
obtainFreshBeanFactory() 方法中调用了 refreshBeanFactory() ,而这个方法是在 AbstractApplicationContext 的子类 AbstractRefreshableApplicationContext 实现
1 | protected final void refreshBeanFactory() throws BeansException { |
refreshBeanFactory方法中调用了 loadBeanDefinitions 方法,路线又回到了 XmlWebApplicationContext 容器,loadBeanDefinitions 方法是在 XmlWebApplicationContext 类中实现的
1 | protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throws BeansException, IOException { |
方法最后是调用了重载的 loadBeanDefinitions 方法,传入的参数是 XmlBeanDefinitionReader 的对象,我们先看一看重载的 loadBeanDefinitions 方法
1 | protected void loadBeanDefinitions(XmlBeanDefinitionReader reader) throws IOException { |
可以看到,其实最后是调用 reader 的 loadBeanDefinitions 方法,此处 reader 的类型是 XmlBeanDefinitionReader ,所以我们查看 XmlBeanDefinitionReader 中的 loadBeanDefinitions 方法
1 | public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException { |
此处我们关注的是 doLoadBeanDefinitions 方法,有个技巧,在Spring中,以do开头的方法都是最终实际执行逻辑处理的。
1 | protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource) |
在这里有两个方法值得我们关注,一个是 doLoadDocument ,负责把配置文件读取为 Document 对象,这个方法中包含了「定位」过程的处理逻辑,关于定位过程我们在下篇再详细分析;第二个是 registerBeanDefinitions 方法,这个方法包含了「加载」和「注册」逻辑。
1 | public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException { |
这里关键有两步,第一步是获取 documentReader ,第二步是调用 documentReader 的 registerBeanDefinitions 方法。稍微跟踪一下可知 documentReader 的实际类型是 DefaultBeanDefinitionDocumentReader,所以我们进入到 DefaultBeanDefinitionDocumentReader 的 registerBeanDefinitions 方法
1 | public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) { |
按照惯例,干活的是do开头的方法
1 | protected void doRegisterBeanDefinitions(Element root) { |
然后是 parseBeanDefinitions 方法
1 | protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) { |
isDefaultNamespaces 方法是判断元素是否属于默认的 Namespace ,通过跟踪可知,这个默认的 Namespace 是指 <beans>
标签, 我们知道在spring的配置文件中,对bean的定义是放在 <beans>
标签里边的,所以接下来的 parseDefaultElement 方法则是用于解析 bean 定义的。
1 | private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) { |
到这里我们就一目了然了,这很显然就是针对 <beans>
标签中的各种元素进行解析,对于其他标签我们不深究,直接看处理 <bean>
标签的 processBeanDefinition 方法
1 | protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) { |
这里有两个非常关键的方法:
- 一个是 parseBeanDefinitionElement ,这个方法最终会返回一个持有 BeanDefinition 的 BeanDefinitionHolder 实例,我们在上篇开头的结论中已经说了,加载的过程其实就是把bean的定义转换成一个 BeanDefinition 对象,所以 parseBeanDefinitionElement 对应的便是 「加载」 过程;
- 另一个则是 registerBeanDefinition ,这个方法对应的便是「注册」过程。
接下来我们将分两部分分别讲解 parseBeanDefinitionElement 和 registerBeanDefinition 的内容
1. 加载 (parseBeanDefinitionElement)
bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
中的 delegate 是 BeanDefinitionParserDelegate 的实例,我们查看 BeanDefinitionParserDelegate 中的 decorateBeanDefinitionIfRequired 方法
1 | public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, @Nullable BeanDefinition containingBean) { |
这个方法先调用另一个重载的 parseBeanDefinitionElement 方法,然后把获得 beanDefinition 传入 BeanDefinitionHolder 。我们看一看重载的 parseBeanDefinitionElement 方法
1 | public AbstractBeanDefinition parseBeanDefinitionElement( |
这里的parse开头的方法都是对bean定义的属性标签进行解析,例如「name」、「singleton」、「lazy-init」等,大家可以自行深入了解每一个parse方法是如何解析各个属性的,在本文中就不再占用篇幅逐一讲解了。至此我们已经获取到了BeanDefinition的信息,下一步就到「注册」了。
2. 注册 (registerBeanDefinition)
所谓的注册,其实就是把BeanDefintion存储到IOC容器中,我们进入到 registerBeanDefinition 中看一看是如何实现的。
1 | public static void registerBeanDefinition( |
这里最终调用的是 registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition()) 其中 registry 是 DefaultListableBeanFactory 的实例。
(为什么是 DefaultListableBeanFactory ?感兴趣的可以去追溯一下,给出一点提示,在 AbstractRefreshableApplicationContext 的 refreshBeanFactory() 方法中会创建DefaultListableBeanFactory的实例,并在之后的所有关键方法中都会作为参数传入该实例,保证后续的调用流程中都能获取到该实例)
DefaultListableBeanFactory 的 registerBeanDefinition 方法如下
1 | public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition) |
this.beanDefinitionMap.put(beanName, beanDefinition);
这一行是重点,字面意思已经很明显,就是把 beanName 和 beanDefinition 以 key-value 的形式存储于 beanDefinitionMap 中, beanDefinitionMap 的定义如下。
1 | /** Map of bean definition objects, keyed by bean name. */ |
跟踪到这一步我们便可以得出结论:「 BeanDefinition 是存储在 DefaultListableBeanFactory 的一个 Map 数据结构中 」
[目录]
[上一篇]Spring源码分析专题 —— IOC容器启动过程(上篇)
[下一篇]Spring源码分析专题 —— IOC容器启动过程(下篇)