feat:support consul config data.

Tencent · Jul 26, 2024 · d22f494 · d22f494
1 parent 33e080e
commit d22f494
Show file tree

Hide file tree

Showing 21 changed files with 263 additions and 144 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -23,5 +23,6 @@
 - [fix: fix lossless test case unstable issues.](https://github.com/Tencent/spring-cloud-tencent/pull/1324)
 - [feat:support consul service update task.](https://github.com/Tencent/spring-cloud-tencent/pull/1329)
 - [fix:fix app starting failed when user using custom OpenAPI bean.](https://github.com/Tencent/spring-cloud-tencent/pull/1330)
+- [feat:support consul config data.](https://github.com/Tencent/spring-cloud-tencent/pull/1331)
 - [fix: move ConditionalOnTsfEnabled to spring-cloud-tencent-commons and fix PolarisInetUtilsAutoConfiguration.](https://github.com/Tencent/spring-cloud-tencent/pull/1354)
 - [fix: memory cost too many when using wildcard feign calls](https://github.com/Tencent/spring-cloud-tencent/pull/1356)
diff --git a/...c/main/java/com/tencent/cloud/polaris/config/PolarisConfigBootstrapAutoConfiguration.java b/...c/main/java/com/tencent/cloud/polaris/config/PolarisConfigBootstrapAutoConfiguration.java
@@ -36,6 +36,7 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
+import org.springframework.context.annotation.Primary;
 import org.springframework.core.env.Environment;
 
 /**
@@ -84,6 +85,7 @@ public ConfigurationModifier configurationModifier(PolarisConfigProperties polar
 	}
 
 	@Bean
+	@Primary
 	@ConditionalOnMissingBean(search = SearchStrategy.CURRENT)
 	@ConditionalOnReflectRefreshType
 	public ConfigurationPropertiesRebinder affectedConfigurationPropertiesRebinder(

diff --git a/...nfig/src/main/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigFileLocator.java b/...nfig/src/main/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigFileLocator.java
@@ -117,6 +117,9 @@ private void afterLocatePolarisConfigExtension(CompositePropertySource composite
 	}
 
 	private void initInternalConfigFiles(CompositePropertySource compositePropertySource) {
+		if (!polarisConfigProperties.isInternalEnabled()) {
+			return;
+		}
 		List<ConfigFileMetadata> internalConfigFiles = getInternalConfigFiles();
 
 		for (ConfigFileMetadata configFile : internalConfigFiles) {

diff --git a/...ain/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigPropertyAutoRefresher.java b/...ain/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigPropertyAutoRefresher.java
@@ -18,14 +18,17 @@
 
 package com.tencent.cloud.polaris.config.adapter;
 
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.atomic.AtomicBoolean;
 
 import com.tencent.cloud.polaris.config.config.PolarisConfigProperties;
 import com.tencent.cloud.polaris.config.logger.PolarisConfigLoggerContext;
+import com.tencent.polaris.configuration.api.core.ConfigKVFile;
 import com.tencent.polaris.configuration.api.core.ConfigKVFileChangeListener;
 import com.tencent.polaris.configuration.api.core.ConfigPropertyChangeInfo;
+import com.tencent.polaris.configuration.client.internal.CompositeConfigFile;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -79,8 +82,18 @@ private void registerPolarisConfigPublishEvent() {
 
 		// register polaris config publish event
 		for (PolarisPropertySource polarisPropertySource : polarisPropertySources) {
-			registerPolarisConfigPublishChangeListener(polarisPropertySource);
-			customRegisterPolarisConfigPublishChangeListener(polarisPropertySource);
+			if (polarisPropertySource.getConfigKVFile() instanceof CompositeConfigFile) {
+				CompositeConfigFile configKVFile = (CompositeConfigFile) polarisPropertySource.getConfigKVFile();
+				for (ConfigKVFile cf : configKVFile.getConfigKVFiles()) {
+					PolarisPropertySource p = new PolarisPropertySource(cf.getNamespace(), cf.getFileGroup(), cf.getFileName(), cf, new HashMap<>());
+					registerPolarisConfigPublishChangeListener(p);
+					customRegisterPolarisConfigPublishChangeListener(p);
+				}
+			}
+			else {
+				registerPolarisConfigPublishChangeListener(polarisPropertySource);
+				customRegisterPolarisConfigPublishChangeListener(polarisPropertySource);
+			}
 		}
 	}
 
@@ -93,6 +106,7 @@ private void customInitRegisterPolarisConfig(PolarisConfigPropertyAutoRefresher
 	}
 
 	public void registerPolarisConfigPublishChangeListener(PolarisPropertySource polarisPropertySource) {
+		LOGGER.info("{} will register polaris config publish listener", polarisPropertySource.getPropertySourceName());
 		polarisPropertySource.getConfigKVFile()
 				.addChangeListener((ConfigKVFileChangeListener) configKVFileChangeEvent -> {
 

diff --git a/...-config/src/main/java/com/tencent/cloud/polaris/config/adapter/PolarisPropertySource.java b/...-config/src/main/java/com/tencent/cloud/polaris/config/adapter/PolarisPropertySource.java
@@ -20,6 +20,7 @@
 
 import java.util.Map;
 
+import com.tencent.cloud.polaris.config.utils.PolarisPropertySourceUtils;
 import com.tencent.polaris.configuration.api.core.ConfigKVFile;
 
 import org.springframework.core.env.MapPropertySource;
@@ -40,7 +41,7 @@ public class PolarisPropertySource extends MapPropertySource {
 	private final ConfigKVFile configKVFile;
 
 	public PolarisPropertySource(String namespace, String group, String fileName, ConfigKVFile configKVFile, Map<String, Object> source) {
-		super(namespace + "-" + group + "-" + fileName, source);
+		super(PolarisPropertySourceUtils.generateName(namespace, group, fileName), source);
 
 		this.namespace = namespace;
 		this.group = group;
@@ -64,7 +65,7 @@ public String getPropertySourceName() {
 		return namespace + "-" + group + "-" + fileName;
 	}
 
-	ConfigKVFile getConfigKVFile() {
+	public ConfigKVFile getConfigKVFile() {
 		return configKVFile;
 	}
 

diff --git a/...config/src/main/java/com/tencent/cloud/polaris/config/config/PolarisConfigProperties.java b/...config/src/main/java/com/tencent/cloud/polaris/config/config/PolarisConfigProperties.java
@@ -91,6 +91,11 @@ public class PolarisConfigProperties {
 	 */
 	private String localFileRootPath = "./polaris/backup/config";
 
+	/**
+	 * If internal config file enabled.
+	 */
+	private boolean internalEnabled = true;
+
 	public boolean isEnabled() {
 		return enabled;
 	}
@@ -179,6 +184,14 @@ public void setLocalFileRootPath(String localFileRootPath) {
 		this.localFileRootPath = localFileRootPath;
 	}
 
+	public boolean isInternalEnabled() {
+		return internalEnabled;
+	}
+
+	public void setInternalEnabled(boolean internalEnabled) {
+		this.internalEnabled = internalEnabled;
+	}
+
 	@Override
 	public String toString() {
 		return "PolarisConfigProperties{" +
@@ -193,6 +206,7 @@ public String toString() {
 				", groups=" + groups +
 				", dataSource='" + dataSource + '\'' +
 				", localFileRootPath='" + localFileRootPath + '\'' +
+				", internalEnabled=" + internalEnabled +
 				'}';
 	}
 }
diff --git a/...ig/src/main/java/com/tencent/cloud/polaris/config/configdata/PolarisConfigDataLoader.java b/...ig/src/main/java/com/tencent/cloud/polaris/config/configdata/PolarisConfigDataLoader.java
@@ -18,10 +18,13 @@
 package com.tencent.cloud.polaris.config.configdata;
 
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.atomic.AtomicBoolean;
 
+import com.tencent.cloud.polaris.config.adapter.PolarisConfigCustomExtensionLayer;
 import com.tencent.cloud.polaris.config.adapter.PolarisConfigFilePuller;
+import com.tencent.cloud.polaris.config.adapter.PolarisServiceLoaderUtil;
 import com.tencent.cloud.polaris.config.config.ConfigFileGroup;
 import com.tencent.cloud.polaris.config.config.PolarisConfigProperties;
 import com.tencent.cloud.polaris.context.PolarisSDKContextManager;
@@ -38,6 +41,7 @@
 import org.springframework.boot.context.config.Profiles;
 import org.springframework.boot.logging.DeferredLogFactory;
 import org.springframework.core.env.CompositePropertySource;
+import org.springframework.core.env.PropertySource;
 import org.springframework.util.CollectionUtils;
 import org.springframework.util.StringUtils;
 
@@ -59,6 +63,7 @@ public class PolarisConfigDataLoader implements ConfigDataLoader<PolarisConfigDa
 	static final AtomicBoolean CUSTOM_POLARIS_CONFIG_FILE_LOADED = new AtomicBoolean(false);
 	private static final String POLARIS_CONFIG_PROPERTY_SOURCE_NAME = "polaris-config";
 	private final Log log;
+	private final PolarisConfigCustomExtensionLayer polarisConfigCustomExtensionLayer = PolarisServiceLoaderUtil.getPolarisConfigCustomExtensionLayer();
 	private ConfigFileService configFileService;
 	private PolarisConfigFilePuller puller;
 
@@ -83,7 +88,9 @@ public ConfigData load(ConfigDataLoaderContext context, PolarisConfigDataResourc
 
 	public ConfigData load(ConfigurableBootstrapContext bootstrapContext, PolarisConfigDataResource resource) {
 		CompositePropertySource compositePropertySource = locate(bootstrapContext, resource);
-		return new ConfigData(compositePropertySource.getPropertySources(), getOptions(resource));
+		List<PropertySource<?>> propertySourceList = new ArrayList<>(compositePropertySource.getPropertySources());
+		Collections.reverse(propertySourceList);
+		return new ConfigData(propertySourceList, getOptions(resource));
 	}
 
 	private CompositePropertySource locate(ConfigurableBootstrapContext bootstrapContext,
@@ -97,16 +104,21 @@ private CompositePropertySource locate(ConfigurableBootstrapContext bootstrapCon
 		if (null == this.puller) {
 			this.puller = PolarisConfigFilePuller.get(resource.getPolarisContextProperties(), configFileService);
 		}
+		// load custom config extension files
+		if (polarisConfigCustomExtensionLayer != null) {
+			polarisConfigCustomExtensionLayer.initConfigFiles(null, compositePropertySource, configFileService);
+		}
+		// load spring boot default config files
+		PolarisConfigProperties polarisConfigProperties = resource.getPolarisConfigProperties();
 		Profiles profiles = resource.getProfiles();
-		if (INTERNAL_CONFIG_FILES_LOADED.compareAndSet(false, true)) {
+		if (polarisConfigProperties.isInternalEnabled() && INTERNAL_CONFIG_FILES_LOADED.compareAndSet(false, true)) {
 			log.info("loading internal config files");
 			String[] activeProfiles = profiles.getActive().toArray(new String[] {});
 			String[] defaultProfiles = profiles.getDefault().toArray(new String[] {});
 			this.puller.initInternalConfigFiles(
 					compositePropertySource, activeProfiles, defaultProfiles, resource.getServiceName());
 		}
-
-		PolarisConfigProperties polarisConfigProperties = resource.getPolarisConfigProperties();
+		// load custom config files
 		if (!CollectionUtils.isEmpty(polarisConfigProperties.getGroups()) &&
 				CUSTOM_POLARIS_CONFIG_FILE_LOADED.compareAndSet(false, true)) {
 			log.info("loading custom config files");
@@ -118,6 +130,10 @@ private CompositePropertySource locate(ConfigurableBootstrapContext bootstrapCon
 			log.info("loading config data config file, group:" + resource.getGroupName() + " file: " + resource.getFileName());
 			this.puller.initCustomPolarisConfigFile(compositePropertySource, configFileGroup(resource));
 		}
+		if (polarisConfigCustomExtensionLayer != null) {
+			polarisConfigCustomExtensionLayer.executeAfterLocateConfigReturning(compositePropertySource);
+		}
+
 		return compositePropertySource;
 	}
 

diff --git a/...n/java/com/tencent/cloud/polaris/config/tsf/PolarisAdaptorTsfConfigAutoConfiguration.java b/...n/java/com/tencent/cloud/polaris/config/tsf/PolarisAdaptorTsfConfigAutoConfiguration.java
@@ -27,7 +27,6 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.context.annotation.Bean;
@@ -46,8 +45,7 @@ public class PolarisAdaptorTsfConfigAutoConfiguration {
 
 	{
 		System.setProperty("spring.cloud.polaris.config.refresh-type", "refresh_context");
-		LOGGER.info(
-				"[SCTT Config] PolarisAdaptorTsfConfigAutoConfiguration init set spring.cloud.polaris.config.refresh-type to refresh_context");
+		LOGGER.info("PolarisAdaptorTsfConfigAutoConfiguration init set spring.cloud.polaris.config.refresh-type to refresh_context");
 	}
 
 	@Bean
@@ -65,7 +63,7 @@ public TsfConsulConfigRefreshEventListener polarisAdaptorTsfConsulRefreshEventLi
 	 */
 	@Bean
 	@ConditionalOnMissingBean
-	@ConditionalOnExpression("${spring.cloud.consul.config.enabled:true} == false and ${tsf.config.instance.released-config.lookup.enabled:true} == true")
+	@ConditionalOnProperty(name = "tsf.config.instance.released-config.lookup.enabled", matchIfMissing = true)
 	public PolarisAdaptorTsfConfigController polarisAdaptorTsfConfigController() {
 		return new PolarisAdaptorTsfConfigController();
 	}

diff --git a/...a/com/tencent/cloud/polaris/config/tsf/PolarisAdaptorTsfConfigBootstrapConfiguration.java b/...a/com/tencent/cloud/polaris/config/tsf/PolarisAdaptorTsfConfigBootstrapConfiguration.java
@@ -22,7 +22,6 @@
 
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.context.annotation.Import;
 
 /**
  * @author juanyinyang
@@ -32,7 +31,6 @@
 @ConditionalOnProperty("spring.cloud.polaris.enabled")
 @ConditionalOnTsfEnabled
 @ConditionalOnPolarisConfigEnabled
-@Import(PolarisAdaptorTsfConfigAutoConfiguration.class)
 public class PolarisAdaptorTsfConfigBootstrapConfiguration {