New metadata service

dubbo-common/src/main/java/org/apache/dubbo/config/ApplicationConfig.java

@@ -295,6 +295,27 @@ public class ApplicationConfig extends AbstractConfig {
      */
     private String executorManagementMode;
 
+    /**
+     * Only use the new version of metadataService (MetadataServiceV2).
+     * <br> MetadataServiceV2 have better compatibility with other language's dubbo implement (dubbo-go).
+     * <br> If set to false (default):
+     * <br>  1. If your services are using triple protocol and {@link #metadataServiceProtocol} is not set
+     * <br>     - Dubbo will export both MetadataService and MetadataServiceV2 with triple
+     * <br>  2. Set {@link #metadataServiceProtocol} = tri
+     * <br>     - Dubbo will export both MetadataService and MetadataServiceV2 with triple
+     * <br>  3. Set {@link #metadataServiceProtocol} != tri
+     * <br>     - Dubbo will only export MetadataService
+     * <br>  4. Your services are not using triple protocol, and {@link #metadataServiceProtocol} is not set
+     * <br>     - Dubbo will only export MetadataService
+     * <br>
+     * <br>  If set to true, dubbo will try to only use MetadataServiceV2.
+     * <br>  It only activates when meet at least one of the following cases:
+     * <br>     1. Manually set {@link #metadataServiceProtocol} = tri
+     * <br>     2. Your services are using triple protocol
+     * <br>
+     */
+    private Boolean onlyUseMetadataV2;
+
     public ApplicationConfig() {}
 
     public ApplicationConfig(ApplicationModel applicationModel) {
@@ -794,6 +815,15 @@ public String getExecutorManagementMode() {
         return executorManagementMode;
     }
 
+    @Parameter(excluded = true)
+    public Boolean getOnlyUseMetadataV2() {
+        return onlyUseMetadataV2;
+    }
+
+    public void setOnlyUseMetadataV2(Boolean onlyUseMetadataV2) {
+        this.onlyUseMetadataV2 = onlyUseMetadataV2;
+    }
+
     @Override
     public void refresh() {
         super.refresh();

dubbo-common/src/main/java/org/apache/dubbo/rpc/model/ModuleModel.java

@@ -188,7 +188,8 @@ public void setModuleEnvironment(ModuleEnvironment moduleEnvironment) {
         this.moduleEnvironment = moduleEnvironment;
     }
 
-    public ConsumerModel registerInternalConsumer(Class<?> internalService, URL url) {
+    public ConsumerModel registerInternalConsumer(
+            Class<?> internalService, URL url, ServiceDescriptor serviceDescriptor, Object proxyObject) {
         ServiceMetadata serviceMetadata = new ServiceMetadata();
         serviceMetadata.setVersion(url.getVersion());
         serviceMetadata.setGroup(url.getGroup());
@@ -197,11 +198,12 @@ public ConsumerModel registerInternalConsumer(Class<?> internalService, URL url)
         serviceMetadata.setServiceType(internalService);
         String serviceKey = URL.buildKey(internalService.getName(), url.getGroup(), url.getVersion());
         serviceMetadata.setServiceKey(serviceKey);
-
         ConsumerModel consumerModel = new ConsumerModel(
                 serviceMetadata.getServiceKey(),
-                "jdk",
-                serviceRepository.lookupService(serviceMetadata.getServiceInterfaceName()),
+                proxyObject,
+                serviceDescriptor == null
+                        ? serviceRepository.lookupService(serviceMetadata.getServiceInterfaceName())
+                        : serviceDescriptor,
                 this,
                 serviceMetadata,
                 new HashMap<>(0),
@@ -212,6 +214,15 @@ public ConsumerModel registerInternalConsumer(Class<?> internalService, URL url)
         return consumerModel;
     }
 
+    public ConsumerModel registerInternalConsumer(
+            Class<?> internalService, URL url, ServiceDescriptor serviceDescriptor) {
+        return registerInternalConsumer(internalService, url, serviceDescriptor, null);
+    }
+
+    public ConsumerModel registerInternalConsumer(Class<?> internalService, URL url) {
+        return registerInternalConsumer(internalService, url, null, null);
+    }
+
     public boolean isLifeCycleManagedExternally() {
         return lifeCycleManagedExternally;
     }

dubbo-common/src/main/java/org/apache/dubbo/rpc/model/ServiceRepository.java

@@ -43,7 +43,11 @@ private void initialize() {
                     .getSupportedExtensionInstances();
             if (CollectionUtils.isNotEmpty(builtinServices)) {
                 for (BuiltinServiceDetector service : builtinServices) {
-                    applicationModel.getInternalModule().getServiceRepository().registerService(service.getService());
+                    Class<?> serviceClass = service.getService();
+                    if (serviceClass == null) {
+                        continue;
+                    }
+                    applicationModel.getInternalModule().getServiceRepository().registerService(serviceClass);
                 }
             }
         }

dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/bootstrap/builders/InternalServiceConfigBuilder.java

@@ -61,6 +61,7 @@ public class InternalServiceConfigBuilder<T> {
     private Class<T> interfaceClass;
     private Executor executor;
     private T ref;
+    private String version;
 
     private InternalServiceConfigBuilder(ApplicationModel applicationModel) {
         this.applicationModel = applicationModel;
@@ -103,6 +104,11 @@ public InternalServiceConfigBuilder<T> protocol(String protocol, String key) {
         return getThis();
     }
 
+    public InternalServiceConfigBuilder<T> version(String version) {
+        this.version = version;
+        return getThis();
+    }
+
     /**
      * Get other configured protocol from environment in priority order. If get nothing, use default dubbo.
      *
@@ -296,7 +302,12 @@ public ServiceConfig<T> build(Consumer<ServiceConfig<T>> configConsumer) {
         serviceConfig.setInterface(interfaceClass);
         serviceConfig.setRef(this.ref);
         serviceConfig.setGroup(applicationConfig.getName());
-        serviceConfig.setVersion("1.0.0");
+
+        if (StringUtils.isNotEmpty(version)) {
+            serviceConfig.setVersion(version);
+        } else {
+            serviceConfig.setVersion("1.0.0");
+        }
         serviceConfig.setFilter("-default");
 
         serviceConfig.setExecutor(executor);

dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/metadata/ConfigurableMetadataServiceExporter.java

@@ -16,7 +16,6 @@
  */
 package org.apache.dubbo.config.metadata;
 
-import org.apache.dubbo.common.URL;
 import org.apache.dubbo.common.logger.ErrorTypeAwareLogger;
 import org.apache.dubbo.common.logger.LoggerFactory;
 import org.apache.dubbo.common.threadpool.manager.FrameworkExecutorRepository;
@@ -26,17 +25,22 @@
 import org.apache.dubbo.config.ServiceConfig;
 import org.apache.dubbo.config.bootstrap.builders.InternalServiceConfigBuilder;
 import org.apache.dubbo.metadata.MetadataService;
+import org.apache.dubbo.metadata.MetadataServiceV2;
+import org.apache.dubbo.metadata.util.MetadataServiceVersionUtils;
 import org.apache.dubbo.registry.client.metadata.MetadataServiceDelegation;
+import org.apache.dubbo.registry.client.metadata.MetadataServiceDelegationV2;
 import org.apache.dubbo.rpc.model.ApplicationModel;
 
 import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.ExecutorService;
 
-import static java.util.Collections.emptyList;
 import static org.apache.dubbo.common.constants.CommonConstants.METADATA_SERVICE_PORT_KEY;
 import static org.apache.dubbo.common.constants.CommonConstants.METADATA_SERVICE_PROTOCOL_KEY;
+import static org.apache.dubbo.common.constants.CommonConstants.TRIPLE;
 import static org.apache.dubbo.common.constants.LoggerCodeConstants.CONFIG_METADATA_SERVICE_EXPORTED;
+import static org.apache.dubbo.metadata.util.MetadataServiceVersionUtils.V1;
+import static org.apache.dubbo.metadata.util.MetadataServiceVersionUtils.V2;
 
 /**
  * Export metadata service
@@ -45,39 +49,34 @@ public class ConfigurableMetadataServiceExporter {
 
     private final ErrorTypeAwareLogger logger = LoggerFactory.getErrorTypeAwareLogger(getClass());
 
-    private MetadataServiceDelegation metadataService;
+    @Deprecated
+    private final MetadataServiceDelegation metadataService;
 
+    private final MetadataServiceDelegationV2 metadataServiceV2;
+
+    @Deprecated
     private volatile ServiceConfig<MetadataService> serviceConfig;
+
+    private volatile ServiceConfig<MetadataServiceV2> serviceConfigV2;
+
     private final ApplicationModel applicationModel;
 
     public ConfigurableMetadataServiceExporter(
-            ApplicationModel applicationModel, MetadataServiceDelegation metadataService) {
+            ApplicationModel applicationModel,
+            MetadataServiceDelegation metadataService,
+            MetadataServiceDelegationV2 metadataServiceV2) {
         this.applicationModel = applicationModel;
         this.metadataService = metadataService;
+        this.metadataServiceV2 = metadataServiceV2;
     }
 
     public synchronized ConfigurableMetadataServiceExporter export() {
         if (serviceConfig == null || !isExported()) {
-            ExecutorService internalServiceExecutor = applicationModel
-                    .getFrameworkModel()
-                    .getBeanFactory()
-                    .getBean(FrameworkExecutorRepository.class)
-                    .getInternalServiceExecutor();
-            this.serviceConfig = InternalServiceConfigBuilder.<MetadataService>newBuilder(applicationModel)
-                    .interfaceClass(MetadataService.class)
-                    .protocol(getApplicationConfig().getMetadataServiceProtocol(), METADATA_SERVICE_PROTOCOL_KEY)
-                    .port(getApplicationConfig().getMetadataServicePort(), METADATA_SERVICE_PORT_KEY)
-                    .registryId("internal-metadata-registry")
-                    .executor(internalServiceExecutor)
-                    .ref(metadataService)
-                    .build(configConsumer -> configConsumer.setMethods(generateMethodConfig()));
-
-            // export
-            serviceConfig.export();
-
-            metadataService.setMetadataURL(serviceConfig.getExportedUrls().get(0));
-            if (logger.isInfoEnabled()) {
-                logger.info("The MetadataService exports urls : " + serviceConfig.getExportedUrls());
+            if (MetadataServiceVersionUtils.needExportV1(applicationModel)) {
+                exportV1();
+            }
+            if (MetadataServiceVersionUtils.needExportV2(applicationModel)) {
+                exportV2();
             }
         } else {
             if (logger.isWarnEnabled()) {
@@ -92,18 +91,77 @@ public synchronized ConfigurableMetadataServiceExporter export() {
         return this;
     }
 
+    private static final String INTERNAL_METADATA_REGISTRY_ID = "internal-metadata-registry";
+
+    private void exportV1() {
+        ExecutorService internalServiceExecutor = applicationModel
+                .getFrameworkModel()
+                .getBeanFactory()
+                .getBean(FrameworkExecutorRepository.class)
+                .getInternalServiceExecutor();
+        this.serviceConfig = InternalServiceConfigBuilder.<MetadataService>newBuilder(applicationModel)
+                .interfaceClass(MetadataService.class)
+                .protocol(getApplicationConfig().getMetadataServiceProtocol(), METADATA_SERVICE_PROTOCOL_KEY)
+                .port(getApplicationConfig().getMetadataServicePort(), METADATA_SERVICE_PORT_KEY)
+                .registryId(INTERNAL_METADATA_REGISTRY_ID)
+                .executor(internalServiceExecutor)
+                .ref(metadataService)
+                .version(V1)
+                .build(configConsumer -> configConsumer.setMethods(generateMethodConfig()));
+
+        serviceConfig.export();
+        metadataService.setMetadataURL(serviceConfig.getExportedUrls().get(0));
+
+        if (logger.isInfoEnabled()) {
+            logger.info("The MetadataService exports urls : " + serviceConfig.getExportedUrls());
+        }
+    }
+
+    private void exportV2() {
+        ExecutorService internalServiceExecutor = applicationModel
+                .getFrameworkModel()
+                .getBeanFactory()
+                .getBean(FrameworkExecutorRepository.class)
+                .getInternalServiceExecutor();
+        this.serviceConfigV2 = InternalServiceConfigBuilder.<MetadataServiceV2>newBuilder(applicationModel)
+                .interfaceClass(MetadataServiceV2.class)
+                .protocol(TRIPLE, METADATA_SERVICE_PROTOCOL_KEY)
+                .port(getApplicationConfig().getMetadataServicePort(), METADATA_SERVICE_PORT_KEY)
+                .registryId(INTERNAL_METADATA_REGISTRY_ID)
+                .executor(internalServiceExecutor)
+                .ref(metadataServiceV2)
+                .version(V2)
+                .build();
+
+        serviceConfigV2.export();
+        metadataServiceV2.setMetadataUrl(serviceConfigV2.getExportedUrls().get(0));
+
+        if (logger.isInfoEnabled()) {
+            logger.info("The MetadataServiceV2 exports urls : " + serviceConfigV2.getExportedUrls());
+        }
+    }
+
     public ConfigurableMetadataServiceExporter unexport() {
         if (isExported()) {
             serviceConfig.unexport();
+            serviceConfigV2.unexport();
             metadataService.setMetadataURL(null);
         }
         return this;
     }
 
-    public boolean isExported() {
+    private boolean v1Exported() {
         return serviceConfig != null && serviceConfig.isExported() && !serviceConfig.isUnexported();
     }
 
+    private boolean v2Exported() {
+        return serviceConfigV2 != null && serviceConfigV2.isExported() && !serviceConfigV2.isUnexported();
+    }
+
+    public boolean isExported() {
+        return v1Exported() || v2Exported();
+    }
+
     private ApplicationConfig getApplicationConfig() {
         return applicationModel.getApplicationConfigManager().getApplication().get();
     }
@@ -129,14 +187,4 @@ private List<MethodConfig> generateMethodConfig() {
 
         return Collections.singletonList(methodConfig);
     }
-
-    // for unit test
-    public void setMetadataService(MetadataServiceDelegation metadataService) {
-        this.metadataService = metadataService;
-    }
-
-    // for unit test
-    public List<URL> getExportedURLs() {
-        return serviceConfig != null ? serviceConfig.getExportedUrls() : emptyList();
-    }
 }

dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/metadata/ExporterDeployListener.java

@@ -20,6 +20,7 @@
 import org.apache.dubbo.common.lang.Prioritized;
 import org.apache.dubbo.common.utils.StringUtils;
 import org.apache.dubbo.registry.client.metadata.MetadataServiceDelegation;
+import org.apache.dubbo.registry.client.metadata.MetadataServiceDelegationV2;
 import org.apache.dubbo.rpc.model.ApplicationModel;
 
 import static org.apache.dubbo.common.constants.CommonConstants.DEFAULT_METADATA_STORAGE_TYPE;
@@ -78,10 +79,16 @@ public void setMetadataServiceExporter(ConfigurableMetadataServiceExporter metad
     @Override
     public synchronized void onModuleStarted(ApplicationModel applicationModel) {
         // start metadata service exporter
+        @Deprecated
         MetadataServiceDelegation metadataService =
                 applicationModel.getBeanFactory().getOrRegisterBean(MetadataServiceDelegation.class);
+
+        MetadataServiceDelegationV2 metadataServiceV2 =
+                applicationModel.getBeanFactory().getOrRegisterBean(MetadataServiceDelegationV2.class);
+
         if (metadataServiceExporter == null) {
-            metadataServiceExporter = new ConfigurableMetadataServiceExporter(applicationModel, metadataService);
+            metadataServiceExporter =
+                    new ConfigurableMetadataServiceExporter(applicationModel, metadataService, metadataServiceV2);
             // fixme, let's disable local metadata service export at this moment
             if (!REMOTE_METADATA_STORAGE_TYPE.equals(getMetadataType(applicationModel))
                     && !INTERFACE_REGISTER_MODE.equals(getRegisterMode(applicationModel))) {