Dubbo中的统一契约是如何实现的？

梦里梦外; 2021-09-07 06:03 477阅读 0赞

## 写在前面 ##

之前，很多小伙伴私信我：如何才能快速的掌握Dubbo的核心原理和源码。所以，我写了一篇《[我是如何在短期内快速掌握Dubbo的原理和源码的（纯干货）？][Dubbo]》。对于Dubbo的源码解析系列文章，我也在思考如何让源码解析的文章变得更加简单易懂，所以，我调整了写Dubbo源码解析文章的策略，力求让小伙伴们能够以更简单、易懂的方式彻底掌握Dubbo源码。今天，我们先说说Dubbo中的统一契约是如何实现的。

文章已收录到：

[https://github.com/sunshinelyz/technology-binghe][https_github.com_sunshinelyz_technology-binghe]

[https://gitee.com/binghe001/technology-binghe][https_gitee.com_binghe001_technology-binghe]

## 不得不说的URL ##

URL全称为统一资源定位符，它能够在互联网中定位到唯一的一个网络地址。URL的格式如下所示。

protocol://username:password@host:port/path?key=value&key=value

其中，各个部分的简要说明如下所示。

*  protocol：URL的协议。最常见的协议就是HTTP和HTTPS，其他的还有FTP、WS、FILE、SMTP等。
 *  username：用户名。
 *  password：密码。
 *  host：主机，通常是域名或者IP地址。
 *  port：主机的端口号。
 *  path：请求的目标文件的路径。
 *  parameters：请求的具体参数信息，这里为key=value&key=value。

这就是我们互联网中的URL的简单说明。

那么，在Dubbo内部，大量的方法接收的参数都是以URL进行封装的，那么，URL在Dubbo内部到底起到了什么作用呢？我们继续往下看。

## Dubbo中的URL ##

**总的来说，在Dubbo内部，服务提供者Provider会将自身的相关信息封装成URL注册到Zookeeper或其他注册中心中，从而对外暴露自己提供的服务。而服务消费者Consumer也会通过URL的形式向Zookeeper或其他注册中心订阅自己想要调用的服务。而在Dubbo的SPI实现中，URL又会参与扩展实现的逻辑处理。所以说，URL在Dubbo的实现中是非常重要的。也可以这么说，Dubbo中的URL就是Dubbo的统一契约。**

我们先来看一下Dubbo中的URL具体长什么样吧，通过调试Dubbo自带Provider的示例源码，我们可以看到在Dubbo中的URL如下所示。

dubbo://192.168.175.1:20880/org.apache.dubbo.demo.DemoService?anyhost=true&application=dubbo-demo-annotation-provider&deprecated=false&dubbo=2.0.2&dynamic=true&generic=false&interface=org.apache.dubbo.demo.DemoService&methods=sayHello,sayHelloAsync&pid=15012&release=&side=provider&timestamp=1610857629484

这也是Provider注册到Zookeeper或者其他注册中心的信息。各个部分的说明如下所示。

*  dubbo：使用的是dubbo协议。
 *  host：主机的IP地址为192.168.175.1。
 *  port：端口号为20880。
 *  path：这里的请求路径为：org.apache.dubbo.demo.DemoService
 *  parameters：请求的参数信息，这里为：anyhost=true&application=dubbo-demo-annotation-provider&deprecated=false&dubbo=2.0.2&dynamic=true&generic=false&interface=org.apache.dubbo.demo.DemoService&methods=sayHello,sayHelloAsync&pid=15012&release=&side=provider&timestamp=1610857629484。

既然Dubbo是向Zookeeper或其他注册中心注册这些信息的，那Dubbo内部是如何对URL进行封装的呢。

在dubbo-common模块中，有一个URL类专门用于封装URL，如下所示。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2wxMDI4Mzg2ODA0_size_16_color_FFFFFF_t_70_pic_center]

在URL类中，我们来看一个核心构造函数，如下所示。

public URL(String protocol,
               String username,
               String password,
               String host,
               int port,
               String path,
               Map<String, String> parameters,
               Map<String, Map<String, String>> methodParameters) { 
        if (StringUtils.isEmpty(username)
            && StringUtils.isNotEmpty(password)) { 
            throw new IllegalArgumentException("Invalid url, password without username!");
        }
        this.protocol = protocol;
        this.username = username;
        this.password = password;
        this.host = host;
        this.port = Math.max(port, 0);
        this.address = getAddress(this.host, this.port);
    
        // trim the beginning "/"
        while (path != null && path.startsWith("/")) { 
            path = path.substring(1);
        }
        this.path = path;
        if (parameters == null) { 
            parameters = new HashMap<>();
        } else { 
            parameters = new HashMap<>(parameters);
        }
        this.parameters = Collections.unmodifiableMap(parameters);
        this.methodParameters = Collections.unmodifiableMap(methodParameters);
    }

可以看到，Dubbo对于URL的核心封装，基本与互联网中的URL封装是一致的。

在Dubbo的dubbo-common模块提供了处理URL的工具类：URLBuilder和URLStrParser。如下所示。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2wxMDI4Mzg2ODA0_size_16_color_FFFFFF_t_70_pic_center 1]

这两个类的实现还是比较简单的，小伙伴们可以自行阅读Dubbo的源码。

接下来，我们一起来看看在Dubbo内部，URL是如何实现统一契约的？

## Dubbo中URL的实际应用 ##

这里，我们主要通过三方面来简单聊聊URL在Dubbo内部的实际应用：

*  URL在SPI中的应用。
 *  URL在服务注册中的应用。
 *  URL在服务发现中的应用。

### URL在SPI中的应用 ###

稍微了解过Dubbo的小伙伴都知道，Dubbo具有高度的可扩展性，而这种扩展性是基于Dubbo自身的SPI来实现的。在Dubbo实现的SPI中，URL又起到了非常重要的作用。

在Dubbo SPI的实现中，一个典型的场景就是被@Adaptive注解修饰的接口方法，例如，在dubbo-registry-api 模块中的RegistryFactory接口中的getRegistry()方法上被@Adaptive(\{“protocol”\})注解修饰。如下所示。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2wxMDI4Mzg2ODA0_size_16_color_FFFFFF_t_70_pic_center 2]

说明RegistryFactory接口中的getRegistry()方法是一个适配器方法，Dubbo在运行的过程中，会为getRegistry()方法动态生成`RegistryFactory$Adaptive`类型。例如，生成的`RegistryFactory$Adaptive`类型如下所示。

public class RegistryFactory$Adaptive
                  implements RegistryFactory {  
        public Registry getRegistry(org.apache.dubbo.common.URL arg0) {  
            if (arg0 == null) throw new IllegalArgumentException(""); 
            org.apache.dubbo.common.URL url = arg0; 
            String extName = (url.getProtocol() == null ? "dubbo" :  url.getProtocol()); 
            if (extName == null) 
                throw new IllegalStateException(""); 
            RegistryFactory extension = (RegistryFactory) ExtensionLoader.getExtensionLoader(RegistryFactory.class).getExtension(extName); 
            return extension.getRegistry(arg0); 
        } 
    }

这段代码相对来说还是比较容易理解的，生成的RegistryFactory$Adaptive会自动实现getRegistry()方法，在getRegistry()方法中，会获取URL中的protocol参数来确定URL的协议，如果获取的protocol为空，则使用默认的dubbo协议，有了这个协议，就能够通过SPI动态加载具体的扩展实现类。

我们在Dubbo的dubbo-registry-api模块中找到RegistryProtocol类，如下所示。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2wxMDI4Mzg2ODA0_size_16_color_FFFFFF_t_70_pic_center 3]

找到其中的getRegistry()方法并打上断点，如下所示。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2wxMDI4Mzg2ODA0_size_16_color_FFFFFF_t_70_pic_center 4]

接下来，debug启动Dubbo的Provider示例，如下所示。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2wxMDI4Mzg2ODA0_size_16_color_FFFFFF_t_70_pic_center 5]

可以看到，此时使用的protocol协议为zookeeper。有关Dubbo中SPI的实现，我们后面再详细剖析，今天，小伙伴们有个大致的了解即可。

### URL在服务注册中的应用 ###

在Dubbo中的服务注册实现中，URL同样起到了非常重要的作用。这里，我使用的注册中心是Zookeeper，所以，我们在dubbo-registry-zookeeper模块中找到ZookeeperRegistry类，如下所示。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2wxMDI4Mzg2ODA0_size_16_color_FFFFFF_t_70_pic_center 6]

找到其中的doRegister()方法，打上断点，如下所示。

![在这里插入图片描述][2021011720344271.png_pic_center]

debug启动Dubbo自带的provider示例，如下所示。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2wxMDI4Mzg2ODA0_size_16_color_FFFFFF_t_70_pic_center 7]

可以看到，在注册到Zookeeper中的URL中，包含了protocol协议、host主机名、port端口号、path请求路径，parameters参数等信息。

### URL在服务发现中的应用 ###

Dubbo中服务的消费者Consumer在启动时，会向Zookeeper注册中心订阅自身需要调用的服务，那具体是如何通过URL订阅的呢？我们同样在dubbo-registry-zookeeper模块中的ZookeeperRegistry类中找到doSubscribe()方法。在doSubscribe()方法中打上断点，如下所示。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2wxMDI4Mzg2ODA0_size_16_color_FFFFFF_t_70_pic_center 8]

启动Dubbo自带的Consumer示例，如下所示。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2wxMDI4Mzg2ODA0_size_16_color_FFFFFF_t_70_pic_center 9]

我们可以看到，Dubbo的Consumer会向Zookeeper传入如下参数进行服务的订阅操作。

consumer://192.168.175.1/org.apache.dubbo.demo.DemoService?application=dubbo-demo-annotation-consumer&category=providers,configurators,routers&dubbo=2.0.2&init=false&interface=org.apache.dubbo.demo.DemoService&methods=sayHello,sayHelloAsync&pid=15184&side=consumer&sticky=false&timestamp=1610860963037

其中的protocol为consumer，表示订阅协议。category表示要订阅的分类，这里是providers,configurators,routers三个分类。interface表示要订阅的接口服务，这里是org.apache.dubbo.demo.DemoService。methods表示要订阅的方法，这里是sayHello,sayHelloAsync。

**还有一点需要注意的是：在服务注册的过程中，Dubbo会将URL转化为Zookeeper路径将信息注册到Zookeeper中；在服务发现的过程中，Dubbo会将URL转化为Zookeeper路径，从而监听Zookeeper目录的变化来订阅相关的服务。**

总之，在Dubbo内部通过URL实现了统一的契约。你学会了吗？

## 推荐阅读 ##

*  [冰河开始对Dubbo下手了！][Dubbo 1]
 *  [俯瞰Dubbo全局，阅读源码前必须掌握这些！！][Dubbo 2]
 *  [我是如何在短期内快速掌握Dubbo的原理和源码的（纯干货）？][Dubbo]

**好了，今天就到这儿吧，我是冰河，大家有啥问题可以在下方留言，也可以加我微信：sun\_shine\_lyz，一起交流技术，一起进阶，一起牛逼~~**

[Dubbo]: https://mp.weixin.qq.com/s?__biz=Mzg4MjU0OTM1OA==&mid=2247490192&idx=1&sn=afedf86349f76c864f42b2b48a245c62&chksm=cf55ad91f8222487088c333cb7160dd63496f9754c5533dbc868d9ac875101cc67dc1483c0da&token=1511921100&lang=zh_CN#rd
[https_github.com_sunshinelyz_technology-binghe]: https://github.com/sunshinelyz/technology-binghe
[https_gitee.com_binghe001_technology-binghe]: https://gitee.com/binghe001/technology-binghe
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2wxMDI4Mzg2ODA0_size_16_color_FFFFFF_t_70_pic_center]: /images/20210901/b185f6d9ecfd4b66b9b1f8447ee5cba5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2wxMDI4Mzg2ODA0_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20210901/5e2921717b4c4dbc904ca9a786d6feb8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2wxMDI4Mzg2ODA0_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20210901/87fb9d4b7dbc413899ac7ef26b423c14.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2wxMDI4Mzg2ODA0_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20210901/a2e998c081fd494d8437d34ff096f4b9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2wxMDI4Mzg2ODA0_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20210901/3de5215cb8cf4173beb0015997a7a4c0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2wxMDI4Mzg2ODA0_size_16_color_FFFFFF_t_70_pic_center 5]: /images/20210901/f3f9ab184c6545c3b87953b1b07b193f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2wxMDI4Mzg2ODA0_size_16_color_FFFFFF_t_70_pic_center 6]: /images/20210901/6210047cd9a740659cb0cb12a5c97f14.png
[2021011720344271.png_pic_center]: /images/20210901/a20cedf2603c49af9af841a0bd201307.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2wxMDI4Mzg2ODA0_size_16_color_FFFFFF_t_70_pic_center 7]: /images/20210901/35ceb7fddee34ecaa42ef4976b6a4667.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2wxMDI4Mzg2ODA0_size_16_color_FFFFFF_t_70_pic_center 8]: /images/20210901/cc002c2cac84467190d13ce0857f085b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2wxMDI4Mzg2ODA0_size_16_color_FFFFFF_t_70_pic_center 9]: /images/20210901/1cc85e28e6b64b5ba9f35fd76dddb180.png
[Dubbo 1]: https://mp.weixin.qq.com/s?__biz=Mzg4MjU0OTM1OA==&mid=2247489794&idx=1&sn=aa9efb732ac7fe3d2bc927c1491cae57&chksm=cf55ae03f82227157bb69cb487df2081b5b623d173b1df603be66347692acec56d455da6aae1&token=1511921100&lang=zh_CN#rd
[Dubbo 2]: https://mp.weixin.qq.com/s?__biz=Mzg4MjU0OTM1OA==&mid=2247489831&idx=1&sn=e1126303a91f8fccb6154196695c5e6e&chksm=cf55ae26f82227302f71ced14c0aa312f631c8f03df65650dd3a49dc7fa9f339685342c38f5a&token=1511921100&lang=zh_CN#rd