源码分析Dubbo前置篇-寻找注册中心、服务提供者、服务消费者功能入口

傷城~ 2022-05-22 10:42 136阅读 0赞

本节主要阐述如下两个问题：   
1、Dubbo自定义标签实现。   
2、dubbo通过Spring加载配置文件后，是如何触发注册中心、服务提供者、服务消费者按照Dubbo的设计执行相关的功能。   
所谓的执行相关功能如下：   
1）注册中心启动，监听消息提供者的注册服务、接收消息消费者的服务订阅（服务注册与发现机制）。   
2）服务提供者向注册中心注册服务。   
3）服务消费者向注册中心订阅服务。

接下来从使用dubbo的角度，从配置文件入手：   
1、Dubbo服务提供者的一般配置如下：

<dubbo:application name="uop" owner="uce"/>
    
    <dubbo:registry protocol="zookeeper" address="zookeeper://192.168.xx.xx:2181?backup=192.168.xx.xx:2182,192.168.xx.xx:2183" />
    
    <dubbo:protocol name="dubbo" serialization="kryo" port="20990" />
    
    <dubbo:provider timeout="5000" threadpool="fixed" threads="100" accepts="1000" token="true"/>
    
    
    <dubbo:service interface="com.yingjun.dubbox.api.UserService" ref="userService" />

上面通过dubbo提供的dubbo:application、dubbo:registry、dubbo:protocol、dubbo:provider、dubbo:service分别定义dubbo应用程序名、注册中心、协议、服务提供者参数默认值、服务提供者，这些配置后面的实现原理是什么呢？是如何启动并发挥相关作用的呢？

2、Spring自定义标签即命令空间实现   
dubbo自定义标签与命名空间其实现代码在模块dubbo-config中，其核心实现如下：   
2.1 DubboNamespaceHandler   
dubbo命名空间实现handler，其全路径：com.alibaba.dubbo.config.spring.schema.DubboNamespaceHandler，其源码实现如下：

public class DubboNamespaceHandler extends NamespaceHandlerSupport { 
    
        static {
            Version.checkDuplicate(DubboNamespaceHandler.class);
        }
    
        @Override
        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 AnnotationBeanDefinitionParser());
        }
    }

从这里可以看出，dubbo自定义的标签主要包括：application、module、registry、monitor、provider、consumer、protocol、service、reference、annotation，其具体解析实现类主要包括：DubboBeanDefinitionParser(基于xml配置文件)、AnnotationBeanDefinitionParser(基于注解)，下文会详细分析上述两个解析类的实现。

2.2 定义dubbo.xsd 文件   
在dubbo-config-spring模块下的 src/main/resouce/META-INF中分别定义dubbo.xsd、spring.handlers、spring.schemas。   
关于Spring如何新增命名空间与标签，在源码分析ElasticJob时已经详细介绍过，再这里就不做 过多重复，如需了解，请查看：[https://blog.csdn.net/prestigeding/article/details/79751023][https_blog.csdn.net_prestigeding_article_details_79751023]

3、Bean解析机制(Spring基础知识)   
我们应该知道，Spirng的配置支持xml配置文件与注解的方式,故Dubbo也支持两种配置方式，xml与注解方式。   
3.1 xml配置方式解析   
![这里写图片描述][70]   
BeanDefinitionParser：Spring定义的bean解析器，要实现自定义标签，则需要实现该接口，然后通过NamespaceHandlerSupport将Bean定义解析器注册到Spring bean解析器中。从接口中可以看出，其终极目标就是将Element element(xml节点)解析成BeanDefinition，有关于Spring BeanDefinition，请参考：[https://mp.csdn.net/mdeditor/80490206][https_mp.csdn.net_mdeditor_80490206]   
DubboBeanDefinitionParser构造函数如下：

public DubboBeanDefinitionParser(Class<?> beanClass, boolean required) {
            this.beanClass = beanClass;
            this.required = required;
    }

beanClass：该xml标签节点最终会被Spring实例化的类名。   
required：该标签的ID是否必须。

<table style="border-spacing:0px;width:852px;text-align:center;color:rgb(51,51,51);font-family:'-apple-system', 'SF UI Text', Arial, 'PingFang SC', 'Hiragino Sans GB', 'Microsoft YaHei', 'WenQuanYi Micro Hei', sans-serif, SimHei, SimSun;font-size:14px;background-color:rgb(255,255,255);"> 
 <thead> 
  <tr> 
   <th style="vertical-align:middle;">标签名称</th> 
   <th align="center" style="vertical-align:middle;">类名</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="vertical-align:middle;">dubbo:application</td> 
   <td align="center" style="vertical-align:middle;">ApplicationConfig</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">dubbo:module</td> 
   <td align="center" style="vertical-align:middle;">ModuleConfig</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">dubbo:registry</td> 
   <td align="center" style="vertical-align:middle;">RegistryConfig</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">dubbo:monitor</td> 
   <td align="center" style="vertical-align:middle;">MonitorConfig</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">dubbo:provider</td> 
   <td align="center" style="vertical-align:middle;">ProviderConfig</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">dubbo:consumer</td> 
   <td align="center" style="vertical-align:middle;">ConsumerConfig</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">dubbo:protocol</td> 
   <td align="center" style="vertical-align:middle;">ProtocolConfig</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">dubbo:service</td> 
   <td align="center" style="vertical-align:middle;">ServiceBean</td> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">dubbo:reference</td> 
   <td align="center" style="vertical-align:middle;">ReferenceBean</td> 
  </tr> 
 </tbody> 
</table>

注，包名：com.alibaba.dubbo.config   
bean解析器的主要目的就是将上述标签，解析成对应的BeanDifinition，以便Spring构建上述类的实例。   
本节不拷贝DubboBeanDefinitionParser根据xml定义的标签与属性转换成BeanDefinitionParser的每一行代码，本节只给出其大体关键点。   
Step1：解析id属性，如果DubboBeanDefinitionParser对象的required属性为true，如果id为空，则根据如下规则构建一个id。   
1）如果name属性不为空，则取name的值，如果已存在，则为 name + 序号,例如 name,name1,name2。   
2）如果name属性为空，如果是dubbo:protocol标签，则取protocol属性，其他的则取interface属性，如果不为空，则取该值，但如果已存在，和name处理相同，在后面追加序号。   
3）如果第二步还未空，则取beanClass的名称，如果已存在，则追加序号。   
Step2：根据不同的标签解析特殊属性。   
1）dubbo:protocol,添加protocol属性(BeanDefinition)。   
2）dubbo:service,添加ref属性。   
3）dubbo:provider，嵌套解析,dubbo:provider标签有两个可选的子标签,dubbo:service、dubbo:parameter,这里需要嵌套解析dubbo:service标签   
知识点：   
dubbo:provider是配置服务提供者的默认参数，在dubbo spring配置文件中可以配置多个dubbo:provider,那dubbo:service标签如何选取一个合适的dubbo:provider作为其默认参数   
呢？有两种办法，其一：将dubbo:service标签直接声明在dubbo:provider方法，其二，在dubbo:service中通过provider属性指定一个provider配置，如果不填，并且存在多个dubbo:provider配置，则会抛出错误。   
provider配置。   
4）dubbo:customer：解析嵌套标签，其原理与dubbo:provider解析一样。   
Step3：解析标签，将属性与值填充到BeanDefinition的propertyValues中。   
最终返回BeanDefinition实例，供Spring实例化Bean。

上述已经解答了Dubbo自定义标签的解析实现，其实就完成了ApplicationConfig、RegistryConfig、ServiceBean、ReferenceBean实例的初始化，那什么时候构建与注册中心的连接、服务提供者什么时候会向注册中心注册服务，服务消费者向注册中心订阅服务呢？

通过上述步骤，我们已经知道已经成功解析注册中心、服务提供者、服务消费者的配置元信息，并将其实例化，按照我们的思路，配置对象生成后，下一步应该是实现Dubbo服务的注册与发现机制，但代码中无法找到相关代码。   
据我目前所掌握的知识，Spring在对象实例化，一般有两种方式来对Bean做一些定制化处理。   
1、实现BeanPostProcessor Spring后置处理器，在Bean初始化前后执行相关操作。   
2、Bean实现InitializingBean接口(init-method)   
浏览表格中所有Bean的声明，发现了两个类非常特殊：   
![这里写图片描述][70 1]  
ServiceBean(服务提供者)与ReferenceBean(服务消费者)比较特殊，实现了Spring与Bean生命周期相关的接口。   
InitializingBean，其声明的接口为afterPropertiesSet方法，顾名思义，就是在bean初始化所有属性之后调用。   
DisposableBean：其声明的接口为destroy()方法，在Spring BeanFactory销毁一个单例实例之前调用。   
ApplicationContextAware：其声明的接口为void setApplicationContext(ApplicationContext applicationContext)，实现了该接口，Spring容器在初始化Bean时会调用该方法，注入ApplicationContext，已方便该实例可以直接调用applicationContext获取其他Bean。   
ApplicationListener：容器重新刷新时执行事件函数。   
BeanNameAware：其声明的接口为：void setBeanName(String name)，实现该接口的Bean，其实例可以获取该实例在BeanFactory的id或name。   
FactoryBean：Spring初始化Bean的另外一种方式，例如dubbo:reference，需要返回的对象并不是ReferenceBean,而是要返回ref指定的代理类来执行业务操作，故这里使用FactoryBean非常合适，FactoryBean定义了如下三个方法：   
1）T getObject() throws Exception：获取需要返回的结果对象。

2）Class

转载自[https://blog.csdn.net/prestigeding/article/details/80490338][https_blog.csdn.net_prestigeding_article_details_80490338]

[https_blog.csdn.net_prestigeding_article_details_79751023]: https://blog.csdn.net/prestigeding/article/details/79751023
[70]: /images/20220522/f812b882f1024c4ca07c5fcb49e0bb96.png
[https_mp.csdn.net_mdeditor_80490206]: https://mp.csdn.net/mdeditor/80490206
[70 1]: /images/20220522/f89576e4b46d42d1bd13f1f7902eb530.png
[https_blog.csdn.net_prestigeding_article_details_80490338]: https://blog.csdn.net/prestigeding/article/details/80490338