源码版本：Spring-framework-5.1
XML配置读取是Spring的重要功能，虽然SpringBoot进行了无配置化的方案，但是阅读Xml在Spring总的解析有利于对其执行流程。我们可以从 XmlBeanDefinitionReader 中梳理资源文件的读取、解析及注册的流程。
文章目录
1、XmlBeanDefinitionReader依赖关系图
2、执行流程
一、 资源加载
开始加载资源文件，会将Resource构造为EncodedResource，添加编码信息.接着会用一个ThreadLocal来存放当前资源同时也防止一个资源被加载两次。最后去调用 doLoadBeanDefinitions 来讲资源转为BeanDefinition.
@Override
public int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException {
return loadBeanDefinitions(new EncodedResource(resource));
}
public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException {
...
// 使用 ThreadLocal 来存放当前的Resources资源，方便之后获取
Set<EncodedResource> currentResources = this.resourcesCurrentlyBeingLoaded.get();
if (currentResources == null) {
currentResources = new HashSet<>(4);
this.resourcesCurrentlyBeingLoaded.set(currentResources);
}
// 同一个资源不允许加载两次
if (!currentResources.add(encodedResource)) {
throw new BeanDefinitionStoreException(
"Detected cyclic loading of " + encodedResource + " - check your import definitions!");
}
try (InputStream inputStream = encodedResource.getResource().getInputStream()) {
InputSource inputSource = new InputSource(inputStream);
if (encodedResource.getEncoding() != null) {
inputSource.setEncoding(encodedResource.getEncoding());
}
// 将resources 加载为BeanDefinitions
return doLoadBeanDefinitions(inputSource, encodedResource.getResource());
}
catch (IOException ex) {
throw new BeanDefinitionStoreException(
"IOException parsing XML document from " + encodedResource.getResource(), ex);
}
// 当前资源加载完成删除标记
finally {
currentResources.remove(encodedResource);
if (currentResources.isEmpty()) {
this.resourcesCurrentlyBeingLoaded.remove();
}
}
}
二、将 Stream 转为 BeanDefinition
此处先是通过DocumentLoader将资源转为Document然后再通过BeanDefinitionDocumentReader将doc转为BeanDefinition.
protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
throws BeanDefinitionStoreException {
try {
// 通过DocumentLoad将传入的Resouces转为Document
Document doc = doLoadDocument(inputSource, resource);
// 将document加载为BeanDefinitions
int count = registerBeanDefinitions(doc, resource);
if (logger.isDebugEnabled()) {
logger.debug("Loaded " + count + " bean definitions from " + resource);
}
return count;
}
...
}
①、使用 DocumentLoader 将资源转为doc.
此处使用的是DocumentLoader 的默认实现类DefaultDocumentLoader来进行解析为doc的。
private DocumentLoader documentLoader = new DefaultDocumentLoader();
protected Document doLoadDocument(InputSource inputSource, Resource resource) throws Exception {
// 调用DefaultDocumentLoader将资源转为Document
return this.documentLoader.loadDocument(inputSource, getEntityResolver(), this.errorHandler,getValidationModeForResource(resource), isNamespaceAware());
}
然后在 DefaultDocumentLoader 中使用 DocumentBuilder 来解析资源,其将xml解析为doc使用的是 apache 的 xerces 。
@Override
public Document loadDocument(InputSource inputSource, EntityResolver entityResolver,
ErrorHandler errorHandler, int validationMode, boolean namespaceAware) throws Exception {
DocumentBuilderFactory factory = createDocumentBuilderFactory(validationMode, namespaceAware);
if (logger.isTraceEnabled()) {
logger.trace("Using JAXP provider [" + factory.getClass().getName() + "]");
}
// 此处得Doc 为 com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderImpl
DocumentBuilder builder = createDocumentBuilder(factory, entityResolver, errorHandler);
// DocumentBuilderImpl 使用的 DOMParser(apache xerces的实现)来解析资源
return builder.parse(inputSource);
}
②、将 doc 解析为 BeanDefinition
在上文我们有注意到 XmlBeanDefinitionReader 是通过 registerBeanDefinitions 方法去解析加载 BeanDefinitions 的。注意 createReaderContext 方法其有将 XmlBeanDefinitionReader 载入到 XmlReaderContext 当中
public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
// 创建 BeanDefinitionDocumentReader 的默认实现类 DefaultBeanDefinitionDocumentReader
BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
int countBefore = getRegistry().getBeanDefinitionCount();
// 通过 BeanDefinitionDocumentReader 将doc加载成为 BeanDefinition,此处的 createReaderContext有将
// XmlBeanDefinition 载入 方便后面进行BeanDefinition 的注册
documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
return getRegistry().getBeanDefinitionCount() - countBefore;
}
public XmlReaderContext createReaderContext(Resource resource) {
return new XmlReaderContext(resource, this.problemReporter, this.eventListener,
this.sourceExtractor, this, getNamespaceHandlerResolver());
}
可以看到其通过 BeanDefinitionDocumentReader 的实现类 DefaultBeanDefinitionDocumentReader 来解析 doc.而 DefaultBeanDefinitionDocumentReader 又使用 BeanDefinitionParserDelegate 来对 Element进行解析获得 BeanDefinition
@Override
public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
this.readerContext = readerContext;
doRegisterBeanDefinitions(doc.getDocumentElement());
}
protected void doRegisterBeanDefinitions(Element root) {
BeanDefinitionParserDelegate parent = this.delegate;
// 使用BeanDefinitionParserDelegate解析 Element
this.delegate = createDelegate(getReaderContext(), root, parent);
if (this.delegate.isDefaultNamespace(root)) {
...
}
// 对xml 的自定义扩展置前,默认为空
preProcessXml(root);
// spring的bean处理
parseBeanDefinitions(root, this.delegate);
// 对xml 的自定义扩展置后,默认为空
postProcessXml(root);
this.delegate = parent;
}
// 使用 BeanDefinitionParserDelegate 对Element进行解析
protected BeanDefinitionParserDelegate createDelegate(
XmlReaderContext readerContext, Element root, @Nullable BeanDefinitionParserDelegate parentDelegate) {
BeanDefinitionParserDelegate delegate = new BeanDefinitionParserDelegate(readerContext);
delegate.initDefaults(root, parentDelegate);
return delegate;
}
解析 BeanDefinition
/**
* Parse the elements at the root level in the document:
* "import", "alias", "bean".
* 处理以 以beans , bean , import , alias开头的四种bean，其他标示开始认为是自定义bean。
* @param root the DOM root element of the document
*/
protected 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);
}
}
/**
* 处理默认的 bean 标签
*/
private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
// 处理import 标签
importBeanDefinitionResource(ele);
}
else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
// 处理alias 标签
processAliasRegistration(ele);
}
else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
// 处理bean标签
processBeanDefinition(ele, delegate);
}
else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
// 处理 beans 标签
doRegisterBeanDefinitions(ele);
}
}
③、注册 BeanDefinition
以 alias 标签为例,
protected void processAliasRegistration(Element ele) {
String name = ele.getAttribute(NAME_ATTRIBUTE);
String alias = ele.getAttribute(ALIAS_ATTRIBUTE);
boolean valid = true;
if (!StringUtils.hasText(name)) {
getReaderContext().error("Name must not be empty", ele);
valid = false;
}
if (!StringUtils.hasText(alias)) {
getReaderContext().error("Alias must not be empty", ele);
valid = false;
}
if (valid) {
try {
// 真正进行 标签注册的地方
getReaderContext().getRegistry().registerAlias(name, alias);
}
catch (Exception ex) {
getReaderContext().error("Failed to register alias '" + alias +
"' for bean with name '" + name + "'", ele, ex);
}
getReaderContext().fireAliasRegistered(name, alias, extractSource(ele));
}
}
3、 涉及的类或接口
- DocumentLoader 将资源文件转为 Document的接口，实现类DefaultDocumentLoader,spring 使用的是DocumentBuilderImpl，内部使用的是DOMParser(apache xerces)来解析资源
- BeanDefinitionDocumentReader 将document转为BeanDefinition的接口，实现类 DefaultBeanDefinitionDocumentReader
- EnvironmentCapable 定义获取 Environment 方法，实现类 AbstractBeanDefinitionReader 在 构造函数中对 environment 进行了写入，因XmlBeanDefinitionReader 对 AbstractBeanDefinitionReader 是继承关系，故 XmlBeanDefinitionReader 在创建的时候即对environment进行了写入。
- BeanDefinitionParserDelegate 解析element
250
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
