Spring源码解析--Spring配置文件解析NamespaceHandler

向右看齐 2021-08-19 12:21 400阅读 0赞

接下来我们介绍一下Spring提供的NamespaceHandler的处理机制，简单来说就是命名空间处理器，Spring为了开放性提供了NamespaceHandler机制，这样我们就可以根据需求自己来处理我们设置的标签元素。

Spring提供的NamespaceHandler处理器：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3o2OTE4Mzc4Nw_size_16_color_FFFFFF_t_70][]

NamespaceHandler提供的接口方法：

public interface NamespaceHandler {
    	void init();
    	BeanDefinition parse(Element element, ParserContext parserContext);
    	BeanDefinitionHolder decorate(Node source, BeanDefinitionHolder definition, ParserContext parserContext);
    }

接下来我们介绍一下AopNamespaceHandler来对命名空间处理器做一个了解。

我们使用基于xml的spring配置时，可能需要配置如<aop:config />这样的标签，在配置这个标签之前，通常我们需要引入这个aop所在的命名空间，红色部分。

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns:aop="http://www.springframework.org/schema/aop"
     xmlns:context="http://www.springframework.org/schema/context"
     xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
      http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd
      http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd />

只有通过配置aop的命名空间才会找到AOP标签的处理器AopNamespaceHandler，在AOP的jar中的spring.handlers配置文件中配置了命名空间和命名空间处理器之间的关系。

![20190927183446443.png][]

内容：

http\\://www.springframework.org/schema/aop=org.springframework.aop.config.AopNamespaceHandler

在spring.schemas配置文件中添加了url和本地xsd标签解析文件的关系。

http\://www.springframework.org/schema/aop/spring-aop-2.0.xsd=org/springframework/aop/config/spring-aop-2.0.xsd
    http\://www.springframework.org/schema/aop/spring-aop-2.5.xsd=org/springframework/aop/config/spring-aop-2.5.xsd
    http\://www.springframework.org/schema/aop/spring-aop-3.0.xsd=org/springframework/aop/config/spring-aop-3.0.xsd
    http\://www.springframework.org/schema/aop/spring-aop-3.1.xsd=org/springframework/aop/config/spring-aop-3.1.xsd
    http\://www.springframework.org/schema/aop/spring-aop-3.2.xsd=org/springframework/aop/config/spring-aop-3.2.xsd
    http\://www.springframework.org/schema/aop/spring-aop-4.0.xsd=org/springframework/aop/config/spring-aop-4.0.xsd
    http\://www.springframework.org/schema/aop/spring-aop-4.1.xsd=org/springframework/aop/config/spring-aop-4.1.xsd
    http\://www.springframework.org/schema/aop/spring-aop-4.2.xsd=org/springframework/aop/config/spring-aop-4.2.xsd
    http\://www.springframework.org/schema/aop/spring-aop-4.3.xsd=org/springframework/aop/config/spring-aop-4.3.xsd
    http\://www.springframework.org/schema/aop/spring-aop.xsd=org/springframework/aop/config/spring-aop-4.3.xsd

在jar中已经内置了xsd文件，文件内容包含了命名空间处理器AopNamespaceHandler对于标签处理的规则。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3o2OTE4Mzc4Nw_size_16_color_FFFFFF_t_70 1][]

对于上述内容的理解可以参考之前的文章[ Spring源码学习--自定义标签][Spring_--]

接下来我们介绍一下选择NamespaceHandler进行配置文件解析的流程。

在DefaultBeanDefinitionDocumentReader.parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate)方法中会选择使用默认命名空间还是使用非默认命名空间进行处理。

protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
            if (delegate.isDefaultNamespace(root.getNamespaceURI())) {
                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;
                        String namespaceUri = ele.getNamespaceURI();
                        if (delegate.isDefaultNamespace(namespaceUri)) {
                            //这里讲将对默认命名空间（http://www.springframework.org/schema/beans）下的标签节点（bean、import、alias等）进行处理
                            parseDefaultElement(ele, delegate);
                        }
                        else {
                            //这里对非默认命名空间下的标签进行处理
                            delegate.parseCustomElement(ele);
                        }
                    }
                }
            }
            else {
                delegate.parseCustomElement(root);
            }
        }

在BeanDefinitionParserDelegate的parseCustomElement中会进行选择NamespaceHandler进行配置文件解析处理。

public BeanDefinition parseCustomElement(Element ele) {
    		return parseCustomElement(ele, null);
    	}
    	public BeanDefinition parseCustomElement(Element ele, BeanDefinition containingBd) {
    		//获取xml配置文件中的命名空间http://www.springframework.org/schema/aop
    		String namespaceUri = getNamespaceURI(ele);
    		//根据命名空间找到命名空间处理类AopNamespaceHandler
    		NamespaceHandler handler = this.readerContext.getNamespaceHandlerResolver().resolve(namespaceUri);
    		if (handler == null) {
    			error("Unable to locate Spring NamespaceHandler for XML schema namespace [" + namespaceUri + "]", ele);
    			return null;
    		}
    		//解析命名空间支持的标签
    		return handler.parse(ele, new ParserContext(this.readerContext, this, containingBd));
    	}

在AopNamespaceHandler中会看到其初始化定义的标签解析处理器。接下来进行的操作就是对标签进行解析处理最终生成BeanDefinition

public class AopNamespaceHandler extends NamespaceHandlerSupport {
     
    	@Override
    	public void init() {
    		// In 2.0 XSD as well as in 2.1 XSD.
    		registerBeanDefinitionParser("config", new ConfigBeanDefinitionParser());
    		registerBeanDefinitionParser("aspectj-autoproxy", new AspectJAutoProxyBeanDefinitionParser());
    		registerBeanDefinitionDecorator("scoped-proxy", new ScopedProxyBeanDefinitionDecorator());
     
    		// Only in 2.0 XSD: moved to context namespace as of 2.1
    		registerBeanDefinitionParser("spring-configured", new SpringConfiguredBeanDefinitionParser());
    	}
     
    }

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3o2OTE4Mzc4Nw_size_16_color_FFFFFF_t_70]: /images/20210527/136a24d9456447e39c23108a221eb202.png
[20190927183446443.png]: /images/20210527/d9d8c60720f2453eac1fc6bb20b3aa69.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3o2OTE4Mzc4Nw_size_16_color_FFFFFF_t_70 1]: /images/20210527/574c54390a65443082463462bb6953b1.png
[Spring_--]: http://blog.csdn.net/qq924862077/article/details/70821233