4.Spring源码系列-Xml文件解析

介绍

解析xml相关的类主要有以下：

• org.springframework.beans.factory.xml.XmlBeanDefinitionReader
• org.springframework.beans.factory.xml.AbstractBeanDefinitionReader
  主要功能是将定义的bean xml文件解析成bean definition并注册到bean factory（DefaultListableBeanFactory）中

方法调用

1. AbstractBeanDefinitionReader.loadBeanDefinitions

// 获取xml资源加载器
 ResourceLoader resourceLoader = getResourceLoader();
 // 资源加载器是正则路径匹配，譬如 classpath:application-*.xml
if (resourceLoader instanceof ResourcePatternResolver) {
// 获取正则匹配的所有资源
Resource[] resources = ((ResourcePatternResolver) resourceLoader).getResources(location);
}else{
// 绝对路径获取资源
Resource resource = resourceLoader.getResource(location);
}

2. XmlBeanDefinitionReader.loadBeanDefinitions(EncodedResource encodedResource)

// 获取字节流
InputStream inputStream = encodedResource.getResource().getInputStream();
// 转换为xml流
InputSource inputSource = new InputSource(inputStream);
if (encodedResource.getEncoding() != null) {
inputSource.setEncoding(encodedResource.getEncoding());
}
return doLoadBeanDefinitions(inputSource, encodedResource.getResource());

3. XmlBeanDefinitionReader.doLoadBeanDefinitions

// 解析xml为W3c的DOM
Document doc = doLoadDocument(inputSource, resource);
// 注册bean definition
return registerBeanDefinitions(doc, resource);

4. DefaultBeanDefinitionDocumentReader.doRegisterBeanDefinitions
   从root开始解析

//这部分是判断当前beans空间配置的profile是否激活，如果激活才解析。
//,不配置默认激活。
//配置的话，激活方式可以通过-D system properties或
//servlet context init params：
//spring.profiles.active=p1,p2
//spring.profiles.default=p1,p2

BeanDefinitionParserDelegate parent = this.delegate;
if (this.delegate.isDefaultNamespace(root)) {
String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE);
String[] specifiedProfiles = StringUtils.tokenizeToStringArray(profileSpec, BeanDefinitionParserDelegate.MULTI_VALUE_ATTRIBUTE_DELIMITERS);
if(!getReaderContext().getEnvironment().acceptsProfiles(specifiedProfiles)) {
return;}
}
//解析xml前干嘛（自己覆写）
preProcessXml(root);
parseBeanDefinitions(root, this.delegate);
//解析完后干嘛（自己覆写）
postProcessXml(root);

5. DefaultBeanDefinitionDocumentReader.parseBeanDefinitions

// 获取beans的直系子node
NodeList nl = root.getChildNodes();
//循环解析子node
for (int i = 0; i < nl.getLength(); i++) {
Element ele = nl.item(i);
//解析默认命名空间元素：、、、
if (delegate.isDefaultNamespace(ele)) {
  parseDefaultElement(ele, delegate);
}
//解析其他命名空间，譬如、
else {
  delegate.parseCustomElement(ele);
}
}

6. BeanDefinitionParserDelegate.parseCustomElement

// 获取命名空间url
String namespaceUri = getNamespaceURI(ele);
// 获取命名空间处理器，作用是通过处理器可以找到合适的beanDefinationParser
NamespaceHandler handler = this.readerContext.getNamespaceHandlerResolver().resolve(namespaceUri);
// 解析空间，并获取合适的parser
return handler.parse(ele, new ParserContext(this.readerContext, this, containingBd));

7. NamespaceHandlerSupport.parse

// 根据xml元素，获取合适的parse，并执行解析
// 从这类开始，aop、context空间都将激活
// 效果：
// spring注解会生效
// 被标注为@component，@service等的bean并解析
// aop代理生效
return findParserForElement(element, parserContext).parse(element, parserContext);

下一章会剖析命名空间解析器