1、前言
前面的文章我们已经对IOC之Spring统一资源加载策略有了一定的了解,本文我们将探讨Spring IOC 加载 BeanDefinition的整个过程。
我们先先看一段熟悉的代码:
ClassPathResource resource = new ClassPathResource("bean.xml"); // <1>
DefaultListableBeanFactory factory = new DefaultListableBeanFactory(); // <2>
XmlBeanDefinitionReader reader = new XmlBeanDefinitionReader(factory); // <3>
reader.loadBeanDefinitions(resource); // <4>
这段代码是 Spring 中编程式使用 IoC 容器,通过这四段简单的代码,我们可以初步判断 IoC 容器的使用过程。
- 获取资源
- 获取 BeanFactory
- 根据新建的 BeanFactory 创建一个 BeanDefinitionReader 对象,该 Reader 对象为资源的解析器
- 装载资源
整个过程就分为三个步骤:资源定位、装载、注册,如下:
1、资源定位。我们一般用外部资源来描述 Bean 对象,所以在初始化 IoC 容器的第一步就是需要定位这个外部资源。在上一篇博客已IOC之Spring统一资源加载策略经详细说明了资源加载的过程。
2、装载。装载就是 BeanDefinition 的载入。BeanDefinitionReader 读取、解析 Resource 资源,也就是将用户定义的 Bean 表示成 IoC 容器的内部数据结构:BeanDefinition 。
- 在 IoC 容器内部维护着一个 BeanDefinition Map 的数据结构
- 在配置文件中每一个
<bean>
都对应着一个 BeanDefinition 对象。
3、注册。向 IoC 容器注册在第二步解析好的 BeanDefinition,这个过程是通过 BeanDefinitionRegistry 接口来实现的。在 IoC 容器内部其实是将第二个过程解析得到的 BeanDefinition 注入到一个 HashMap 容器中,IoC 容器就是通过这个 HashMap 来维护这些 BeanDefinition 的。
- 在这里需要注意的一点是这个过程并没有完成依赖注入(Bean 创建),Bean 创建是发生在应用第一次调用
#getBean(...)
方法,向容器索要 Bean 时。 - 当然我们可以通过设置预处理,即对某个 Bean 设置
lazyinit = false
属性,那么这个 Bean 的依赖注入就会在容器初始化的时候完成。
2 源码分析
2.1 Resource 定位
Spring 为了解决资源定位的问题,提供了两个接口:Resource、ResourceLoader,其中:
- Resource 接口是 Spring 统一资源的抽象接口
- ResourceLoader 则是 Spring 资源加载的统一抽象。
Resource 资源的定位需要 Resource 和 ResourceLoader 两个接口互相配合,在上面那段代码中 new ClassPathResource("bean.xml")
为我们定义了资源,那么 ResourceLoader 则是在什么时候初始化的呢?看 XmlBeanDefinitionReader 构造方法:
// XmlBeanDefinitionReader.java
public XmlBeanDefinitionReader(BeanDefinitionRegistry registry) {super(registry);
}
- 直接调用父类 AbstractBeanDefinitionReader 构造方法,代码如下:
// AbstractBeanDefinitionReader.javaprotected AbstractBeanDefinitionReader(BeanDefinitionRegistry registry) {Assert.notNull(registry, "BeanDefinitionRegistry must not be null");this.registry = registry;// Determine ResourceLoader to use.if (this.registry instanceof ResourceLoader) {this.resourceLoader = (ResourceLoader) this.registry;} else {this.resourceLoader = new PathMatchingResourcePatternResolver();}// Inherit Environment if possibleif (this.registry instanceof EnvironmentCapable) {this.environment = ((EnvironmentCapable) this.registry).getEnvironment();} else {this.environment = new StandardEnvironment();} }
- 核心在于设置 resourceLoader 这段,如果设置了 ResourceLoader 则用设置的,否则使用 PathMatchingResourcePatternResolver ,该类是一个集大成者的 ResourceLoader。
2.2 BeanDefinition 的载入和解析
reader.loadBeanDefinitions(resource);
代码段,开启 BeanDefinition 的解析过程。如下:
// XmlBeanDefinitionReader.java
@Override
public int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException {return loadBeanDefinitions(new EncodedResource(resource));
}
在这个方法会将资源 resource 包装成一个 EncodedResource 实例对象,然后调用 #loadBeanDefinitions(EncodedResource encodedResource)
方法。而将 Resource 封装成 EncodedResource 主要是为了对 Resource 进行编码,保证内容读取的正确性。代码如下:
// XmlBeanDefinitionReader.javapublic int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException {// ... 省略一些代码try {// 将资源文件转为 InputStream 的 IO 流InputStream inputStream = encodedResource.getResource().getInputStream();try {// 从 InputStream 中得到 XML 的解析源InputSource inputSource = new InputSource(inputStream);if (encodedResource.getEncoding() != null) {inputSource.setEncoding(encodedResource.getEncoding());}// ... 具体的读取过程return doLoadBeanDefinitions(inputSource, encodedResource.getResource());}finally {inputStream.close();}}// 省略一些代码
}
从 encodedResource
源中获取 xml 的解析源,然后调用 #doLoadBeanDefinitions(InputSource inputSource, Resource resource)
方法,执行具体的解析过程。
// XmlBeanDefinitionReader.javaprotected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)throws BeanDefinitionStoreException {try {// 获取 XML Document 实例Document doc = doLoadDocument(inputSource, resource);// 根据 Document 实例,注册 Bean 信息int count = registerBeanDefinitions(doc, resource);return count;}// ... 省略一堆配置
}
- 在该方法中主要做两件事:
- 1、根据 xml 解析源获取相应的 Document 对象。
- 2、调用
#registerBeanDefinitions(Document doc, Resource resource)
方法,开启 BeanDefinition 的解析注册过程。
2.3 转换为 Document 对象
调用 #doLoadDocument(InputSource inputSource, Resource resource)
方法,会将 Bean 定义的资源转换为 Document 对象。代码如下:
// XmlBeanDefinitionReader.javaprotected Document doLoadDocument(InputSource inputSource, Resource resource) throws Exception {return this.documentLoader.loadDocument(inputSource, getEntityResolver(), this.errorHandler,getValidationModeForResource(resource), isNamespaceAware());
}
该方法接受五个参数:
inputSource
:加载 Document 的 Resource 源。entityResolver
:解析文件的解析器。errorHandler
:处理加载 Document 对象的过程的错误。validationMode
:验证模式。namespaceAware
:命名空间支持。如果要提供对 XML 名称空间的支持,则为true
。
#loadDocument(InputSource inputSource, EntityResolver entityResolver, ErrorHandler errorHandler, int validationMode, boolean namespaceAware)
方法,在类 DefaultDocumentLoader 中提供了实现。代码如下:
// DefaultDocumentLoader.java@Override
public Document loadDocument(InputSource inputSource, EntityResolver entityResolver,ErrorHandler errorHandler, int validationMode, boolean namespaceAware) throws Exception {// 创建 DocumentBuilderFactoryDocumentBuilderFactory factory = createDocumentBuilderFactory(validationMode, namespaceAware);// 创建 DocumentBuilderDocumentBuilder builder = createDocumentBuilder(factory, entityResolver, errorHandler);// 解析 XML InputSource 返回 Document 对象return builder.parse(inputSource);
}
2.4 注册 BeanDefinition 流程
这到这里,就已经将定义的 Bean 资源文件,载入并转换为 Document 对象了。那么,下一步就是如何将其解析为 SpringIoC 管理的 BeanDefinition 对象,并将其注册到容器中。这个过程由方法 #registerBeanDefinitions(Document doc, Resource resource)
方法来实现。代码如下:
// XmlBeanDefinitionReader.javapublic int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {// 创建 BeanDefinitionDocumentReader 对象BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();// 获取已注册的 BeanDefinition 数量int countBefore = getRegistry().getBeanDefinitionCount();// 创建 XmlReaderContext 对象// 注册 BeanDefinitiondocumentReader.registerBeanDefinitions(doc, createReaderContext(resource));// 计算新注册的 BeanDefinition 数量return getRegistry().getBeanDefinitionCount() - countBefore;
}
- 首先,创建 BeanDefinition 的解析器 BeanDefinitionDocumentReader 。
-
然后,调用该 BeanDefinitionDocumentReader 的
#registerBeanDefinitions(Document doc, XmlReaderContext readerContext)
方法,开启解析过程,这里使用的是委派模式,具体的实现由子类 DefaultBeanDefinitionDocumentReader 完成。代码如下:// DefaultBeanDefinitionDocumentReader.java@Override public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {this.readerContext = readerContext;// 获得 XML Document Root Element// 执行注册 BeanDefinitiondoRegisterBeanDefinitions(doc.getDocumentElement()); }
2.4.1 对 Document 对象的解析
从 Document 对象中获取根元素 root,然后调用 #doRegisterBeanDefinitions(Element root)` 方法,开启真正的解析过程。代码如下:
// DefaultBeanDefinitionDocumentReader.javaprotected void doRegisterBeanDefinitions(Element root) {// ... 省略部分代码(非核心)this.delegate = createDelegate(getReaderContext(), root, parent);// 解析前处理preProcessXml(root);// 解析parseBeanDefinitions(root, this.delegate);// 解析后处理postProcessXml(root);}
#preProcessXml(Element root)
、#postProcessXml(Element root)
为前置、后置增强处理,目前 Spring 中都是空实现。-
#parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate)
是对根元素 root 的解析注册过程。代码如下:// DefaultBeanDefinitionDocumentReader.javaprotected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {// 如果根节点使用默认命名空间,执行默认解析if (delegate.isDefaultNamespace(root)) {// 遍历子节点NodeList nl = root.getChildNodes();for (int i = 0; i < nl.getLength(); i++) {Node node = nl.item(i);if (node instanceof Element) {Element ele = (Element) node;// 如果该节点使用默认命名空间,执行默认解析if (delegate.isDefaultNamespace(ele)) {parseDefaultElement(ele, delegate);// 如果该节点非默认命名空间,执行自定义解析} else {delegate.parseCustomElement(ele);}}}// 如果根节点非默认命名空间,执行自定义解析} else {delegate.parseCustomElement(root);} }
- 迭代 root 元素的所有子节点,对其进行判断:
- 若节点为默认命名空间,则调用
#parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate)
方法,开启默认标签的解析注册过程。 - 否则,调用
BeanDefinitionParserDelegate#parseCustomElement(Element ele)
方法,开启自定义标签的解析注册过程。
- 若节点为默认命名空间,则调用
2.4.1.1 默认标签解析
若定义的元素节点使用的是 Spring 默认命名空间,则调用 #parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate)
方法,进行默认标签解析。代码如下:
// DefaultBeanDefinitionDocumentReader.javaprivate void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) { // importimportBeanDefinitionResource(ele);} else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) { // aliasprocessAliasRegistration(ele);} else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) { // beanprocessBeanDefinition(ele, delegate);} else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) { // beans// recursedoRegisterBeanDefinitions(ele);}
}
对四大标签:<import>
、<alias>
、<bean>
、<beans>
进行解析。其中 <bean>
标签的解析为核心工
2.4.1.2 自定义标签解析
对于默认标签则由 parseCustomElement(Element ele)
方法,负责解析。代码如下:
// BeanDefinitionParserDelegate.java@Nullable
public BeanDefinition parseCustomElement(Element ele) {return parseCustomElement(ele, null);
}@Nullable
public BeanDefinition parseCustomElement(Element ele, @Nullable BeanDefinition containingBd) {// 获取 namespaceUriString namespaceUri = getNamespaceURI(ele);if (namespaceUri == null) {return null;}// 根据 namespaceUri 获取相应的 HandlerNamespaceHandler handler = this.readerContext.getNamespaceHandlerResolver().resolve(namespaceUri);if (handler == null) {error("Unable to locate Spring NamespaceHandler for XML schema namespace [" + namespaceUri + "]", ele);return null;}// 调用自定义的 Handler 处理return handler.parse(ele, new ParserContext(this.readerContext, this, containingBd));
}
获取节点的 namespaceUri
,然后根据该 namespaceUri
获取相对应的 NamespaceHandler,最后调用 NamespaceHandler 的 #parse(Element element, ParserContext parserContext)
方法,即完成自定义标签的解析和注入。
2.4 注册 BeanDefinition
经过上面的解析,则将 Document 对象里面的 Bean 标签解析成了一个个的 BeanDefinition ,下一步则是将这些 BeanDefinition 注册到 IoC 容器中。动作的触发是在解析 Bean 标签完成后,代码如下:
// DefaultBeanDefinitionDocumentReader.javaprotected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {// 进行 bean 元素解析。// 如果解析成功,则返回 BeanDefinitionHolder 对象。而 BeanDefinitionHolder 为 name 和 alias 的 BeanDefinition 对象// 如果解析失败,则返回 null 。BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);if (bdHolder != null) {// 进行自定义标签处理bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);try {// 进行 BeanDefinition 的注册// Register the final decorated instance.BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());} catch (BeanDefinitionStoreException ex) {getReaderContext().error("Failed to register bean definition with name '" +bdHolder.getBeanName() + "'", ele, ex);}// 发出响应事件,通知相关的监听器,已完成该 Bean 标签的解析。// Send registration event.getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));}
}
调用 BeanDefinitionReaderUtils.registerBeanDefinition()
方法,来注册。其实,这里面也是调用 BeanDefinitionRegistry 的 #registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
方法,来注册 BeanDefinition 。不过,最终的实现是在 DefaultListableBeanFactory 中实现,代码如下:
// DefaultListableBeanFactory.java
@Override
public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)throws BeanDefinitionStoreException {// ...省略校验相关的代码// 从缓存中获取指定 beanName 的 BeanDefinitionBeanDefinition existingDefinition = this.beanDefinitionMap.get(beanName);// 如果已经存在if (existingDefinition != null) {// 如果存在但是不允许覆盖,抛出异常if (!isAllowBeanDefinitionOverriding()) {throw new BeanDefinitionOverrideException(beanName, beanDefinition, existingDefinition);} else {// ...省略 logger 打印日志相关的代码}// 【重点】允许覆盖,直接覆盖原有的 BeanDefinition 到 beanDefinitionMap 中。this.beanDefinitionMap.put(beanName, beanDefinition);// 如果未存在} else {// ... 省略非核心的代码// 【重点】添加到 BeanDefinition 到 beanDefinitionMap 中。this.beanDefinitionMap.put(beanName, beanDefinition);}// 重新设置 beanName 对应的缓存if (existingDefinition != null || containsSingleton(beanName)) {resetBeanDefinition(beanName);}
}
- 这段代码最核心的部分是这句
this.beanDefinitionMap.put(beanName, beanDefinition)
代码段。所以,注册过程也不是那么的高大上,就是利用一个 Map 的集合对象来存放:key
是beanName
,value
是 BeanDefinition 对象。
3.总结
至此,整个 IoC 的初始化过程就已经完成了,从 Bean 资源的定位,转换为 Document 对象,接着对其进行解析,最后注册到 IoC 容器中,都已经完美地完成了。现在 IoC 容器中已经建立了整个 Bean 的配置信息,这些 Bean 可以被检索、使用、维护,他们是控制反转的基础,是后面注入 Bean 的依赖。最后用一张流程图来结束这篇总结之文。