From e1892217088c6ea718486d8ae3b7c811d77bfcaf Mon Sep 17 00:00:00 2001 From: huazhongming Date: Tue, 8 Jun 2021 17:21:01 +0800 Subject: [PATCH] [3.0] Support url merge processor extension (#7932) --- .../ProviderURLMergeProcessor.java | 18 ++- .../rpc/cluster/support/ClusterUtils.java | 118 ++--------------- .../DefaultProviderURLMergeProcessor.java | 123 ++++++++++++++++++ ...ubbo.rpc.cluster.ProviderURLMergeProcessor | 1 + .../rpc/cluster/support/ClusterUtilsTest.java | 4 + .../common/constants/CommonConstants.java | 5 + .../apache/dubbo/config/ConsumerConfig.java | 18 +++ .../bootstrap/builders/ConsumerBuilder.java | 13 ++ .../src/main/resources/META-INF/dubbo.xsd | 5 + dubbo-distribution/dubbo-all/pom.xml | 6 + .../integration/RegistryDirectory.java | 2 +- 11 files changed, 202 insertions(+), 111 deletions(-) rename dubbo-cluster/src/main/java/org/apache/dubbo/rpc/cluster/{support => }/ProviderURLMergeProcessor.java (68%) create mode 100644 dubbo-cluster/src/main/java/org/apache/dubbo/rpc/cluster/support/merger/DefaultProviderURLMergeProcessor.java create mode 100644 dubbo-cluster/src/main/resources/META-INF/dubbo/internal/org.apache.dubbo.rpc.cluster.ProviderURLMergeProcessor diff --git a/dubbo-cluster/src/main/java/org/apache/dubbo/rpc/cluster/support/ProviderURLMergeProcessor.java b/dubbo-cluster/src/main/java/org/apache/dubbo/rpc/cluster/ProviderURLMergeProcessor.java similarity index 68% rename from dubbo-cluster/src/main/java/org/apache/dubbo/rpc/cluster/support/ProviderURLMergeProcessor.java rename to dubbo-cluster/src/main/java/org/apache/dubbo/rpc/cluster/ProviderURLMergeProcessor.java index 9c91f384fb..a548663392 100644 --- a/dubbo-cluster/src/main/java/org/apache/dubbo/rpc/cluster/support/ProviderURLMergeProcessor.java +++ b/dubbo-cluster/src/main/java/org/apache/dubbo/rpc/cluster/ProviderURLMergeProcessor.java @@ -14,16 +14,26 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.apache.dubbo.rpc.cluster.support; +package org.apache.dubbo.rpc.cluster; import org.apache.dubbo.common.URL; import org.apache.dubbo.common.extension.SPI; import java.util.Map; -@SPI +@SPI("default") public interface ProviderURLMergeProcessor { - URL mergeProviderUrl(URL providerUrl, Map localParametersMap); - boolean accept(URL providerUrl, Map localParametersMap); + /** + * Merging the URL parameters of provider and consumer + * + * @param remoteUrl providerUrl + * @param localParametersMap consumer url parameters + * @return + */ + URL mergeUrl(URL remoteUrl, Map localParametersMap); + + default boolean accept(URL providerUrl, Map localParametersMap) { + return true; + } } diff --git a/dubbo-cluster/src/main/java/org/apache/dubbo/rpc/cluster/support/ClusterUtils.java b/dubbo-cluster/src/main/java/org/apache/dubbo/rpc/cluster/support/ClusterUtils.java index 72def111ab..55aff3e095 100644 --- a/dubbo-cluster/src/main/java/org/apache/dubbo/rpc/cluster/support/ClusterUtils.java +++ b/dubbo-cluster/src/main/java/org/apache/dubbo/rpc/cluster/support/ClusterUtils.java @@ -18,31 +18,13 @@ package org.apache.dubbo.rpc.cluster.support; import org.apache.dubbo.common.URL; import org.apache.dubbo.common.extension.ExtensionLoader; -import org.apache.dubbo.remoting.Constants; +import org.apache.dubbo.common.utils.StringUtils; +import org.apache.dubbo.rpc.cluster.ProviderURLMergeProcessor; -import java.util.HashMap; -import java.util.List; import java.util.Map; -import static org.apache.dubbo.common.constants.CommonConstants.ALIVE_KEY; -import static org.apache.dubbo.common.constants.CommonConstants.APPLICATION_KEY; -import static org.apache.dubbo.common.constants.CommonConstants.CORE_THREADS_KEY; -import static org.apache.dubbo.common.constants.CommonConstants.DEFAULT_KEY_PREFIX; -import static org.apache.dubbo.common.constants.CommonConstants.DUBBO_VERSION_KEY; -import static org.apache.dubbo.common.constants.CommonConstants.GENERIC_KEY; -import static org.apache.dubbo.common.constants.CommonConstants.GROUP_KEY; -import static org.apache.dubbo.common.constants.CommonConstants.INVOKER_LISTENER_KEY; -import static org.apache.dubbo.common.constants.CommonConstants.METHODS_KEY; -import static org.apache.dubbo.common.constants.CommonConstants.QUEUES_KEY; -import static org.apache.dubbo.common.constants.CommonConstants.REFERENCE_FILTER_KEY; -import static org.apache.dubbo.common.constants.CommonConstants.RELEASE_KEY; -import static org.apache.dubbo.common.constants.CommonConstants.REMOTE_APPLICATION_KEY; -import static org.apache.dubbo.common.constants.CommonConstants.TAG_KEY; -import static org.apache.dubbo.common.constants.CommonConstants.THREADPOOL_KEY; -import static org.apache.dubbo.common.constants.CommonConstants.THREADS_KEY; -import static org.apache.dubbo.common.constants.CommonConstants.THREAD_NAME_KEY; -import static org.apache.dubbo.common.constants.CommonConstants.TIMESTAMP_KEY; -import static org.apache.dubbo.common.constants.CommonConstants.VERSION_KEY; +import static org.apache.dubbo.common.constants.CommonConstants.URL_MERGE_PROCESSOR_KEY; + /** * ClusterUtils @@ -53,93 +35,17 @@ public class ClusterUtils { } public static URL mergeUrl(URL remoteUrl, Map localMap) { - Map map = new HashMap(); - Map remoteMap = remoteUrl.getParameters(); - if (remoteMap != null && remoteMap.size() > 0) { - map.putAll(remoteMap); + String ump = localMap.get(URL_MERGE_PROCESSOR_KEY); + ProviderURLMergeProcessor providerURLMergeProcessor; - // Remove configurations from provider, some items should be affected by provider. - map.remove(THREAD_NAME_KEY); - map.remove(DEFAULT_KEY_PREFIX + THREAD_NAME_KEY); - - map.remove(THREADPOOL_KEY); - map.remove(DEFAULT_KEY_PREFIX + THREADPOOL_KEY); - - map.remove(CORE_THREADS_KEY); - map.remove(DEFAULT_KEY_PREFIX + CORE_THREADS_KEY); - - map.remove(THREADS_KEY); - map.remove(DEFAULT_KEY_PREFIX + THREADS_KEY); - - map.remove(QUEUES_KEY); - map.remove(DEFAULT_KEY_PREFIX + QUEUES_KEY); - - map.remove(ALIVE_KEY); - map.remove(DEFAULT_KEY_PREFIX + ALIVE_KEY); - - map.remove(Constants.TRANSPORTER_KEY); - map.remove(DEFAULT_KEY_PREFIX + Constants.TRANSPORTER_KEY); + if (StringUtils.isNotEmpty(ump)) { + providerURLMergeProcessor = ExtensionLoader.getExtensionLoader(ProviderURLMergeProcessor.class).getExtension(ump); + } else { + providerURLMergeProcessor = ExtensionLoader.getExtensionLoader(ProviderURLMergeProcessor.class).getExtension("default"); } - if (localMap != null && localMap.size() > 0) { - Map copyOfLocalMap = new HashMap<>(localMap); - - if(map.containsKey(GROUP_KEY)){ - copyOfLocalMap.remove(GROUP_KEY); - } - if(map.containsKey(VERSION_KEY)){ - copyOfLocalMap.remove(VERSION_KEY); - } - if (map.containsKey(GENERIC_KEY)) { - copyOfLocalMap.remove(GENERIC_KEY); - } - - copyOfLocalMap.remove(RELEASE_KEY); - copyOfLocalMap.remove(DUBBO_VERSION_KEY); - copyOfLocalMap.remove(METHODS_KEY); - copyOfLocalMap.remove(TIMESTAMP_KEY); - copyOfLocalMap.remove(TAG_KEY); - - map.putAll(copyOfLocalMap); - - if (remoteMap != null) { - map.put(REMOTE_APPLICATION_KEY, remoteMap.get(APPLICATION_KEY)); - - // Combine filters and listeners on Provider and Consumer - String remoteFilter = remoteMap.get(REFERENCE_FILTER_KEY); - String localFilter = copyOfLocalMap.get(REFERENCE_FILTER_KEY); - if (remoteFilter != null && remoteFilter.length() > 0 - && localFilter != null && localFilter.length() > 0) { - map.put(REFERENCE_FILTER_KEY, remoteFilter + "," + localFilter); - } - String remoteListener = remoteMap.get(INVOKER_LISTENER_KEY); - String localListener = copyOfLocalMap.get(INVOKER_LISTENER_KEY); - if (remoteListener != null && remoteListener.length() > 0 - && localListener != null && localListener.length() > 0) { - map.put(INVOKER_LISTENER_KEY, remoteListener + "," + localListener); - } - } - } - - return remoteUrl.clearParameters().addParameters(map); + return providerURLMergeProcessor.mergeUrl(remoteUrl, localMap); } - public static URL mergeProviderUrl(URL remoteUrl, Map localMap) { - - //urlprocessor => upc - List providerURLMergeProcessors = ExtensionLoader.getExtensionLoader(ProviderURLMergeProcessor.class) - .getActivateExtension(remoteUrl, "upc"); - - if (providerURLMergeProcessors != null && providerURLMergeProcessors.size() > 0) { - for (ProviderURLMergeProcessor providerURLMergeProcessor : providerURLMergeProcessors) { - if (providerURLMergeProcessor.accept(remoteUrl, localMap)) { - return providerURLMergeProcessor.mergeProviderUrl(remoteUrl, localMap); - } - } - } - - return mergeUrl(remoteUrl, localMap); - } - -} +} \ No newline at end of file diff --git a/dubbo-cluster/src/main/java/org/apache/dubbo/rpc/cluster/support/merger/DefaultProviderURLMergeProcessor.java b/dubbo-cluster/src/main/java/org/apache/dubbo/rpc/cluster/support/merger/DefaultProviderURLMergeProcessor.java new file mode 100644 index 0000000000..93f25bdc93 --- /dev/null +++ b/dubbo-cluster/src/main/java/org/apache/dubbo/rpc/cluster/support/merger/DefaultProviderURLMergeProcessor.java @@ -0,0 +1,123 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.dubbo.rpc.cluster.support.merger; + +import org.apache.dubbo.common.URL; +import org.apache.dubbo.remoting.Constants; +import org.apache.dubbo.rpc.cluster.ProviderURLMergeProcessor; + +import java.util.HashMap; +import java.util.Map; + +import static org.apache.dubbo.common.constants.CommonConstants.ALIVE_KEY; +import static org.apache.dubbo.common.constants.CommonConstants.APPLICATION_KEY; +import static org.apache.dubbo.common.constants.CommonConstants.CORE_THREADS_KEY; +import static org.apache.dubbo.common.constants.CommonConstants.DEFAULT_KEY_PREFIX; +import static org.apache.dubbo.common.constants.CommonConstants.DUBBO_VERSION_KEY; +import static org.apache.dubbo.common.constants.CommonConstants.GENERIC_KEY; +import static org.apache.dubbo.common.constants.CommonConstants.GROUP_KEY; +import static org.apache.dubbo.common.constants.CommonConstants.INVOKER_LISTENER_KEY; +import static org.apache.dubbo.common.constants.CommonConstants.METHODS_KEY; +import static org.apache.dubbo.common.constants.CommonConstants.QUEUES_KEY; +import static org.apache.dubbo.common.constants.CommonConstants.REFERENCE_FILTER_KEY; +import static org.apache.dubbo.common.constants.CommonConstants.RELEASE_KEY; +import static org.apache.dubbo.common.constants.CommonConstants.REMOTE_APPLICATION_KEY; +import static org.apache.dubbo.common.constants.CommonConstants.TAG_KEY; +import static org.apache.dubbo.common.constants.CommonConstants.THREADPOOL_KEY; +import static org.apache.dubbo.common.constants.CommonConstants.THREADS_KEY; +import static org.apache.dubbo.common.constants.CommonConstants.THREAD_NAME_KEY; +import static org.apache.dubbo.common.constants.CommonConstants.TIMESTAMP_KEY; +import static org.apache.dubbo.common.constants.CommonConstants.VERSION_KEY; + + +public class DefaultProviderURLMergeProcessor implements ProviderURLMergeProcessor { + + @Override + public URL mergeUrl(URL remoteUrl, Map localParametersMap) { + Map map = new HashMap<>(); + Map remoteMap = remoteUrl.getParameters(); + + if (remoteMap != null && remoteMap.size() > 0) { + map.putAll(remoteMap); + + // Remove configurations from provider, some items should be affected by provider. + map.remove(THREAD_NAME_KEY); + map.remove(DEFAULT_KEY_PREFIX + THREAD_NAME_KEY); + + map.remove(THREADPOOL_KEY); + map.remove(DEFAULT_KEY_PREFIX + THREADPOOL_KEY); + + map.remove(CORE_THREADS_KEY); + map.remove(DEFAULT_KEY_PREFIX + CORE_THREADS_KEY); + + map.remove(THREADS_KEY); + map.remove(DEFAULT_KEY_PREFIX + THREADS_KEY); + + map.remove(QUEUES_KEY); + map.remove(DEFAULT_KEY_PREFIX + QUEUES_KEY); + + map.remove(ALIVE_KEY); + map.remove(DEFAULT_KEY_PREFIX + ALIVE_KEY); + + map.remove(Constants.TRANSPORTER_KEY); + map.remove(DEFAULT_KEY_PREFIX + Constants.TRANSPORTER_KEY); + } + + if (localParametersMap != null && localParametersMap.size() > 0) { + Map copyOfLocalMap = new HashMap<>(localParametersMap); + + if (map.containsKey(GROUP_KEY)) { + copyOfLocalMap.remove(GROUP_KEY); + } + if (map.containsKey(VERSION_KEY)) { + copyOfLocalMap.remove(VERSION_KEY); + } + if (map.containsKey(GENERIC_KEY)) { + copyOfLocalMap.remove(GENERIC_KEY); + } + + copyOfLocalMap.remove(RELEASE_KEY); + copyOfLocalMap.remove(DUBBO_VERSION_KEY); + copyOfLocalMap.remove(METHODS_KEY); + copyOfLocalMap.remove(TIMESTAMP_KEY); + copyOfLocalMap.remove(TAG_KEY); + + map.putAll(copyOfLocalMap); + + if (remoteMap != null) { + map.put(REMOTE_APPLICATION_KEY, remoteMap.get(APPLICATION_KEY)); + + // Combine filters and listeners on Provider and Consumer + String remoteFilter = remoteMap.get(REFERENCE_FILTER_KEY); + String localFilter = copyOfLocalMap.get(REFERENCE_FILTER_KEY); + if (remoteFilter != null && remoteFilter.length() > 0 + && localFilter != null && localFilter.length() > 0) { + map.put(REFERENCE_FILTER_KEY, remoteFilter + "," + localFilter); + } + String remoteListener = remoteMap.get(INVOKER_LISTENER_KEY); + String localListener = copyOfLocalMap.get(INVOKER_LISTENER_KEY); + if (remoteListener != null && remoteListener.length() > 0 + && localListener != null && localListener.length() > 0) { + map.put(INVOKER_LISTENER_KEY, remoteListener + "," + localListener); + } + } + } + + return remoteUrl.clearParameters().addParameters(map); + } + +} \ No newline at end of file diff --git a/dubbo-cluster/src/main/resources/META-INF/dubbo/internal/org.apache.dubbo.rpc.cluster.ProviderURLMergeProcessor b/dubbo-cluster/src/main/resources/META-INF/dubbo/internal/org.apache.dubbo.rpc.cluster.ProviderURLMergeProcessor new file mode 100644 index 0000000000..f06410881f --- /dev/null +++ b/dubbo-cluster/src/main/resources/META-INF/dubbo/internal/org.apache.dubbo.rpc.cluster.ProviderURLMergeProcessor @@ -0,0 +1 @@ +default=org.apache.dubbo.rpc.cluster.support.merger.DefaultProviderURLMergeProcessor \ No newline at end of file diff --git a/dubbo-cluster/src/test/java/org/apache/dubbo/rpc/cluster/support/ClusterUtilsTest.java b/dubbo-cluster/src/test/java/org/apache/dubbo/rpc/cluster/support/ClusterUtilsTest.java index f0cedc0002..19c8b714db 100644 --- a/dubbo-cluster/src/test/java/org/apache/dubbo/rpc/cluster/support/ClusterUtilsTest.java +++ b/dubbo-cluster/src/test/java/org/apache/dubbo/rpc/cluster/support/ClusterUtilsTest.java @@ -71,6 +71,7 @@ public class ClusterUtilsTest { .addParameter(DEFAULT_KEY_PREFIX + THREAD_NAME_KEY, "test") .addParameter(APPLICATION_KEY, "provider") .addParameter(REFERENCE_FILTER_KEY, "filter1,filter2") + .addParameter(TAG_KEY,"TTT") .build(); URL consumerURL = new URLBuilder(DUBBO_PROTOCOL, "localhost", 55555) @@ -78,6 +79,7 @@ public class ClusterUtilsTest { .addParameter(THREADPOOL_KEY, "foo") .addParameter(APPLICATION_KEY, "consumer") .addParameter(REFERENCE_FILTER_KEY, "filter3") + .addParameter(TAG_KEY,"UUU") .build(); URL url = ClusterUtils.mergeUrl(providerURL, consumerURL.getParameters()); @@ -107,6 +109,8 @@ public class ClusterUtilsTest { Assertions.assertEquals(url.getApplication(), "consumer"); Assertions.assertEquals(url.getRemoteApplication(), "provider"); Assertions.assertEquals(url.getParameter(REFERENCE_FILTER_KEY), "filter1,filter2,filter3"); + + Assertions.assertEquals(url.getParameter(TAG_KEY), "TTT"); } @Test diff --git a/dubbo-common/src/main/java/org/apache/dubbo/common/constants/CommonConstants.java b/dubbo-common/src/main/java/org/apache/dubbo/common/constants/CommonConstants.java index 245dd1d55c..c6cb112bc9 100644 --- a/dubbo-common/src/main/java/org/apache/dubbo/common/constants/CommonConstants.java +++ b/dubbo-common/src/main/java/org/apache/dubbo/common/constants/CommonConstants.java @@ -417,4 +417,9 @@ public interface CommonConstants { String CLASSPATH_URL_PREFIX = "classpath:"; String DEFAULT_VERSION = "0.0.0"; + + /** + * Url merge processor key + */ + String URL_MERGE_PROCESSOR_KEY = "url-merge-processor"; } diff --git a/dubbo-common/src/main/java/org/apache/dubbo/config/ConsumerConfig.java b/dubbo-common/src/main/java/org/apache/dubbo/config/ConsumerConfig.java index 53e63d29bf..69b2b25182 100644 --- a/dubbo-common/src/main/java/org/apache/dubbo/config/ConsumerConfig.java +++ b/dubbo-common/src/main/java/org/apache/dubbo/config/ConsumerConfig.java @@ -17,6 +17,9 @@ package org.apache.dubbo.config; import org.apache.dubbo.common.utils.StringUtils; +import org.apache.dubbo.config.support.Parameter; + +import static org.apache.dubbo.common.constants.CommonConstants.URL_MERGE_PROCESSOR_KEY; /** * The service consumer default configuration @@ -58,6 +61,12 @@ public class ConsumerConfig extends AbstractReferenceConfig { */ private Integer shareconnections; + /** + * Url Merge Processor + * Used to customize the URL merge of consumer and provider + */ + private String urlMergeProcessor; + @Override public void setTimeout(Integer timeout) { super.setTimeout(timeout); @@ -115,4 +124,13 @@ public class ConsumerConfig extends AbstractReferenceConfig { public void setShareconnections(Integer shareconnections) { this.shareconnections = shareconnections; } + + @Parameter(key = URL_MERGE_PROCESSOR_KEY) + public String getUrlMergeProcessor() { + return urlMergeProcessor; + } + + public void setUrlMergeProcessor(String urlMergeProcessor) { + this.urlMergeProcessor = urlMergeProcessor; + } } diff --git a/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/bootstrap/builders/ConsumerBuilder.java b/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/bootstrap/builders/ConsumerBuilder.java index dd37e92e46..845271f668 100644 --- a/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/bootstrap/builders/ConsumerBuilder.java +++ b/dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/bootstrap/builders/ConsumerBuilder.java @@ -61,6 +61,12 @@ public class ConsumerBuilder extends AbstractReferenceBuilder + + + + + diff --git a/dubbo-distribution/dubbo-all/pom.xml b/dubbo-distribution/dubbo-all/pom.xml index 208088b7cc..3be4bd5378 100644 --- a/dubbo-distribution/dubbo-all/pom.xml +++ b/dubbo-distribution/dubbo-all/pom.xml @@ -764,6 +764,12 @@ META-INF/dubbo/internal/org.apache.dubbo.registry.client.migration.PreMigratingConditionChecker + + + META-INF/dubbo/internal/org.apache.dubbo.rpc.cluster.ProviderURLMergeProcessor + + diff --git a/dubbo-registry/dubbo-registry-api/src/main/java/org/apache/dubbo/registry/integration/RegistryDirectory.java b/dubbo-registry/dubbo-registry-api/src/main/java/org/apache/dubbo/registry/integration/RegistryDirectory.java index d0a40f681b..000ce9c66f 100644 --- a/dubbo-registry/dubbo-registry-api/src/main/java/org/apache/dubbo/registry/integration/RegistryDirectory.java +++ b/dubbo-registry/dubbo-registry-api/src/main/java/org/apache/dubbo/registry/integration/RegistryDirectory.java @@ -373,7 +373,7 @@ public class RegistryDirectory extends DynamicDirectory { if (providerUrl instanceof ServiceAddressURL) { providerUrl = overrideWithConfigurator(providerUrl); } else { - providerUrl = ClusterUtils.mergeProviderUrl(providerUrl, queryMap); // Merge the consumer side parameters + providerUrl = ClusterUtils.mergeUrl(providerUrl, queryMap); // Merge the consumer side parameters providerUrl = overrideWithConfigurator(providerUrl); providerUrl = providerUrl.addParameter(Constants.CHECK_KEY, String.valueOf(false)); // Do not check whether the connection is successful or not, always create Invoker! }