[Dubbo3.0.8源码解析系列]-13-Dubbo的三大中心之元数据中心源码解析

13-Dubbo的三大中心之元数据中心源码解析

13.1 简介

关于元数据中心的概念对于大部分用户来说是比较陌生的,配置中心的话我们还好理解,对于元数据中心是什么,我们来看下我从官网拷贝过来的一段文字:

元数据中心在2.7.x版本开始支持，随着应用级别的服务注册和服务发现在Dubbo中落地，元数据中心也变的越来越重要。在以下几种情况下会需要部署元数据中心：

• 对于一个原先采用老版本Dubbo搭建的应用服务，在迁移到Dubbo 3时，Dubbo 3 会需要一个元数据中心来维护RPC服务与应用的映射关系（即接口与应用的映射关系），因为如果采用了应用级别的服务发现和服务注册，在注册中心中将采用“应用 —— 实例列表”结构的数据组织形式，不再是以往的“接口 —— 实例列表”结构的数据组织形式，而以往用接口级别的服务注册和服务发现的应用服务在迁移到应用级别时，得不到接口与应用之间的对应关系，从而无法从注册中心得到实例列表信息，所以Dubbo为了兼容这种场景，在Provider端启动时，会往元数据中心存储接口与应用的映射关系。
• 为了让注册中心更加聚焦与地址的发现和推送能力，减轻注册中心的负担，元数据中心承载了所有的服务元数据、大量接口/方法级别配置信息等，无论是接口粒度还是应用粒度的服务发现和注册，元数据中心都起到了重要的作用。

如果有以上两种需求，都可以选择部署元数据中心，并通过Dubbo的配置来集成该元数据中心。

元数据中心并不依赖于注册中心和配置中心，用户可以自由选择是否集成和部署元数据中心，如下图所示：

该图中不配备配置中心，意味着可以不需要全局管理配置的能力。该图中不配备注册中心，意味着可能采用了Dubbo mesh的方案，也可能不需要进行服务注册，仅仅接收直连模式的服务调用。
官网参考文章地址:

• 部署架构（注册中心 配置中心 元数据中心
• 元数据参考手册

综上所述可以用几句话概括下:

• 元数据中心来维护RPC服务与应用的映射关系（即接口与应用的映射关系）来兼容接口与应用之间的对应关系
• 让注册中心更加聚焦与地址的发现和推送能力

注册中心的启动是在DefaultApplicationDeployer中的初始化方法 initialize() 中:如下所示

这里只看下 startMetadataCenter();方法即可

@Overridepublicvoidinitialize(){if(initialized){return;}// Ensure that the initialization is completed when concurrent callssynchronized(startLock){if(initialized){return;}// register shutdown hookregisterShutdownHook();startConfigCenter();loadApplicationConfigs();initModuleDeployers();// @since 2.7.8startMetadataCenter();

            initialized =true;if(logger.isInfoEnabled()){
                logger.info(getIdentifier()+" has been initialized!");}}}

13.2 深入探究元数据中心的启动过程

13.2.1 启动元数据中心的代码全貌

关于元数据中心我们看下 startMetadataCenter()方法来大致了解下整个流程

privatevoidstartMetadataCenter(){//如果未配置元数据中心的地址等配置则使用注册中心的地址等配置做为元数据中心的配置useRegistryAsMetadataCenterIfNecessary();//获取应用的配置信息ApplicationConfig applicationConfig =getApplication();//元数据配置类型 元数据类型， local 或 remote,，如果选择远程，则需要进一步指定元数据中心String metadataType = applicationConfig.getMetadataType();// FIXME, multiple metadata config support.//查询元数据中心的地址等配置Collection<MetadataReportConfig> metadataReportConfigs = configManager.getMetadataConfigs();if(CollectionUtils.isEmpty(metadataReportConfigs)){//这个就是判断 如果选择远程，则需要进一步指定元数据中心 否则就抛出来异常if(REMOTE_METADATA_STORAGE_TYPE.equals(metadataType)){thrownewIllegalStateException("No MetadataConfig found, Metadata Center address is required when 'metadata=remote' is enabled.");}return;}//MetadataReport实例的存储库对象获取MetadataReportInstance metadataReportInstance = applicationModel.getBeanFactory().getBean(MetadataReportInstance.class);List<MetadataReportConfig> validMetadataReportConfigs =newArrayList<>(metadataReportConfigs.size());for(MetadataReportConfig metadataReportConfig : metadataReportConfigs){ConfigValidationUtils.validateMetadataConfig(metadataReportConfig);
            validMetadataReportConfigs.add(metadataReportConfig);}//初始化元数据
        metadataReportInstance.init(validMetadataReportConfigs);//MetadataReport实例的存储库对象初始化失败则抛出异常if(!metadataReportInstance.inited()){thrownewIllegalStateException(String.format("%s MetadataConfigs found, but none of them is valid.", metadataReportConfigs.size()));}}

13.2.2 元数据中心未配置则使用注册中心配置

前面在说配置中心的时候有说过配置中心如果未配置会使用注册中心的地址等信息作为默认配置,这里元数据做了类似的操作:如代码:
DefaultApplicationDeployer类型的 useRegistryAsMetadataCenterIfNecessary()方法

privatevoiduseRegistryAsMetadataCenterIfNecessary(){//配置缓存中查询元数据配置Collection<MetadataReportConfig> metadataConfigs = configManager.getMetadataConfigs();//配置存在则直接返回if(CollectionUtils.isNotEmpty(metadataConfigs)){return;}查询是否有注册中心设置了默认配置isDefault 设置为true的注册中心则为默认注册中心列表,如果没有注册中心设置为默认注册中心,则获取所有未设置默认配置的注册中心列表List<RegistryConfig> defaultRegistries = configManager.getDefaultRegistries();if(defaultRegistries.size()>0){//多注册中心遍历
            defaultRegistries
                .stream()//筛选符合条件的注册中心 (筛选逻辑就是查看是否有对应协议的扩展支持).filter(this::isUsedRegistryAsMetadataCenter)//注册中心配置映射为元数据中心  映射就是获取需要的配置.map(this::registryAsMetadataCenter)//将元数据中心配置存储在配置缓存中方便后续使用.forEach(metadataReportConfig ->{if(metadataReportConfig.getId()==null){Collection<MetadataReportConfig> metadataReportConfigs = configManager.getMetadataConfigs();if(CollectionUtils.isNotEmpty(metadataReportConfigs)){for(MetadataReportConfig existedConfig : metadataReportConfigs){if(existedConfig.getId()==null&& existedConfig.getAddress().equals(metadataReportConfig.getAddress())){return;}}}
                        configManager.addMetadataReport(metadataReportConfig);}else{Optional<MetadataReportConfig> configOptional = configManager.getConfig(MetadataReportConfig.class, metadataReportConfig.getId());if(configOptional.isPresent()){return;}
                        configManager.addMetadataReport(metadataReportConfig);}
                    logger.info("use registry as metadata-center: "+ metadataReportConfig);});}}

这个代码有些细节就不细说了 我们概括下顺序梳理下思路:

• 配置缓存中查询元数据配置,配置存在则直接返回
• 查询所有可用的默认注册中心列表 - 多注册中心遍历- 选符合条件的注册中心 (筛选逻辑就是查看是否有对应协议的扩展支持)- 注册中心配置RegistryConfig映射转换为元数据中心配置类型MetadataReportConfig 映射就是获取需要的配置- 将元数据中心配置存储在配置缓存中方便后续使用

元数据的配置可以参考官网:元数据参考手册

这里主要看下可配置项有哪些 对应类型为MetadataReportConfig 在官网暂时未找到合适的文档,这里整理下属性列表方便后续配置说明查看:
配置变量类型说明idString配置idprotocolString元数据协议addressString元数据中心地址portInteger元数据中心端口usernameString元数据中心认证用户名passwordString元数据中心认证密码timeoutInteger元数据中心的请求超时（毫秒）groupString该组将元数据保存在中。它与注册表相同parametersMap<String, String>自定义参数retryTimesInteger重试次数retryPeriodInteger重试间隔cycleReportBoolean默认情况下， 是否每天重复存储完整的元数据syncReportBooleanSync or Async report.clusterBoolean需要群集支持，默认为falseregistryString注册表配置idfileString元数据报告文件存储位置checkBoolean连接到元数据中心时要应用的失败策略

13.2.3 元数据中心的初始化逻辑

13.2.3.1 元数据中心的初始化调用逻辑

主要看这一行比较重要的逻辑:

//初始化元数据
 metadataReportInstance.init(validMetadataReportConfigs);

在了解这一行逻辑之前我们先来看下元数据相关联的类型:

MetadataReportInstance中的初始化方法init

publicvoidinit(List<MetadataReportConfig> metadataReportConfigs){//CAS判断是否有初始化过if(!init.compareAndSet(false,true)){return;}//元数据类型配置如果未配置则默认为local this.metadataType = applicationModel.getApplicationConfigManager().getApplicationOrElseThrow().getMetadataType();if(metadataType ==null){this.metadataType = DEFAULT_METADATA_STORAGE_TYPE;}//获取MetadataReportFactory 工厂类型MetadataReportFactory metadataReportFactory = applicationModel.getExtensionLoader(MetadataReportFactory.class).getAdaptiveExtension();//多元数据中心初始化for(MetadataReportConfig metadataReportConfig : metadataReportConfigs){init(metadataReportConfig, metadataReportFactory);}}privatevoidinit(MetadataReportConfig config,MetadataReportFactory metadataReportFactory){//配置转urlURL url = config.toUrl();if(METADATA_REPORT_KEY.equals(url.getProtocol())){String protocol = url.getParameter(METADATA_REPORT_KEY, DEFAULT_DIRECTORY);
            url =URLBuilder.from(url).setProtocol(protocol).setScopeModel(config.getScopeModel()).removeParameter(METADATA_REPORT_KEY).build();}
        url = url.addParameterIfAbsent(APPLICATION_KEY, applicationModel.getCurrentConfig().getName());String relatedRegistryId =isEmpty(config.getRegistry())?(isEmpty(config.getId())? DEFAULT_KEY : config.getId()): config.getRegistry();//从元数据工厂中获取元数据MetadataReport metadataReport = metadataReportFactory.getMetadataReport(url);//缓存元数据到内存if(metadataReport !=null){
            metadataReports.put(relatedRegistryId, metadataReport);}}

关于元数据的初始化我们主要看两个位置:

• 一个是元数据工厂对象的创建与初始化MetadataReportFactory
• 一个是元数据对象的创建与初始化MetadataReport

13.2.3.2 元数据工厂对象MetadataReportFactory

关于元数据工厂类型MetadataReportFactory,元数据工厂 用于创建与管理元数据对象, 相关类型如下:

我们这里主要以为Zookeeper扩展的元数据工厂ZookeeperMetadataReportFactory类型为例子:
实现类型逻辑不复杂,这里就直接贴代码看看:

publicclassZookeeperMetadataReportFactoryextendsAbstractMetadataReportFactory{//与Zookeeper交互的传输器privateZookeeperTransporter zookeeperTransporter;//应用程序模型privateApplicationModel applicationModel;publicZookeeperMetadataReportFactory(ApplicationModel applicationModel){this.applicationModel = applicationModel;this.zookeeperTransporter =ZookeeperTransporter.getExtension(applicationModel);}@DisableInjectpublicvoidsetZookeeperTransporter(ZookeeperTransporter zookeeperTransporter){this.zookeeperTransporter = zookeeperTransporter;}@OverridepublicMetadataReportcreateMetadataReport(URL url){returnnewZookeeperMetadataReport(url, zookeeperTransporter);}}

元数据工厂的实现比较简单

• 继承抽象的元数据工厂AbstractMetadataReportFactory
• 实现工厂方法createMetadataReport来创建一个元数据操作类型

如果我们想要实现一个元数据工厂扩展可以参考Zookeeper的这个方式

13.2.3.3 元数据操作对象MetadataReport的创建与初始化

前面的从元数据工厂中获取元数据操作对象的逻辑处理代码如下:

//从元数据工厂中获取元数据 ,url对象可以理解为配置MetadataReport metadataReport = metadataReportFactory.getMetadataReport(url);

关于元数据对象,用于元数据信息的增删改查等逻辑的操作与元数据信息的缓存

我们这里还是以Zookeeper的实现ZookeeperMetadataReportFactory类型做为参考:

我们先来看这个逻辑

//从元数据工厂中获取元数据 ,url对象可以理解为配置MetadataReport metadataReport = metadataReportFactory.getMetadataReport(url);

ZookeeperMetadataReportFactory的父类型AbstractMetadataReportFactory中的getMetadataReport方法如下:

@OverridepublicMetadataReportgetMetadataReport(URL url){//url值参考例子zookeeper://127.0.0.1:2181?application=dubbo-demo-api-provider&client=&port=2181&protocol=zookeeper//如果存在export则移除
        url = url.setPath(MetadataReport.class.getName()).removeParameters(EXPORT_KEY, REFER_KEY);//生成元数据缓存key 元数据维度 地址+名字 //如: zookeeper://127.0.0.1:2181/org.apache.dubbo.metadata.report.MetadataReportString key = url.toServiceString();//缓存中查询 查到则直接返回MetadataReport metadataReport = serviceStoreMap.get(key);if(metadataReport !=null){return metadataReport;}// Lock the metadata access process to ensure a single instance of the metadata instance//存在写操作 加个锁
        lock.lock();try{//双重校验锁在查一下
            metadataReport = serviceStoreMap.get(key);if(metadataReport !=null){return metadataReport;}//check参数 查元数据报错是否抛出异常boolean check = url.getParameter(CHECK_KEY,true)&& url.getPort()!=0;try{//关键模版方法 调用扩展实现的具体业务(创建元数据操作对象)
                metadataReport =createMetadataReport(url);}catch(Exception e){if(!check){
                    logger.warn("The metadata reporter failed to initialize", e);}else{throw e;}}//check逻辑检查if(check && metadataReport ==null){thrownewIllegalStateException("Can not create metadata Report "+ url);}//缓存对象 if(metadataReport !=null){
                serviceStoreMap.put(key, metadataReport);}//返回return metadataReport;}finally{// Release the lock
            lock.unlock();}}

上面这个抽象类AbstractMetadataReportFactory中的获取元数据操作对象的模版方法getMetadataReport(URL url), 用了双重校验锁的逻辑来创建对象缓存对象,又用了模版方法设计模式,来让抽象类做通用的逻辑,让实现类型去做扩展, 虽然代码写的太长了些整体还是用了不少的设计思想.

我们直接看这个代码:

metadataReport =createMetadataReport(url);

这个创建元数据操作对象的代码实际上走的是实现类型的逻辑:

来自工厂Bean ZookeeperMetadataReportFactory的工厂方法如下所示:

@OverridepublicMetadataReportcreateMetadataReport(URL url){returnnewZookeeperMetadataReport(url, zookeeperTransporter);}

创建了元数据操作对象,这里我们继续看下元数据操作对象ZookeeperMetadataReport创建做了哪些逻辑:
来自ZookeeperMetadataReport的构造器:

publicZookeeperMetadataReport(URL url,ZookeeperTransporter zookeeperTransporter){//url即配置 配置传递给抽象类 做一些公共的逻辑//url参考:zookeeper://127.0.0.1:2181/org.apache.dubbo.metadata.report.MetadataReport?application=dubbo-demo-api-provider&client=&port=2181&protocol=zookeepersuper(url);if(url.isAnyHost()){thrownewIllegalStateException("registry address == null");}String group = url.getGroup(DEFAULT_ROOT);if(!group.startsWith(PATH_SEPARATOR)){
            group = PATH_SEPARATOR + group;}this.root = group;//连接Zookeeper
        zkClient = zookeeperTransporter.connect(url);}

核心的公共的操作逻辑封装在父类AbstractMetadataReport里面
我们来看前面super调用的构造器逻辑:
如下所示:

publicAbstractMetadataReport(URL reportServerURL){//设置url 如:zookeeper://127.0.0.1:2181/org.apache.dubbo.metadata.report.MetadataReport?application=dubbo-demo-api-provider&client=&port=2181&protocol=zookeepersetUrl(reportServerURL);// Start file save timer//缓存的文件名字//格式为: 用户目录+/.dubbo/dubbo-metadata- + 应用程序名字application + url地址(IP+端口) + 后缀.cache 如下所示///Users/song/.dubbo/dubbo-metadata-dubbo-demo-api-provider-127.0.0.1-2181.cacheString defaultFilename =System.getProperty(USER_HOME)+ DUBBO_METADATA +
            reportServerURL.getApplication()+"-"+replace(reportServerURL.getAddress(),":","-")+ CACHE;//如果用户配置了缓存文件名字则以用户配置为准fileString filename = reportServerURL.getParameter(FILE_KEY, defaultFilename);File file =null;//文件名字不为空if(ConfigUtils.isNotEmpty(filename)){
            file =newFile(filename);//文件和父目录不存在则创建文件目录if(!file.exists()&& file.getParentFile()!=null&&!file.getParentFile().exists()){if(!file.getParentFile().mkdirs()){thrownewIllegalArgumentException("Invalid service store file "+ file +", cause: Failed to create directory "+ file.getParentFile()+"!");}}// if this file exists, firstly delete it.//还未初始化则已存在的历史文件删除掉if(!initialized.getAndSet(true)&& file.exists()){
                file.delete();}}//赋值给成员变量后续继续可以用this.file = file;//文件存在则直接加载文件中的内容loadProperties();//sync-report配置的值为同步配置还异步配置,true是同步配置,默认为false为异步配置
        syncReport = reportServerURL.getParameter(SYNC_REPORT_KEY,false);//重试属性与逻辑也封装了一个类型 创建对象//retry-times重试次数配置 默认为100次//retry-period 重试间隔配置 默认为3000
        metadataReportRetry =newMetadataReportRetry(reportServerURL.getParameter(RETRY_TIMES_KEY, DEFAULT_METADATA_REPORT_RETRY_TIMES),
            reportServerURL.getParameter(RETRY_PERIOD_KEY, DEFAULT_METADATA_REPORT_RETRY_PERIOD));// cycle report the data switch//是否定期从元数据中心同步配置//cycle-report配置默认为trueif(reportServerURL.getParameter(CYCLE_REPORT_KEY, DEFAULT_METADATA_REPORT_CYCLE_REPORT)){//开启重试定时器 24个小时间隔从元数据中心同步一次
            reportTimerScheduler =Executors.newSingleThreadScheduledExecutor(newNamedThreadFactory("DubboMetadataReportTimer",true));
            reportTimerScheduler.scheduleAtFixedRate(this::publishAll,calculateStartTime(), ONE_DAY_IN_MILLISECONDS,TimeUnit.MILLISECONDS);}this.reportMetadata = reportServerURL.getParameter(REPORT_METADATA_KEY,false);this.reportDefinition = reportServerURL.getParameter(REPORT_DEFINITION_KEY,true);}