Dubbo源码学习--注册中心（一）

红太狼 2022-05-29 10:48 157阅读 0赞

目前Dubbo官方提供的注册中心有Multicast、Zookeeper、Redis和Simple注册中心，官方推荐使用Zookeeper作为生产环境的注册中心。

Dubbo官方也提供了扩展机制，开发人员可以根据自己的需要遵守一定的扩展规范开发自己的注册中心，扩展接口主要有如下几个接口：

*  `com.alibaba.dubbo.registry.RegistryFactory`
 *  `com.alibaba.dubbo.registry.Registry`
 *  `com.alibaba.dubbo.registry.NotifyListener`

扩展约定：

RegistryFactory.java：

public interface RegistryFactory {
 /**
 * 连接注册中心.
 * 
 * 连接注册中心需处理契约： 
 * 1. 当设置check=false时表示不检查连接，否则在连接不上时抛出异常。 
 * 2. 支持URL上的username:password权限认证。 
 * 3. 支持backup=10.20.153.10备选注册中心集群地址。 
 * 4. 支持file=registry.cache本地磁盘文件缓存。 
 * 5. 支持timeout=1000请求超时设置。 
 * 6. 支持session=60000会话超时或过期设置。 
 * 
 * @param url 注册中心地址，不允许为空
 * @return 注册中心引用，总不返回空
 */
 Registry getRegistry(URL url); 
 }

Registry接口继承了RegistryService接口：

public interface RegistryService { // Registry extends RegistryService 
 /**
 * 注册服务.
 * 
 * 注册需处理契约： 
 * 1. 当URL设置了check=false时，注册失败后不报错，在后台定时重试，否则抛出异常。 
 * 2. 当URL设置了dynamic=false参数，则需持久存储，否则，当注册者出现断电等情况异常退出时，需自动删除。 
 * 3. 当URL设置了category=overrides时，表示分类存储，缺省类别为providers，可按分类部分通知数据。 
 * 4. 当注册中心重启，网络抖动，不能丢失数据，包括断线自动删除数据。 
 * 5. 允许URI相同但参数不同的URL并存，不能覆盖。 
 * 
 * @param url 注册信息，不允许为空，如：dubbo://10.20.153.10/com.alibaba.foo.BarService?version=1.0.0&application=kylin
 */
 void register(URL url);
 
 /**
 * 取消注册服务.
 * 
 * 取消注册需处理契约： 
 * 1. 如果是dynamic=false的持久存储数据，找不到注册数据，则抛IllegalStateException，否则忽略。 
 * 2. 按全URL匹配取消注册。 
 * 
 * @param url 注册信息，不允许为空，如：dubbo://10.20.153.10/com.alibaba.foo.BarService?version=1.0.0&application=kylin
 */
 void unregister(URL url);
 
 /**
 * 订阅服务.
 * 
 * 订阅需处理契约： 
 * 1. 当URL设置了check=false时，订阅失败后不报错，在后台定时重试。 
 * 2. 当URL设置了category=overrides，只通知指定分类的数据，多个分类用逗号分隔，并允许星号通配，表示订阅所有分类数据。 
 * 3. 允许以interface,group,version,classifier作为条件查询，如：interface=com.alibaba.foo.BarService&version=1.0.0 
 * 4. 并且查询条件允许星号通配，订阅所有接口的所有分组的所有版本，或：interface=*&group=*&version=*&classifier=* 
 * 5. 当注册中心重启，网络抖动，需自动恢复订阅请求。 
 * 6. 允许URI相同但参数不同的URL并存，不能覆盖。 
 * 7. 必须阻塞订阅过程，等第一次通知完后再返回。 
 * 
 * @param url 订阅条件，不允许为空，如：consumer://10.20.153.10/com.alibaba.foo.BarService?version=1.0.0&application=kylin
 * @param listener 变更事件监听器，不允许为空
 */
 void subscribe(URL url, NotifyListener listener);
 
 /**
 * 取消订阅服务.
 * 
 * 取消订阅需处理契约： 
 * 1. 如果没有订阅，直接忽略。 
 * 2. 按全URL匹配取消订阅。 
 * 
 * @param url 订阅条件，不允许为空，如：consumer://10.20.153.10/com.alibaba.foo.BarService?version=1.0.0&application=kylin
 * @param listener 变更事件监听器，不允许为空
 */
 void unsubscribe(URL url, NotifyListener listener);
 
 /**
 * 查询注册列表，与订阅的推模式相对应，这里为拉模式，只返回一次结果。
 * 
 * @see com.alibaba.dubbo.registry.NotifyListener#notify(List)
 * @param url 查询条件，不允许为空，如：consumer://10.20.153.10/com.alibaba.foo.BarService?version=1.0.0&application=kylin
 * @return 已注册信息列表，可能为空，含义同{@link com.alibaba.dubbo.registry.NotifyListener#notify(List<URL>)}的参数。
 */
 List<URL> lookup(URL url);
 
 }

NotifyListener.java

public interface NotifyListener { 
 /**
 * 当收到服务变更通知时触发。
 * 
 * 通知需处理契约： 
 * 1. 总是以服务接口和数据类型为维度全量通知，即不会通知一个服务的同类型的部分数据，用户不需要对比上一次通知结果。 
 * 2. 订阅时的第一次通知，必须是一个服务的所有类型数据的全量通知。 
 * 3. 中途变更时，允许不同类型的数据分开通知，比如：providers, consumers, routes, overrides，允许只通知其中一种类型，但该类型的数据必须是全量的，不是增量的。 
 * 4. 如果一种类型的数据为空，需通知一个empty协议并带category参数的标识性URL数据。 
 * 5. 通知者(即注册中心实现)需保证通知的顺序，比如：单线程推送，队列串行化，带版本对比。 
 * 
 * @param urls 已注册信息列表，总不为空，含义同{@link com.alibaba.dubbo.registry.RegistryService#lookup(URL)}的返回值。
 */
 void notify(List<URL> urls);
 
 }

官方给出的扩展示例：

Maven项目结构：

XxxRegistryFactory.java：

package com.xxx;
    
    import com.alibaba.dubbo.registry.RegistryFactory;
    import com.alibaba.dubbo.registry.Registry;
    import com.alibaba.dubbo.common.URL;
    
    public class XxxRegistryFactory implements RegistryFactory {
        public Registry getRegistry(URL url) {
            return new XxxRegistry(url);
        }
    }

XxxRegistry.java：

package com.xxx;
    
    import com.alibaba.dubbo.registry.Registry;
    import com.alibaba.dubbo.registry.NotifyListener;
    import com.alibaba.dubbo.common.URL;
    
    public class XxxRegistry implements Registry {
        public void register(URL url) {
            // ...
        }
        public void unregister(URL url) {
            // ...
        }
        public void subscribe(URL url, NotifyListener listener) {
            // ...
        }
        public void unsubscribe(URL url, NotifyListener listener) {
            // ...
        }
    }

META-INF/dubbo/com.alibaba.dubbo.registry.RegistryFactory：

xxx=com.xxx.XxxRegistryFactory