From 755ade8b74239ce920fed1e1db1ba1a771637b54 Mon Sep 17 00:00:00 2001 From: Fishtail <49390359+fuyuwei01@users.noreply.github.com> Date: Wed, 4 Jun 2025 11:24:01 +0800 Subject: [PATCH] feat:support dynamic multi-discovery. (#1594) --- CHANGELOG.md | 1 + spring-cloud-starter-tencent-all/pom.xml | 5 + .../adapter/PolarisConfigFileLocator.java | 66 +--------- .../PolarisConfigPropertyAutoRefresher.java | 10 +- ...arisAdaptorTsfConfigAutoConfiguration.java | 4 +- .../utils/PolarisPropertySourceUtils.java | 75 ++++++++++++ .../adapter/PolarisConfigFileLocatorTest.java | 105 +++++++++++++++- .../polaris/registry/PolarisRegistration.java | 7 ++ .../registry/PolarisServiceRegistry.java | 1 + .../tsf/TsfRateLimitAutoConfiguration.java | 4 +- .../TsfRateLimitBootstrapConfiguration.java | 4 +- .../tsf/TsfRateLimitConfigModifier.java | 15 +-- .../ConditionalOnOnlyTsfConsulEnabled.java | 47 ++++++++ .../tsf/ConditionalOnTsfConsulEnabled.java | 20 +-- .../cloud/common/tsf/TsfContextUtils.java | 80 ++++++++++++ spring-cloud-tencent-coverage/pom.xml | 6 + spring-cloud-tencent-dependencies/pom.xml | 6 + spring-cloud-tencent-plugin-starters/pom.xml | 1 + .../pom.xml | 25 ++++ .../MultiDiscoveryAutoConfiguration.java | 46 +++++++ .../ConsulDiscoveryConfigChangeListener.java | 114 ++++++++++++++++++ .../main/resources/META-INF/spring.factories | 2 + .../pom.xml | 2 +- .../tsf/TsfContextAutoConfiguration.java | 4 +- .../config/extend/tsf/TsfContextUtils.java | 58 --------- .../tsf/TsfCoreEnvironmentPostProcessor.java | 55 +++++---- .../tsf/TsfLastEnvironmentPostProcessor.java | 58 +++++++++ .../main/resources/META-INF/spring.factories | 3 +- 28 files changed, 636 insertions(+), 188 deletions(-) create mode 100644 spring-cloud-tencent-commons/src/main/java/com/tencent/cloud/common/tsf/ConditionalOnOnlyTsfConsulEnabled.java create mode 100644 spring-cloud-tencent-commons/src/main/java/com/tencent/cloud/common/tsf/TsfContextUtils.java create mode 100644 spring-cloud-tencent-plugin-starters/spring-cloud-starter-tencent-multi-discovery-plugin/pom.xml create mode 100644 spring-cloud-tencent-plugin-starters/spring-cloud-starter-tencent-multi-discovery-plugin/src/main/java/com/tencent/cloud/plugin/discovery/multi/config/MultiDiscoveryAutoConfiguration.java create mode 100644 spring-cloud-tencent-plugin-starters/spring-cloud-starter-tencent-multi-discovery-plugin/src/main/java/com/tencent/cloud/plugin/discovery/multi/listeners/ConsulDiscoveryConfigChangeListener.java create mode 100644 spring-cloud-tencent-plugin-starters/spring-cloud-starter-tencent-multi-discovery-plugin/src/main/resources/META-INF/spring.factories delete mode 100644 spring-cloud-tencent-polaris-context/src/main/java/com/tencent/cloud/polaris/context/config/extend/tsf/TsfContextUtils.java create mode 100644 spring-cloud-tencent-polaris-context/src/main/java/com/tencent/cloud/polaris/context/config/extend/tsf/TsfLastEnvironmentPostProcessor.java diff --git a/CHANGELOG.md b/CHANGELOG.md index 6c690543c..624d8b57f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -38,3 +38,4 @@ - [fix: add gateway context config example.](https://github.com/Tencent/spring-cloud-tencent/pull/1561) - [fix: use getActiveRuleId method to fix javaagent ratelimit pb method not found error.](https://github.com/Tencent/spring-cloud-tencent/pull/1575) - [feat:support config empty protection.](https://github.com/Tencent/spring-cloud-tencent/pull/1583) +- [feat:support dynamic multi-discovery.](https://github.com/Tencent/spring-cloud-tencent/pull/1594) diff --git a/spring-cloud-starter-tencent-all/pom.xml b/spring-cloud-starter-tencent-all/pom.xml index c8a70ee68..e49b8f535 100644 --- a/spring-cloud-starter-tencent-all/pom.xml +++ b/spring-cloud-starter-tencent-all/pom.xml @@ -69,5 +69,10 @@ com.tencent.cloud spring-cloud-starter-tencent-fault-tolerance + + + com.tencent.cloud + spring-cloud-starter-tencent-multi-discovery-plugin + diff --git a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigFileLocator.java b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigFileLocator.java index 89c651b48..a9f5a9ae2 100644 --- a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigFileLocator.java +++ b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigFileLocator.java @@ -21,20 +21,15 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.LinkedList; import java.util.List; -import java.util.Map; -import java.util.concurrent.ConcurrentHashMap; import com.tencent.cloud.polaris.config.config.ConfigFileGroup; import com.tencent.cloud.polaris.config.config.PolarisConfigProperties; -import com.tencent.cloud.polaris.config.enums.ConfigFileFormat; import com.tencent.cloud.polaris.context.config.PolarisContextProperties; import com.tencent.polaris.api.utils.ClassUtils; import com.tencent.polaris.api.utils.CollectionUtils; import com.tencent.polaris.api.utils.StringUtils; import com.tencent.polaris.configuration.api.core.ConfigFileMetadata; import com.tencent.polaris.configuration.api.core.ConfigFileService; -import com.tencent.polaris.configuration.api.core.ConfigKVFile; -import com.tencent.polaris.configuration.client.internal.CompositeConfigFile; import com.tencent.polaris.configuration.client.internal.DefaultConfigFileMetadata; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -45,6 +40,9 @@ import org.springframework.core.env.CompositePropertySource; import org.springframework.core.env.Environment; import org.springframework.core.env.PropertySource; +import static com.tencent.cloud.polaris.config.utils.PolarisPropertySourceUtils.loadGroupPolarisPropertySource; +import static com.tencent.cloud.polaris.config.utils.PolarisPropertySourceUtils.loadPolarisPropertySource; + /** * Spring cloud reserved core configuration loading SPI. *

@@ -74,64 +72,6 @@ public class PolarisConfigFileLocator implements PropertySourceLocator { this.environment = environment; } - public static PolarisPropertySource loadPolarisPropertySource(ConfigFileService configFileService, String namespace, String group, String fileName) { - ConfigKVFile configKVFile = loadConfigKVFile(configFileService, namespace, group, fileName); - - Map map = new ConcurrentHashMap<>(); - for (String key : configKVFile.getPropertyNames()) { - map.put(key, configKVFile.getProperty(key, null)); - } - - return new PolarisPropertySource(namespace, group, fileName, configKVFile, map); - } - - public static PolarisPropertySource loadGroupPolarisPropertySource(ConfigFileService configFileService, String namespace, String group) { - List configKVFiles = new ArrayList<>(); - - com.tencent.polaris.configuration.api.core.ConfigFileGroup remoteGroup = configFileService.getConfigFileGroup(namespace, group); - if (remoteGroup == null) { - return null; - } - - for (ConfigFileMetadata configFile : remoteGroup.getConfigFileMetadataList()) { - String fileName = configFile.getFileName(); - ConfigKVFile configKVFile = loadConfigKVFile(configFileService, namespace, group, fileName); - configKVFiles.add(configKVFile); - } - - CompositeConfigFile compositeConfigFile = new CompositeConfigFile(configKVFiles); - - Map map = new ConcurrentHashMap<>(); - for (String key : compositeConfigFile.getPropertyNames()) { - String value = compositeConfigFile.getProperty(key, null); - map.put(key, value); - } - - if (LOGGER.isDebugEnabled()) { - LOGGER.debug("namespace='" + namespace + '\'' - + ", group='" + group + '\'' + ", fileName='" + compositeConfigFile + '\'' - + ", map='" + map + '\''); - } - - return new PolarisPropertySource(namespace, group, "", compositeConfigFile, map); - } - - public static ConfigKVFile loadConfigKVFile(ConfigFileService configFileService, String namespace, String group, String fileName) { - ConfigKVFile configKVFile; - // unknown extension is resolved as yaml file - if (ConfigFileFormat.isYamlFile(fileName) || ConfigFileFormat.isUnknownFile(fileName)) { - configKVFile = configFileService.getConfigYamlFile(namespace, group, fileName); - } - else if (ConfigFileFormat.isPropertyFile(fileName)) { - configKVFile = configFileService.getConfigPropertiesFile(namespace, group, fileName); - } - else { - LOGGER.warn("[SCT Config] Unsupported config file. namespace = {}, group = {}, fileName = {}", namespace, group, fileName); - - throw new IllegalStateException("Only configuration files in the format of properties / yaml / yaml" + " can be injected into the spring context"); - } - return configKVFile; - } /** * order: spring boot default config files > custom config files > tsf default config group. diff --git a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigPropertyAutoRefresher.java b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigPropertyAutoRefresher.java index 2ce7c5f96..5abd10a63 100644 --- a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigPropertyAutoRefresher.java +++ b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigPropertyAutoRefresher.java @@ -53,6 +53,9 @@ import org.springframework.core.env.PropertySource; import org.springframework.lang.NonNull; import org.springframework.util.CollectionUtils; +import static com.tencent.cloud.polaris.config.utils.PolarisPropertySourceUtils.loadGroupPolarisPropertySource; +import static com.tencent.cloud.polaris.config.utils.PolarisPropertySourceUtils.loadPolarisPropertySource; + /** * 1. Listen to the Polaris server configuration publishing event 2. Write the changed * configuration content to propertySource 3. Refresh the context through contextRefresher @@ -153,7 +156,7 @@ public abstract class PolarisConfigPropertyAutoRefresher implements ApplicationL registeredPolarisPropertySets.add(entry.getKey()); LOGGER.info("[SCT Config] add polaris config file:{}", entry.getKey()); ConfigFileMetadata configFileMetadata = entry.getValue(); - PolarisPropertySource p = PolarisConfigFileLocator.loadPolarisPropertySource( + PolarisPropertySource p = loadPolarisPropertySource( configFileService, configFileMetadata.getNamespace(), configFileMetadata.getFileGroup(), configFileMetadata.getFileName()); LOGGER.info("[SCT Config] changed property = {}", p.getSource().keySet()); @@ -194,7 +197,7 @@ public abstract class PolarisConfigPropertyAutoRefresher implements ApplicationL PolarisPropertySource newGroupSource = null; if (isGroupRefresh) { - newGroupSource = PolarisConfigFileLocator.loadGroupPolarisPropertySource(configFileService, + newGroupSource = loadGroupPolarisPropertySource(configFileService, effectPolarisPropertySource.getNamespace(), effectPolarisPropertySource.getGroup()); } @@ -301,7 +304,8 @@ public abstract class PolarisConfigPropertyAutoRefresher implements ApplicationL .withClientIp(context.getExtensions().getValueContext().getHost()) .withNamespace(polarisPropertySource.getNamespace()) .withConfigGroup(polarisPropertySource.getGroup()) - .withConfigVersion(Optional.ofNullable(configKVFileChangeEvent.getConfigFile()).map(ConfigFile::getName).orElse(null)) + .withConfigVersion(Optional.ofNullable(configKVFileChangeEvent.getConfigFile()).map(ConfigFile::getName) + .orElse(null)) .withConfigFileName(polarisPropertySource.getFileName()); BaseFlow.reportConfigEvent(context.getExtensions(), builder.build()); diff --git a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/tsf/PolarisAdaptorTsfConfigAutoConfiguration.java b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/tsf/PolarisAdaptorTsfConfigAutoConfiguration.java index 589305f7c..ee8f86ca7 100644 --- a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/tsf/PolarisAdaptorTsfConfigAutoConfiguration.java +++ b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/tsf/PolarisAdaptorTsfConfigAutoConfiguration.java @@ -17,7 +17,7 @@ package com.tencent.cloud.polaris.config.tsf; -import com.tencent.cloud.common.tsf.ConditionalOnTsfConsulEnabled; +import com.tencent.cloud.common.tsf.ConditionalOnOnlyTsfConsulEnabled; import com.tencent.cloud.polaris.config.ConditionalOnPolarisConfigEnabled; import com.tencent.cloud.polaris.config.tsf.controller.PolarisAdaptorTsfConfigController; import com.tencent.tsf.consul.config.watch.TsfConsulConfigRefreshEventListener; @@ -33,7 +33,7 @@ import org.springframework.context.annotation.Configuration; * @Date Jul 23, 2023 3:52:48 PM */ @Configuration(proxyBeanMethods = false) -@ConditionalOnTsfConsulEnabled +@ConditionalOnOnlyTsfConsulEnabled @ConditionalOnPolarisConfigEnabled public class PolarisAdaptorTsfConfigAutoConfiguration { diff --git a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/utils/PolarisPropertySourceUtils.java b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/utils/PolarisPropertySourceUtils.java index e6721cde9..31980f67c 100644 --- a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/utils/PolarisPropertySourceUtils.java +++ b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/utils/PolarisPropertySourceUtils.java @@ -17,6 +17,20 @@ package com.tencent.cloud.polaris.config.utils; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +import com.tencent.cloud.polaris.config.adapter.PolarisPropertySource; +import com.tencent.cloud.polaris.config.enums.ConfigFileFormat; +import com.tencent.polaris.configuration.api.core.ConfigFileMetadata; +import com.tencent.polaris.configuration.api.core.ConfigFileService; +import com.tencent.polaris.configuration.api.core.ConfigKVFile; +import com.tencent.polaris.configuration.client.internal.CompositeConfigFile; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + /** * Utils for PolarisPropertySource. * @@ -24,6 +38,8 @@ package com.tencent.cloud.polaris.config.utils; */ public final class PolarisPropertySourceUtils { + private static final Logger LOGGER = LoggerFactory.getLogger(PolarisPropertySourceUtils.class); + private PolarisPropertySourceUtils() { } @@ -31,4 +47,63 @@ public final class PolarisPropertySourceUtils { public static String generateName(String namespace, String group, String fileName) { return namespace + "-" + group + "-" + fileName; } + + public static PolarisPropertySource loadPolarisPropertySource(ConfigFileService configFileService, String namespace, String group, String fileName) { + ConfigKVFile configKVFile = loadConfigKVFile(configFileService, namespace, group, fileName); + + Map map = new ConcurrentHashMap<>(); + for (String key : configKVFile.getPropertyNames()) { + map.put(key, configKVFile.getProperty(key, null)); + } + + return new PolarisPropertySource(namespace, group, fileName, configKVFile, map); + } + + public static PolarisPropertySource loadGroupPolarisPropertySource(ConfigFileService configFileService, String namespace, String group) { + List configKVFiles = new ArrayList<>(); + + com.tencent.polaris.configuration.api.core.ConfigFileGroup remoteGroup = configFileService.getConfigFileGroup(namespace, group); + if (remoteGroup == null) { + return null; + } + + for (ConfigFileMetadata configFile : remoteGroup.getConfigFileMetadataList()) { + String fileName = configFile.getFileName(); + ConfigKVFile configKVFile = loadConfigKVFile(configFileService, namespace, group, fileName); + configKVFiles.add(configKVFile); + } + + CompositeConfigFile compositeConfigFile = new CompositeConfigFile(configKVFiles); + + Map map = new ConcurrentHashMap<>(); + for (String key : compositeConfigFile.getPropertyNames()) { + String value = compositeConfigFile.getProperty(key, null); + map.put(key, value); + } + + if (LOGGER.isDebugEnabled()) { + LOGGER.debug("namespace='" + namespace + '\'' + + ", group='" + group + '\'' + ", fileName='" + compositeConfigFile + '\'' + + ", map='" + map + '\''); + } + + return new PolarisPropertySource(namespace, group, "", compositeConfigFile, map); + } + + public static ConfigKVFile loadConfigKVFile(ConfigFileService configFileService, String namespace, String group, String fileName) { + ConfigKVFile configKVFile; + // unknown extension is resolved as yaml file + if (ConfigFileFormat.isYamlFile(fileName) || ConfigFileFormat.isUnknownFile(fileName)) { + configKVFile = configFileService.getConfigYamlFile(namespace, group, fileName); + } + else if (ConfigFileFormat.isPropertyFile(fileName)) { + configKVFile = configFileService.getConfigPropertiesFile(namespace, group, fileName); + } + else { + LOGGER.warn("[SCT Config] Unsupported config file. namespace = {}, group = {}, fileName = {}", namespace, group, fileName); + + throw new IllegalStateException("Only configuration files in the format of properties / yaml / yaml" + " can be injected into the spring context"); + } + return configKVFile; + } } diff --git a/spring-cloud-starter-tencent-polaris-config/src/test/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigFileLocatorTest.java b/spring-cloud-starter-tencent-polaris-config/src/test/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigFileLocatorTest.java index 3bb1cc392..f6c6abb85 100644 --- a/spring-cloud-starter-tencent-polaris-config/src/test/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigFileLocatorTest.java +++ b/spring-cloud-starter-tencent-polaris-config/src/test/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigFileLocatorTest.java @@ -27,25 +27,35 @@ import java.util.Map; import com.tencent.cloud.polaris.config.config.ConfigFileGroup; import com.tencent.cloud.polaris.config.config.PolarisConfigProperties; +import com.tencent.cloud.polaris.config.enums.RefreshType; +import com.tencent.cloud.polaris.config.utils.PolarisPropertySourceUtils; import com.tencent.cloud.polaris.context.config.PolarisContextProperties; import com.tencent.polaris.configuration.api.core.ConfigFileService; import com.tencent.polaris.configuration.api.core.ConfigKVFile; import com.tencent.polaris.configuration.client.internal.RevisableConfigFileGroup; +import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; import org.mockito.Mock; +import org.mockito.MockedStatic; import org.mockito.junit.jupiter.MockitoExtension; +import org.springframework.core.env.CompositePropertySource; import org.springframework.core.env.Environment; import org.springframework.core.env.PropertySource; import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.mockStatic; import static org.mockito.Mockito.when; /** * test for {@link PolarisConfigFileLocator}. - *@author lepdou 2022-06-11 + * + * @author lepdou 2022-06-11 */ @ExtendWith(MockitoExtension.class) public class PolarisConfigFileLocatorTest { @@ -268,6 +278,99 @@ public class PolarisConfigFileLocatorTest { assertThat(propertySource.getProperty("k3")).isEqualTo("v3"); } + @Test + void testInitTsfConfigGroupsSuccessfulLoad() { + clearCompositePropertySourceCache(); + + // Arrange + String tsfId = "test-id"; + String tsfNamespace = "test-namespace"; + String tsfGroup = "test-group"; + String polarisNamespace = "polaris-namespace"; + + when(environment.getProperty("tsf_id")).thenReturn(tsfId); + when(environment.getProperty("tsf_namespace_name")).thenReturn(tsfNamespace); + when(environment.getProperty("tsf_group_name")).thenReturn(tsfGroup); + when(polarisContextProperties.getNamespace()).thenReturn(polarisNamespace); + + String expectedAppConfigGroup = tsfId + "." + tsfGroup + ".application_config_group"; + + // mock polaris config properties + PolarisPropertySource mockPropertySource = mock(PolarisPropertySource.class); + when(mockPropertySource.getPropertySourceName()).thenReturn(expectedAppConfigGroup); + + CompositePropertySource compositePropertySource = mock(CompositePropertySource.class); + try (MockedStatic mockedStatic = mockStatic(PolarisPropertySourceUtils.class)) { + mockedStatic.when(() -> PolarisPropertySourceUtils.loadGroupPolarisPropertySource( + eq(configFileService), + eq(polarisNamespace), + any() + )).thenReturn(mockPropertySource); + + PolarisConfigFileLocator locator = new PolarisConfigFileLocator( + polarisConfigProperties, + polarisContextProperties, + configFileService, + environment + ); + // Act + locator.initTsfConfigGroups(compositePropertySource); + + // Verify + List polarisPropertySources = PolarisPropertySourceManager.getAllPropertySources(); + assertThat(polarisPropertySources.stream().map(PolarisPropertySource::getPropertySourceName). + filter(name -> name.equals(expectedAppConfigGroup)).count() == 1); + } + } + + @Test + void testPolarisConfigProperties() { + PolarisConfigProperties testProperties = new PolarisConfigProperties(); + boolean enabled = true; + String address = "127.0.0.1"; + int port = 1234; + String token = ""; + boolean autoRefresh = true; + RefreshType refreshType = RefreshType.REFRESH_CONTEXT; + List groups = new LinkedList<>(); + boolean preference = true; + String dataSource = "test-data-source"; + String localFileRootPath = "test-local-file-root-path"; + boolean internalEnabled = true; + boolean checkAddress = true; + boolean shutdownIfConnectToConfigServerFailed = true; + + testProperties.setEnabled(enabled); + testProperties.setAddress(address); + testProperties.setPort(port); + testProperties.setToken(token); + testProperties.setAutoRefresh(autoRefresh); + testProperties.setRefreshType(refreshType); + testProperties.setGroups(groups); + testProperties.setPreference(preference); + testProperties.setDataSource(dataSource); + testProperties.setLocalFileRootPath(localFileRootPath); + testProperties.setInternalEnabled(internalEnabled); + testProperties.setCheckAddress(checkAddress); + testProperties.setShutdownIfConnectToConfigServerFailed(shutdownIfConnectToConfigServerFailed); + + Assertions.assertEquals(enabled, testProperties.isEnabled()); + Assertions.assertEquals(address, testProperties.getAddress()); + Assertions.assertEquals(port, testProperties.getPort()); + Assertions.assertEquals(token, testProperties.getToken()); + Assertions.assertEquals(autoRefresh, testProperties.isAutoRefresh()); + Assertions.assertEquals(refreshType, testProperties.getRefreshType()); + Assertions.assertEquals(groups, testProperties.getGroups()); + Assertions.assertEquals(preference, testProperties.isPreference()); + Assertions.assertEquals(dataSource, testProperties.getDataSource()); + Assertions.assertEquals(localFileRootPath, testProperties.getLocalFileRootPath()); + Assertions.assertEquals(internalEnabled, testProperties.isInternalEnabled()); + Assertions.assertEquals(checkAddress, testProperties.isCheckAddress()); + Assertions.assertEquals(shutdownIfConnectToConfigServerFailed, testProperties.isShutdownIfConnectToConfigServerFailed()); + + Assertions.assertNotNull(testProperties.toString()); + } + private void clearCompositePropertySourceCache() { try { Class clazz = PolarisConfigFileLocator.class; diff --git a/spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/registry/PolarisRegistration.java b/spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/registry/PolarisRegistration.java index 1738f2d69..51f190c9e 100644 --- a/spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/registry/PolarisRegistration.java +++ b/spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/registry/PolarisRegistration.java @@ -237,6 +237,13 @@ public class PolarisRegistration implements Registration { return registerEnabled; } + public String getNamespace() { + if (polarisDiscoveryProperties != null) { + return polarisDiscoveryProperties.getNamespace(); + } + return null; + } + public SDKContext getPolarisContext() { return polarisContext; } diff --git a/spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/registry/PolarisServiceRegistry.java b/spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/registry/PolarisServiceRegistry.java index c6816a0f5..40e5ab59a 100644 --- a/spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/registry/PolarisServiceRegistry.java +++ b/spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/registry/PolarisServiceRegistry.java @@ -199,6 +199,7 @@ public class PolarisServiceRegistry implements ServiceRegistry metadata = configuration.getProvider().getRateLimit().getMetadata(); - metadata.put(TsfRateLimitConstants.RATE_LIMIT_MASTER_IP_KEY, tsfCoreProperties.getRatelimitMasterIp()); - metadata.put(TsfRateLimitConstants.RATE_LIMIT_MASTER_PORT_KEY, String.valueOf(tsfCoreProperties.getRatelimitMasterPort())); - metadata.put(TsfRateLimitConstants.SERVICE_NAME_KEY, tsfCoreProperties.getServiceName()); - metadata.put(TsfRateLimitConstants.INSTANCE_ID_KEY, tsfCoreProperties.getInstanceId()); - metadata.put(TsfRateLimitConstants.TOKEN_KEY, consulProperties.getAclToken()); - } + Map metadata = configuration.getProvider().getRateLimit().getMetadata(); + metadata.put(TsfRateLimitConstants.RATE_LIMIT_MASTER_IP_KEY, tsfCoreProperties.getRatelimitMasterIp()); + metadata.put(TsfRateLimitConstants.RATE_LIMIT_MASTER_PORT_KEY, String.valueOf(tsfCoreProperties.getRatelimitMasterPort())); + metadata.put(TsfRateLimitConstants.SERVICE_NAME_KEY, tsfCoreProperties.getServiceName()); + metadata.put(TsfRateLimitConstants.INSTANCE_ID_KEY, tsfCoreProperties.getInstanceId()); + metadata.put(TsfRateLimitConstants.TOKEN_KEY, consulProperties.getAclToken()); } @Override diff --git a/spring-cloud-tencent-commons/src/main/java/com/tencent/cloud/common/tsf/ConditionalOnOnlyTsfConsulEnabled.java b/spring-cloud-tencent-commons/src/main/java/com/tencent/cloud/common/tsf/ConditionalOnOnlyTsfConsulEnabled.java new file mode 100644 index 000000000..e431c087b --- /dev/null +++ b/spring-cloud-tencent-commons/src/main/java/com/tencent/cloud/common/tsf/ConditionalOnOnlyTsfConsulEnabled.java @@ -0,0 +1,47 @@ +/* + * Tencent is pleased to support the open source community by making spring-cloud-tencent available. + * + * Copyright (C) 2021 THL A29 Limited, a Tencent company. All rights reserved. + * + * Licensed under the BSD 3-Clause License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://opensource.org/licenses/BSD-3-Clause + * + * 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 com.tencent.cloud.common.tsf; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +import org.springframework.context.annotation.Condition; +import org.springframework.context.annotation.ConditionContext; +import org.springframework.context.annotation.Conditional; +import org.springframework.core.type.AnnotatedTypeMetadata; + +/** + * Condition that if Only TSF Consul enabled. + * + * @author Haotian Zhang + */ +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.TYPE, ElementType.METHOD}) +@Conditional(ConditionalOnOnlyTsfConsulEnabled.OnTsfEnabledCondition.class) +public @interface ConditionalOnOnlyTsfConsulEnabled { + + class OnTsfEnabledCondition implements Condition { + + @Override + public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) { + return TsfContextUtils.isOnlyTsfConsulEnabled(conditionContext.getEnvironment()); + } + } +} diff --git a/spring-cloud-tencent-commons/src/main/java/com/tencent/cloud/common/tsf/ConditionalOnTsfConsulEnabled.java b/spring-cloud-tencent-commons/src/main/java/com/tencent/cloud/common/tsf/ConditionalOnTsfConsulEnabled.java index f576d219e..d04180349 100644 --- a/spring-cloud-tencent-commons/src/main/java/com/tencent/cloud/common/tsf/ConditionalOnTsfConsulEnabled.java +++ b/spring-cloud-tencent-commons/src/main/java/com/tencent/cloud/common/tsf/ConditionalOnTsfConsulEnabled.java @@ -22,16 +22,13 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; -import com.tencent.polaris.api.utils.StringUtils; - import org.springframework.context.annotation.Condition; import org.springframework.context.annotation.ConditionContext; import org.springframework.context.annotation.Conditional; -import org.springframework.core.env.Environment; import org.springframework.core.type.AnnotatedTypeMetadata; /** - * Condition that if Polaris enabled. + * Condition that if TSF Consul enabled. * * @author Haotian Zhang */ @@ -44,20 +41,7 @@ public @interface ConditionalOnTsfConsulEnabled { @Override public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) { - Environment environment = conditionContext.getEnvironment(); - boolean tsfConsulEnable = false; - - String tsfAppId = environment.getProperty("tsf_app_id"); - if (StringUtils.isNotBlank(tsfAppId)) { - String tsfConsulIp = environment.getProperty("tsf_consul_ip"); - String tsePolarisAddress = environment.getProperty("polaris_address"); - if (StringUtils.isBlank(tsePolarisAddress) && StringUtils.isNotBlank(environment.getProperty("spring.cloud.polaris.address"))) { - tsePolarisAddress = environment.getProperty("spring.cloud.polaris.address"); - } - tsfConsulEnable = StringUtils.isNotBlank(tsfConsulIp) && StringUtils.isBlank(tsePolarisAddress); - } - - return tsfConsulEnable; + return TsfContextUtils.isTsfConsulEnabled(conditionContext.getEnvironment()); } } } diff --git a/spring-cloud-tencent-commons/src/main/java/com/tencent/cloud/common/tsf/TsfContextUtils.java b/spring-cloud-tencent-commons/src/main/java/com/tencent/cloud/common/tsf/TsfContextUtils.java new file mode 100644 index 000000000..8049e7fb5 --- /dev/null +++ b/spring-cloud-tencent-commons/src/main/java/com/tencent/cloud/common/tsf/TsfContextUtils.java @@ -0,0 +1,80 @@ +/* + * Tencent is pleased to support the open source community by making spring-cloud-tencent available. + * + * Copyright (C) 2021 THL A29 Limited, a Tencent company. All rights reserved. + * + * Licensed under the BSD 3-Clause License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://opensource.org/licenses/BSD-3-Clause + * + * 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 com.tencent.cloud.common.tsf; + +import java.util.concurrent.atomic.AtomicBoolean; + +import com.tencent.polaris.api.utils.StringUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import org.springframework.core.env.Environment; + +/** + * Utils for TSF. + * + * @author Haotian Zhang + */ +public final class TsfContextUtils { + + private static final Logger LOG = LoggerFactory.getLogger(TsfContextUtils.class); + + private static final AtomicBoolean isTsfConsulEnabledFirstConfiguration = new AtomicBoolean(true); + + private static final AtomicBoolean isOnlyTsfConsulEnabledFirstConfiguration = new AtomicBoolean(true); + + private static boolean tsfConsulEnabled = false; + + private static boolean onlyTsfConsulEnabled = false; + + private TsfContextUtils() { + } + + public static boolean isTsfConsulEnabled(Environment environment) { + if (environment != null && isTsfConsulEnabledFirstConfiguration.compareAndSet(true, false)) { + if (isOnlyTsfConsulEnabled(environment)) { + tsfConsulEnabled = true; + } + else { + boolean consulEnabled = Boolean.parseBoolean(environment.getProperty("tsf_consul_enable", "true")); + String tsfConsulIp = environment.getProperty("tsf_consul_ip"); + tsfConsulEnabled = consulEnabled && StringUtils.isNotBlank(tsfConsulIp); + if (tsfConsulEnabled) { + LOG.info("Tsf Consul is enabled: {}", tsfConsulIp); + } + } + } + return tsfConsulEnabled; + } + + public static boolean isOnlyTsfConsulEnabled(Environment environment) { + if (environment != null && isOnlyTsfConsulEnabledFirstConfiguration.compareAndSet(true, false)) { + boolean consulEnabled = Boolean.parseBoolean(environment.getProperty("tsf_consul_enable", "true")); + String tsfConsulIp = environment.getProperty("tsf_consul_ip"); + String polarisAddress = environment.getProperty("polaris_address"); + if (StringUtils.isBlank(polarisAddress) && StringUtils.isNotBlank(environment.getProperty("spring.cloud.polaris.address"))) { + polarisAddress = environment.getProperty("spring.cloud.polaris.address"); + } + onlyTsfConsulEnabled = consulEnabled && StringUtils.isNotBlank(tsfConsulIp) && StringUtils.isBlank(polarisAddress); + if (onlyTsfConsulEnabled) { + LOG.info("Only Tsf Consul is enabled: {}", tsfConsulIp); + } + } + return onlyTsfConsulEnabled; + } +} diff --git a/spring-cloud-tencent-coverage/pom.xml b/spring-cloud-tencent-coverage/pom.xml index 9be11f8dc..d855f8568 100644 --- a/spring-cloud-tencent-coverage/pom.xml +++ b/spring-cloud-tencent-coverage/pom.xml @@ -94,6 +94,12 @@ com.tencent.cloud spring-cloud-tencent-lossless-plugin + + + com.tencent.cloud + spring-cloud-starter-tencent-multi-discovery-plugin + ${revision} + diff --git a/spring-cloud-tencent-dependencies/pom.xml b/spring-cloud-tencent-dependencies/pom.xml index 8ae7b7f9b..0fa9662c0 100644 --- a/spring-cloud-tencent-dependencies/pom.xml +++ b/spring-cloud-tencent-dependencies/pom.xml @@ -223,6 +223,12 @@ ${revision} + + com.tencent.cloud + spring-cloud-starter-tencent-multi-discovery-plugin + ${revision} + + com.google.guava guava diff --git a/spring-cloud-tencent-plugin-starters/pom.xml b/spring-cloud-tencent-plugin-starters/pom.xml index 1ba1a6322..9563cc3ff 100644 --- a/spring-cloud-tencent-plugin-starters/pom.xml +++ b/spring-cloud-tencent-plugin-starters/pom.xml @@ -22,6 +22,7 @@ spring-cloud-starter-tencent-trace-plugin spring-cloud-starter-tencent-fault-tolerance spring-cloud-tencent-security-protection-plugin + spring-cloud-starter-tencent-multi-discovery-plugin diff --git a/spring-cloud-tencent-plugin-starters/spring-cloud-starter-tencent-multi-discovery-plugin/pom.xml b/spring-cloud-tencent-plugin-starters/spring-cloud-starter-tencent-multi-discovery-plugin/pom.xml new file mode 100644 index 000000000..c018dc90f --- /dev/null +++ b/spring-cloud-tencent-plugin-starters/spring-cloud-starter-tencent-multi-discovery-plugin/pom.xml @@ -0,0 +1,25 @@ + + + spring-cloud-tencent-plugin-starters + com.tencent.cloud + ${revision} + ../pom.xml + + 4.0.0 + spring-cloud-starter-tencent-multi-discovery-plugin + Spring Cloud Tencent Multi Discovery Plugin + + + + + com.tencent.cloud + spring-cloud-starter-tencent-polaris-discovery + + + + com.tencent.cloud + spring-cloud-starter-tencent-polaris-config + + + diff --git a/spring-cloud-tencent-plugin-starters/spring-cloud-starter-tencent-multi-discovery-plugin/src/main/java/com/tencent/cloud/plugin/discovery/multi/config/MultiDiscoveryAutoConfiguration.java b/spring-cloud-tencent-plugin-starters/spring-cloud-starter-tencent-multi-discovery-plugin/src/main/java/com/tencent/cloud/plugin/discovery/multi/config/MultiDiscoveryAutoConfiguration.java new file mode 100644 index 000000000..b2d676f79 --- /dev/null +++ b/spring-cloud-tencent-plugin-starters/spring-cloud-starter-tencent-multi-discovery-plugin/src/main/java/com/tencent/cloud/plugin/discovery/multi/config/MultiDiscoveryAutoConfiguration.java @@ -0,0 +1,46 @@ +/* + * Tencent is pleased to support the open source community by making spring-cloud-tencent available. + * + * Copyright (C) 2021 THL A29 Limited, a Tencent company. All rights reserved. + * + * Licensed under the BSD 3-Clause License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://opensource.org/licenses/BSD-3-Clause + * + * 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 com.tencent.cloud.plugin.discovery.multi.config; + +import com.tencent.cloud.plugin.discovery.multi.listeners.ConsulDiscoveryConfigChangeListener; +import com.tencent.cloud.polaris.registry.PolarisRegistration; + +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +/** + * Auto configuration for multi discovery. + * + * @author Haotian Zhang + */ +@Configuration(proxyBeanMethods = false) +public class MultiDiscoveryAutoConfiguration { + + @Configuration(proxyBeanMethods = false) + @ConditionalOnProperty(value = "spring.cloud.consul.enabled", havingValue = "true") + protected static class ConsulMultiDiscoveryConfig { + + @Bean + @ConditionalOnMissingBean + public ConsulDiscoveryConfigChangeListener consulDiscoveryConfigChangeListener(PolarisRegistration polarisRegistration) { + return new ConsulDiscoveryConfigChangeListener(polarisRegistration); + } + } +} diff --git a/spring-cloud-tencent-plugin-starters/spring-cloud-starter-tencent-multi-discovery-plugin/src/main/java/com/tencent/cloud/plugin/discovery/multi/listeners/ConsulDiscoveryConfigChangeListener.java b/spring-cloud-tencent-plugin-starters/spring-cloud-starter-tencent-multi-discovery-plugin/src/main/java/com/tencent/cloud/plugin/discovery/multi/listeners/ConsulDiscoveryConfigChangeListener.java new file mode 100644 index 000000000..6f602444c --- /dev/null +++ b/spring-cloud-tencent-plugin-starters/spring-cloud-starter-tencent-multi-discovery-plugin/src/main/java/com/tencent/cloud/plugin/discovery/multi/listeners/ConsulDiscoveryConfigChangeListener.java @@ -0,0 +1,114 @@ +/* + * Tencent is pleased to support the open source community by making spring-cloud-tencent available. + * + * Copyright (C) 2021 THL A29 Limited, a Tencent company. All rights reserved. + * + * Licensed under the BSD 3-Clause License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://opensource.org/licenses/BSD-3-Clause + * + * 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 com.tencent.cloud.plugin.discovery.multi.listeners; + +import java.util.Set; + +import com.tencent.cloud.polaris.config.annotation.PolarisConfigKVFileChangeListener; +import com.tencent.cloud.polaris.config.listener.ConfigChangeEvent; +import com.tencent.cloud.polaris.registry.PolarisRegistration; +import com.tencent.polaris.api.plugin.common.PluginTypes; +import com.tencent.polaris.api.plugin.server.ServerConnector; +import com.tencent.polaris.api.rpc.InstanceRegisterRequest; +import com.tencent.polaris.api.utils.StringUtils; +import com.tencent.polaris.client.api.SDKContext; +import com.tencent.polaris.discovery.client.flow.RegisterStateManager; +import com.tencent.polaris.plugins.connector.common.DestroyableServerConnector; +import com.tencent.polaris.plugins.connector.composite.CompositeConnector; +import com.tencent.polaris.plugins.connector.consul.ConsulAPIConnector; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Consul Discovery Config Listener . + * + * @author Haotian Zhang + */ +public final class ConsulDiscoveryConfigChangeListener { + + private static final Logger LOG = LoggerFactory.getLogger(ConsulDiscoveryConfigChangeListener.class); + + private final PolarisRegistration polarisRegistration; + + private final SDKContext sdkContext; + private final ConsulAPIConnector consulAPIConnector; + private InstanceRegisterRequest instanceRegisterRequest; + + public ConsulDiscoveryConfigChangeListener(PolarisRegistration polarisRegistration) { + this.polarisRegistration = polarisRegistration; + this.sdkContext = polarisRegistration.getPolarisContext(); + + ServerConnector connector = (ServerConnector) sdkContext.getPlugins() + .getPlugin(PluginTypes.SERVER_CONNECTOR.getBaseType(), sdkContext.getValueContext() + .getServerConnectorProtocol()); + ConsulAPIConnector temp = null; + if (connector instanceof CompositeConnector) { + CompositeConnector compositeConnector = (CompositeConnector) connector; + for (DestroyableServerConnector sc : compositeConnector.getServerConnectors()) { + if (sc instanceof ConsulAPIConnector) { + temp = (ConsulAPIConnector) sc; + break; + } + } + } + else if (connector instanceof ConsulAPIConnector) { + temp = (ConsulAPIConnector) connector; + } + this.consulAPIConnector = temp; + } + + @PolarisConfigKVFileChangeListener(interestedKeyPrefixes = "spring.cloud.consul.discovery") + public void onChange(ConfigChangeEvent event) { + if (consulAPIConnector != null) { + initInstanceRegisterRequest(); + + Set changedKeys = event.changedKeys(); + for (String changedKey : changedKeys) { + if (StringUtils.equals(changedKey, "spring.cloud.consul.discovery.enabled")) { + LOG.info("{} = {}", changedKey, event.getChange(changedKey)); + boolean discoveryEnabled = !StringUtils.equals("false", event.getChange(changedKey).getNewValue() + .toString()); + consulAPIConnector.setDiscoveryEnable(discoveryEnabled); + } + else if (StringUtils.equals(changedKey, "spring.cloud.consul.discovery.register")) { + LOG.info("{} = {}", changedKey, event.getChange(changedKey)); + boolean registerEnabled = !StringUtils.equals("false", event.getChange(changedKey).getNewValue() + .toString()); + if (registerEnabled) { + consulAPIConnector.registerInstance(RegisterStateManager.getRegisterState(sdkContext, instanceRegisterRequest) + .getInstanceRegisterRequest().getRequest(), null); + } + else { + consulAPIConnector.deregisterInstance(RegisterStateManager.getRegisterState(sdkContext, instanceRegisterRequest) + .getInstanceRegisterRequest().getRequest()); + } + } + } + } + } + + private void initInstanceRegisterRequest() { + if (instanceRegisterRequest == null) { + this.instanceRegisterRequest = new InstanceRegisterRequest(); + instanceRegisterRequest.setNamespace(polarisRegistration.getNamespace()); + instanceRegisterRequest.setService(polarisRegistration.getServiceId()); + instanceRegisterRequest.setHost(polarisRegistration.getHost()); + instanceRegisterRequest.setPort(polarisRegistration.getPort()); + } + } +} diff --git a/spring-cloud-tencent-plugin-starters/spring-cloud-starter-tencent-multi-discovery-plugin/src/main/resources/META-INF/spring.factories b/spring-cloud-tencent-plugin-starters/spring-cloud-starter-tencent-multi-discovery-plugin/src/main/resources/META-INF/spring.factories new file mode 100644 index 000000000..74518ad07 --- /dev/null +++ b/spring-cloud-tencent-plugin-starters/spring-cloud-starter-tencent-multi-discovery-plugin/src/main/resources/META-INF/spring.factories @@ -0,0 +1,2 @@ +org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ + com.tencent.cloud.plugin.discovery.multi.config.MultiDiscoveryAutoConfiguration diff --git a/spring-cloud-tencent-plugin-starters/spring-cloud-tencent-security-protection-plugin/pom.xml b/spring-cloud-tencent-plugin-starters/spring-cloud-tencent-security-protection-plugin/pom.xml index 1674db4e8..d893b7164 100644 --- a/spring-cloud-tencent-plugin-starters/spring-cloud-tencent-security-protection-plugin/pom.xml +++ b/spring-cloud-tencent-plugin-starters/spring-cloud-tencent-security-protection-plugin/pom.xml @@ -11,7 +11,7 @@ 4.0.0 spring-cloud-tencent-security-protection-plugin - Spring Cloud Tencent Lossless Plugin + Spring Cloud Tencent Security Protection Plugin diff --git a/spring-cloud-tencent-polaris-context/src/main/java/com/tencent/cloud/polaris/context/config/extend/tsf/TsfContextAutoConfiguration.java b/spring-cloud-tencent-polaris-context/src/main/java/com/tencent/cloud/polaris/context/config/extend/tsf/TsfContextAutoConfiguration.java index aa8a704c9..1d2cbd3e7 100644 --- a/spring-cloud-tencent-polaris-context/src/main/java/com/tencent/cloud/polaris/context/config/extend/tsf/TsfContextAutoConfiguration.java +++ b/spring-cloud-tencent-polaris-context/src/main/java/com/tencent/cloud/polaris/context/config/extend/tsf/TsfContextAutoConfiguration.java @@ -17,7 +17,7 @@ package com.tencent.cloud.polaris.context.config.extend.tsf; -import com.tencent.cloud.common.tsf.ConditionalOnTsfConsulEnabled; +import com.tencent.cloud.common.tsf.ConditionalOnOnlyTsfConsulEnabled; import com.tencent.cloud.polaris.context.config.PolarisContextAutoConfiguration; import com.tencent.cloud.polaris.context.config.extend.consul.ConsulProperties; @@ -33,7 +33,7 @@ import org.springframework.context.annotation.Configuration; */ @Configuration(proxyBeanMethods = false) @AutoConfigureAfter(PolarisContextAutoConfiguration.class) -@ConditionalOnTsfConsulEnabled +@ConditionalOnOnlyTsfConsulEnabled public class TsfContextAutoConfiguration { @Bean diff --git a/spring-cloud-tencent-polaris-context/src/main/java/com/tencent/cloud/polaris/context/config/extend/tsf/TsfContextUtils.java b/spring-cloud-tencent-polaris-context/src/main/java/com/tencent/cloud/polaris/context/config/extend/tsf/TsfContextUtils.java deleted file mode 100644 index b058f9005..000000000 --- a/spring-cloud-tencent-polaris-context/src/main/java/com/tencent/cloud/polaris/context/config/extend/tsf/TsfContextUtils.java +++ /dev/null @@ -1,58 +0,0 @@ -/* - * Tencent is pleased to support the open source community by making spring-cloud-tencent available. - * - * Copyright (C) 2021 THL A29 Limited, a Tencent company. All rights reserved. - * - * Licensed under the BSD 3-Clause License (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * https://opensource.org/licenses/BSD-3-Clause - * - * 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 com.tencent.cloud.polaris.context.config.extend.tsf; - -import java.util.concurrent.atomic.AtomicBoolean; - -import com.tencent.polaris.api.utils.StringUtils; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import org.springframework.core.env.Environment; - -/** - * Utils for TSF. - * - * @author Haotian Zhang - */ -public final class TsfContextUtils { - - private static final Logger LOG = LoggerFactory.getLogger(TsfContextUtils.class); - - private static final AtomicBoolean isFirstConfiguration = new AtomicBoolean(true); - - private static boolean tsfConsulEnabled = false; - - private TsfContextUtils() { - } - - public static boolean isTsfConsulEnabled(Environment environment) { - if (environment != null && isFirstConfiguration.compareAndSet(true, false)) { - String tsfConsulIp = environment.getProperty("tsf_consul_ip"); - String tsePolarisAddress = environment.getProperty("polaris_address"); - if (StringUtils.isBlank(tsePolarisAddress) && StringUtils.isNotBlank(environment.getProperty("spring.cloud.polaris.address"))) { - tsePolarisAddress = environment.getProperty("spring.cloud.polaris.address"); - } - tsfConsulEnabled = StringUtils.isNotBlank(tsfConsulIp) && StringUtils.isBlank(tsePolarisAddress); - if (tsfConsulEnabled) { - LOG.info("Tsf Consul is enabled: {}", tsfConsulIp); - } - } - return tsfConsulEnabled; - } -} diff --git a/spring-cloud-tencent-polaris-context/src/main/java/com/tencent/cloud/polaris/context/config/extend/tsf/TsfCoreEnvironmentPostProcessor.java b/spring-cloud-tencent-polaris-context/src/main/java/com/tencent/cloud/polaris/context/config/extend/tsf/TsfCoreEnvironmentPostProcessor.java index a3261d2f6..c184ce352 100644 --- a/spring-cloud-tencent-polaris-context/src/main/java/com/tencent/cloud/polaris/context/config/extend/tsf/TsfCoreEnvironmentPostProcessor.java +++ b/spring-cloud-tencent-polaris-context/src/main/java/com/tencent/cloud/polaris/context/config/extend/tsf/TsfCoreEnvironmentPostProcessor.java @@ -20,6 +20,7 @@ package com.tencent.cloud.polaris.context.config.extend.tsf; import java.util.HashMap; import java.util.Map; +import com.tencent.cloud.common.tsf.TsfContextUtils; import com.tencent.polaris.api.utils.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -61,13 +62,13 @@ public final class TsfCoreEnvironmentPostProcessor implements EnvironmentPostPro // enabled String polarisEnabled = environment.getProperty("spring.cloud.polaris.enabled"); if (StringUtils.isBlank(polarisEnabled)) { - defaultProperties.put("spring.cloud.polaris.enabled", true); + defaultProperties.put("spring.cloud.polaris.enabled", "true"); } // lossless String polarisAdminPort = environment.getProperty("polaris_admin_port"); if (StringUtils.isNotBlank(polarisAdminPort)) { - defaultProperties.put("spring.cloud.polaris.lossless.enabled", true); + defaultProperties.put("spring.cloud.polaris.lossless.enabled", environment.getProperty("spring.cloud.polaris.lossless.enabled", "true")); } if (TsfContextUtils.isTsfConsulEnabled(environment)) { @@ -111,16 +112,12 @@ public final class TsfCoreEnvironmentPostProcessor implements EnvironmentPostPro // context defaultProperties.put("spring.cloud.polaris.enabled", "true"); - defaultProperties.put("spring.cloud.polaris.discovery.enabled", "false"); - defaultProperties.put("spring.cloud.polaris.discovery.register", "false"); - defaultProperties.put("spring.cloud.consul.enabled", "true"); + defaultProperties.put("spring.cloud.consul.enabled", environment.getProperty("tsf_consul_enable", "true")); defaultProperties.put("spring.cloud.consul.host", tsfConsulIp); defaultProperties.put("spring.cloud.consul.port", tsfConsulPort); defaultProperties.put("spring.cloud.consul.token", tsfConsulToken); // discovery - defaultProperties.put("spring.cloud.consul.discovery.enabled", "true"); - defaultProperties.put("spring.cloud.consul.discovery.register", "true"); defaultProperties.put("spring.cloud.consul.discovery.instance-id", tsfInstanceId); defaultProperties.put("spring.cloud.polaris.discovery.instance-id", tsfInstanceId); defaultProperties.put("spring.cloud.polaris.discovery.zero-protection.enabled", @@ -144,25 +141,31 @@ public final class TsfCoreEnvironmentPostProcessor implements EnvironmentPostPro defaultProperties.put("spring.cloud.polaris.contract.report.enabled", environment.getProperty("tsf.swagger.enabled", "true")); defaultProperties.put("spring.cloud.polaris.contract.name", tsfApplicationId); - // configuration - defaultProperties.put("spring.cloud.polaris.config.enabled", "true"); - defaultProperties.put("spring.cloud.polaris.config.internal-enabled", "false"); - defaultProperties.put("spring.cloud.polaris.config.data-source", "consul"); - defaultProperties.put("spring.cloud.polaris.config.address", "http://" + tsfConsulIp + ":" + tsfConsulPort); - defaultProperties.put("spring.cloud.polaris.config.port", tsfConsulPort); - defaultProperties.put("spring.cloud.polaris.config.token", tsfConsulToken); - defaultProperties.put("spring.cloud.polaris.config.groups[0].namespace", "config"); - defaultProperties.put("spring.cloud.polaris.config.groups[0].name", "application"); - defaultProperties.put("spring.cloud.polaris.config.groups[0].files[0]", tsfApplicationId + "/" + tsfGroupId + "/"); - defaultProperties.put("spring.cloud.polaris.config.groups[0].files[1]", tsfNamespaceId + "/"); - defaultProperties.put("spring.cloud.polaris.config.refresh-type", - environment.getProperty("spring.cloud.polaris.config.refresh-type", "refresh_context")); - - // router - defaultProperties.put("spring.cloud.polaris.router.rule-router.fail-over", - environment.getProperty("spring.cloud.polaris.router.rule-router.fail-over", "none")); - defaultProperties.put("spring.cloud.polaris.router.namespace-router.enabled", - environment.getProperty("spring.cloud.polaris.router.namespace-router.enabled", "true")); + if (TsfContextUtils.isOnlyTsfConsulEnabled(environment)) { + // context + defaultProperties.put("spring.cloud.polaris.discovery.enabled", "false"); + defaultProperties.put("spring.cloud.polaris.discovery.register", "false"); + + // configuration + defaultProperties.put("spring.cloud.polaris.config.enabled", "true"); + defaultProperties.put("spring.cloud.polaris.config.internal-enabled", "false"); + defaultProperties.put("spring.cloud.polaris.config.data-source", "consul"); + defaultProperties.put("spring.cloud.polaris.config.address", "http://" + tsfConsulIp + ":" + tsfConsulPort); + defaultProperties.put("spring.cloud.polaris.config.port", tsfConsulPort); + defaultProperties.put("spring.cloud.polaris.config.token", tsfConsulToken); + defaultProperties.put("spring.cloud.polaris.config.groups[0].namespace", "config"); + defaultProperties.put("spring.cloud.polaris.config.groups[0].name", "application"); + defaultProperties.put("spring.cloud.polaris.config.groups[0].files[0]", tsfApplicationId + "/" + tsfGroupId + "/"); + defaultProperties.put("spring.cloud.polaris.config.groups[0].files[1]", tsfNamespaceId + "/"); + defaultProperties.put("spring.cloud.polaris.config.refresh-type", + environment.getProperty("spring.cloud.polaris.config.refresh-type", "refresh_context")); + + // router + defaultProperties.put("spring.cloud.polaris.router.rule-router.fail-over", + environment.getProperty("spring.cloud.polaris.router.rule-router.fail-over", "none")); + defaultProperties.put("spring.cloud.polaris.router.namespace-router.enabled", + environment.getProperty("spring.cloud.polaris.router.namespace-router.enabled", "true")); + } } MapPropertySource propertySource = new MapPropertySource("tsf-polaris-properties", defaultProperties); diff --git a/spring-cloud-tencent-polaris-context/src/main/java/com/tencent/cloud/polaris/context/config/extend/tsf/TsfLastEnvironmentPostProcessor.java b/spring-cloud-tencent-polaris-context/src/main/java/com/tencent/cloud/polaris/context/config/extend/tsf/TsfLastEnvironmentPostProcessor.java new file mode 100644 index 000000000..95f06ae4c --- /dev/null +++ b/spring-cloud-tencent-polaris-context/src/main/java/com/tencent/cloud/polaris/context/config/extend/tsf/TsfLastEnvironmentPostProcessor.java @@ -0,0 +1,58 @@ +/* + * Tencent is pleased to support the open source community by making spring-cloud-tencent available. + * + * Copyright (C) 2021 THL A29 Limited, a Tencent company. All rights reserved. + * + * Licensed under the BSD 3-Clause License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://opensource.org/licenses/BSD-3-Clause + * + * 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 com.tencent.cloud.polaris.context.config.extend.tsf; + +import java.util.HashMap; +import java.util.Map; + +import com.tencent.cloud.common.tsf.TsfContextUtils; +import com.tencent.polaris.api.utils.StringUtils; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.env.EnvironmentPostProcessor; +import org.springframework.core.Ordered; +import org.springframework.core.env.ConfigurableEnvironment; +import org.springframework.core.env.MapPropertySource; + +/** + * Read TSF env. + * + * @author Haotian Zhang + */ +public final class TsfLastEnvironmentPostProcessor implements EnvironmentPostProcessor, Ordered { + @Override + public int getOrder() { + return -2147483637; + } + @Override + public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) { + String tsfAppId = environment.getProperty("tsf_app_id"); + // TSF deploy + if (StringUtils.isNotBlank(tsfAppId)) { + Map defaultProperties = new HashMap<>(); + + if (TsfContextUtils.isTsfConsulEnabled(environment)) { + defaultProperties.put("spring.cloud.consul.discovery.enabled", environment.getProperty("spring.cloud.consul.discovery.enabled", "true")); + defaultProperties.put("spring.cloud.consul.discovery.register", environment.getProperty("spring.cloud.consul.discovery.register", "true")); + } + + MapPropertySource tsfLastPropertySource = new MapPropertySource("tsf-last-properties", defaultProperties); + environment.getPropertySources().addLast(tsfLastPropertySource); + } + } +} diff --git a/spring-cloud-tencent-polaris-context/src/main/resources/META-INF/spring.factories b/spring-cloud-tencent-polaris-context/src/main/resources/META-INF/spring.factories index 7751f48cc..6eb72a200 100644 --- a/spring-cloud-tencent-polaris-context/src/main/resources/META-INF/spring.factories +++ b/spring-cloud-tencent-polaris-context/src/main/resources/META-INF/spring.factories @@ -10,4 +10,5 @@ org.springframework.context.ApplicationListener=\ com.tencent.cloud.polaris.context.listener.FailedEventApplicationListener org.springframework.boot.env.EnvironmentPostProcessor=\ com.tencent.cloud.polaris.context.config.PolarisContextEnvironmentPostProcessor,\ - com.tencent.cloud.polaris.context.config.extend.tsf.TsfCoreEnvironmentPostProcessor + com.tencent.cloud.polaris.context.config.extend.tsf.TsfCoreEnvironmentPostProcessor,\ + com.tencent.cloud.polaris.context.config.extend.tsf.TsfLastEnvironmentPostProcessor