读DUBBOX源码之自定义基于Spring可扩展Schema的配

读DUBBOX源码之自定义基于Spring可扩展Schema的配置xml文件

DubboX是一个开源的分布式服务框架，是当当对阿里Dubbo的一个扩展。目前DubboX的最新版本为2.8.4
Dubbo有xml、属性、API、注解共4中配置方式。DubboX的xml配置文件是基于Spring可扩展Schema来自定义的。通过Spring加载Dubbo配置，并且对应用没有任何侵入性，可以应用于使用Spring框架的系统中。

一、provider.xml 示例

<?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:dubbo="http://code.alibabatech.com/schema/dubbo"
     xsi:schemaLocation="http://www.springframework.org/schema/beans 
     http://www.springframework.org/schema/beans/spring-beans.xsd
     http://code.alibabatech.com/schema/dubbo 
     http://code.alibabatech.com/schema/dubbo/dubbo.xsd">  
     <dubbo:application name="hello-world-app"  />  
     <dubbo:registry address="multicast://224.5.6.7:1234" />  
     <dubbo:protocol name="dubbo" port="20880" />  
     <dubbo:service interface="com.alibaba.dubbo.demo.DemoService" ref="demoServiceLocal" />  
     <dubbo:reference id="demoServiceRemote" interface="com.alibaba.dubbo.demo.DemoService" />  
 </beans>

所有标签都支持自定义参数，用于不同扩展点实现的特殊配置，如:

<dubbo:protocol name="jms">
     <dubbo:parameter key="queue" value="your_queue" />
</dubbo:protocol>

或：

<beans xmlns="http://www.springframework.org/schema/beans"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns:dubbo="http://code.alibabatech.com/schema/dubbo"
     xmlns:p="http://www.springframework.org/schema/p"
     xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://code.alibabatech.com/schema/dubbo http://code.alibabatech.com/schema/dubbo/dubbo.xsd">  
     <dubbo:protocol name="jms" p:queue="your_queue" />  
 </beans>

dubbo:application、dubbo:registry等标签都是利用Spring的XMl扩展机制来进行解析加载的。下面看看Spring如何解析这些标签的。

二、扩展标签的解析

解析扩展的标签，主要通过配置文件和解析bean来实现。（Dubbox的xml配置是在/dubbo-config-spring模块中）

1、配置文件

• dubbo.xsd
• spring.handlers
• spring.schemas
  这三个配置文件的源文件都在/dubbo-config-spring/src/main/resources/META-INF/目录下，打包后在dubbo-2.8.4.jar\META-INF目录下可以看到这三个文件。
  dubbo.xsd定义了扩展标签的xsd文件。而spring.handlers和spring.schemas，它们必须放在META-INF目录中。Spring会默认去加载它们。加载完成后，再去加载xml配置文件时，如果xml中使用了dubbo的自定义schema时，将会使用spring.handlers配置的handler来进行解析。
  spring.handlers中是自定义命名空间与自定义解析bean的映射内容如下:

http\://code.alibabatech.com/schema/dubbo=com.alibaba.dubbo.config.spring.schema.DubboNamespaceHandler

spring.schemas中是命名空间和xsd文件的映射，内容如下:

http\://code.alibabatech.com/schema/dubbo/dubbo.xsd=META-INF/dubbo.xsd

2、xml解析的入口DubboNamespaceHandler及各个配置的解析器

在com.alibaba.dubbo.config.spring.schema包下定义了DubboNamespaceHandler和DubboBeanDefinitionParser。
public class DubboNamespaceHandler extends NamespaceHandlerSupport {

    static {
        Version.checkDuplicate(DubboNamespaceHandler.class);
    }

    public void init() {
        registerBeanDefinitionParser("application", new DubboBeanDefinitionParser(ApplicationConfig.class, true));
        registerBeanDefinitionParser("module", new DubboBeanDefinitionParser(ModuleConfig.class, true));
        registerBeanDefinitionParser("registry", new DubboBeanDefinitionParser(RegistryConfig.class, true));
        registerBeanDefinitionParser("monitor", new DubboBeanDefinitionParser(MonitorConfig.class, true));
        registerBeanDefinitionParser("provider", new DubboBeanDefinitionParser(ProviderConfig.class, true));
        registerBeanDefinitionParser("consumer", new DubboBeanDefinitionParser(ConsumerConfig.class, true));
        registerBeanDefinitionParser("protocol", new DubboBeanDefinitionParser(ProtocolConfig.class, true));
        registerBeanDefinitionParser("service", new DubboBeanDefinitionParser(ServiceBean.class, true));
        registerBeanDefinitionParser("reference", new DubboBeanDefinitionParser(ReferenceBean.class, false));
        registerBeanDefinitionParser("annotation", new DubboBeanDefinitionParser(AnnotationBean.class, true));
    }

}

"module"、"registry"等对应xsd中的element name；DubboNamespaceHandler继承了spring的NamespaceHandlerSupport，spring可以通过这个bean来解析扩展xml。

Spring启动初始化的时候会加载解析xml配置文件，BeanDefinitionParserDelegate类的parseBeanDefinitions负责解析xml中的一级节点，

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);
        }
    }

当xml元素的类型不属于spring命名空间，即是自定义的，就会执行delegate.parseCustomElement(ele);

public BeanDefinition parseCustomElement(Element ele, @Nullable BeanDefinition containingBd) {
        String namespaceUri = getNamespaceURI(ele);
        if (namespaceUri == null) {
            return null;
        }
        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));
    }

this.readerContext.getNamespaceHandlerResolver().resolve(namespaceUri)会调用DefaultNamespaceHandlerResolver的resolve，通过uri来从META-INF/spring.handlers中取得对应的解析器，实例化，然后运行init，并将这个实例保存到handlerMappings中，最后返回这个自定义handler实例。handler.parse会调用自定义的BeanDefinitionParser的pase来解析xml。

注意，dubbox的扩展点不能重复定义