feature: support Polaris configuration center extension plugin interf…

…ace and support dynamic modification of log levels. (#1105) Co-authored-by: 杨镌颖 <[email protected]> Co-authored-by: melodyl <[email protected]>
Tencent · Sep 11, 2023 · 43ec0f9 · 43ec0f9
1 parent 0aa3d7d
commit 43ec0f9
Show file tree

Hide file tree

Showing 21 changed files with 752 additions and 79 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -27,3 +27,4 @@
 - [refactor:optimize discovery properties initialization.](https://github.com/Tencent/spring-cloud-tencent/pull/1079)
 - [fix:upgrade spring version.](https://github.com/Tencent/spring-cloud-tencent/pull/1085)
 - [fix:Update README-zh.md](https://github.com/Tencent/spring-cloud-tencent/pull/1094).
+- [feature: support Polaris configuration center extension plugin interface and support dynamic modification of log levels.](https://github.com/Tencent/spring-cloud-tencent/pull/1105)
diff --git a/...config/src/main/java/com/tencent/cloud/polaris/config/PolarisConfigAutoConfiguration.java b/...config/src/main/java/com/tencent/cloud/polaris/config/PolarisConfigAutoConfiguration.java
@@ -29,6 +29,7 @@
 import com.tencent.cloud.polaris.config.config.PolarisConfigProperties;
 import com.tencent.cloud.polaris.config.listener.PolarisConfigChangeEventListener;
 import com.tencent.cloud.polaris.config.listener.PolarisConfigRefreshOptimizationListener;
+import com.tencent.cloud.polaris.config.logger.PolarisConfigLoggerApplicationListener;
 import com.tencent.cloud.polaris.config.spring.annotation.SpringValueProcessor;
 import com.tencent.cloud.polaris.config.spring.property.PlaceholderHelper;
 import com.tencent.cloud.polaris.config.spring.property.SpringValueRegistry;
@@ -62,6 +63,12 @@ public PolarisConfigChangeEventListener polarisConfigChangeEventListener() {
 		return new PolarisConfigChangeEventListener();
 	}
 
+	@Bean
+	public PolarisConfigLoggerApplicationListener polarisConfigLoggerApplicationListener() {
+		return new PolarisConfigLoggerApplicationListener();
+	}
+
+
 	@Bean
 	@Primary
 	@ConditionalOnReflectRefreshType

diff --git a/...main/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigCustomExtensionLayer.java b/...main/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigCustomExtensionLayer.java
@@ -0,0 +1,38 @@
+/*
+ * Tencent is pleased to support the open source community by making Spring Cloud Tencent available.
+ *
+ * Copyright (C) 2019 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.config.adapter;
+
+import com.tencent.polaris.configuration.api.core.ConfigFileService;
+
+import org.springframework.core.env.CompositePropertySource;
+import org.springframework.core.env.Environment;
+
+
+/**
+ * @Date Jul 23, 2023 2:57:49 PM
+ * @author juanyinyang
+ */
+public interface PolarisConfigCustomExtensionLayer {
+	void initRegisterConfig(PolarisConfigPropertyAutoRefresher polarisConfigPropertyAutoRefresher);
+
+	void initConfigFiles(Environment environment, CompositePropertySource compositePropertySource, PolarisPropertySourceManager polarisPropertySourceManager, ConfigFileService configFileService);
+
+	void executeAfterLocateConfigReturning(CompositePropertySource compositePropertySource);
+	boolean executeRegisterPublishChangeListener(PolarisPropertySource polarisPropertySource);
+}
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
@@ -17,19 +17,32 @@
 
 package com.tencent.cloud.polaris.config.adapter;
 
+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.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.DefaultConfigFileMetadata;
+import org.apache.commons.lang.ArrayUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import org.springframework.cloud.bootstrap.config.PropertySourceLocator;
 import org.springframework.core.annotation.Order;
 import org.springframework.core.env.CompositePropertySource;
 import org.springframework.core.env.Environment;
 import org.springframework.core.env.PropertySource;
 import org.springframework.util.CollectionUtils;
+import org.springframework.util.StringUtils;
 
 /**
  * Spring cloud reserved core configuration loading SPI.
@@ -41,38 +54,185 @@
 @Order(0)
 public class PolarisConfigFileLocator implements PropertySourceLocator {
 
+	private static final Logger LOGGER = LoggerFactory.getLogger(PolarisConfigFileLocator.class);
+
 	private static final String POLARIS_CONFIG_PROPERTY_SOURCE_NAME = "polaris-config";
 
 	private final PolarisConfigProperties polarisConfigProperties;
 
-	private final PolarisConfigFilePuller polarisConfigFilePuller;
+	private final PolarisContextProperties polarisContextProperties;
+
+	private final ConfigFileService configFileService;
+
+	private final PolarisPropertySourceManager polarisPropertySourceManager;
+
+	private final Environment environment;
+	// this class provides customized logic for some customers to configure special business group files
+	private final PolarisConfigCustomExtensionLayer polarisConfigCustomExtensionLayer = PolarisServiceLoaderUtil.getPolarisConfigCustomExtensionLayer();
 
-	public PolarisConfigFileLocator(PolarisConfigProperties polarisConfigProperties,
-			PolarisContextProperties polarisContextProperties, ConfigFileService configFileService,
-			PolarisPropertySourceManager polarisPropertySourceManager, Environment environment) {
+	public PolarisConfigFileLocator(PolarisConfigProperties polarisConfigProperties, PolarisContextProperties polarisContextProperties, ConfigFileService configFileService, PolarisPropertySourceManager polarisPropertySourceManager, Environment environment) {
 		this.polarisConfigProperties = polarisConfigProperties;
-		this.polarisConfigFilePuller = PolarisConfigFilePuller.get(polarisContextProperties, configFileService,
-				polarisPropertySourceManager);
+		this.polarisContextProperties = polarisContextProperties;
+		this.configFileService = configFileService;
+		this.polarisPropertySourceManager = polarisPropertySourceManager;
+		this.environment = environment;
 	}
 
 	@Override
 	public PropertySource<?> locate(Environment environment) {
-		CompositePropertySource compositePropertySource = new CompositePropertySource(
-				POLARIS_CONFIG_PROPERTY_SOURCE_NAME);
+		CompositePropertySource compositePropertySource = new CompositePropertySource(POLARIS_CONFIG_PROPERTY_SOURCE_NAME);
+		try {
+			// load custom config extension files
+			initCustomPolarisConfigExtensionFiles(compositePropertySource);
+			// load spring boot default config files
+			initInternalConfigFiles(compositePropertySource);
+			// load custom config files
+			List<ConfigFileGroup> configFileGroups = polarisConfigProperties.getGroups();
+			if (CollectionUtils.isEmpty(configFileGroups)) {
+				return compositePropertySource;
+			}
+			initCustomPolarisConfigFiles(compositePropertySource, configFileGroups);
+			return compositePropertySource;
+		}
+		finally {
+			afterLocatePolarisConfigExtension(compositePropertySource);
+		}
+	}
+
+	private void initCustomPolarisConfigExtensionFiles(CompositePropertySource compositePropertySource) {
+		if (polarisConfigCustomExtensionLayer == null) {
+			LOGGER.debug("[SCT Config] PolarisAdaptorTsfConfigExtensionLayer is not init, ignore the following execution steps");
+			return;
+		}
+		polarisConfigCustomExtensionLayer.initConfigFiles(environment, compositePropertySource, polarisPropertySourceManager, configFileService);
+	}
+
+	private void afterLocatePolarisConfigExtension(CompositePropertySource compositePropertySource) {
+		if (polarisConfigCustomExtensionLayer == null) {
+			LOGGER.debug("[SCT Config] PolarisAdaptorTsfConfigExtensionLayer is not init, ignore the following execution steps");
+			return;
+		}
+		polarisConfigCustomExtensionLayer.executeAfterLocateConfigReturning(compositePropertySource);
+	}
+
+	private void initInternalConfigFiles(CompositePropertySource compositePropertySource) {
+		List<ConfigFileMetadata> internalConfigFiles = getInternalConfigFiles();
+
+		for (ConfigFileMetadata configFile : internalConfigFiles) {
+			PolarisPropertySource polarisPropertySource = loadPolarisPropertySource(configFile.getNamespace(), configFile.getFileGroup(), configFile.getFileName());
+
+			compositePropertySource.addPropertySource(polarisPropertySource);
 
-		// load spring boot default config files
+			polarisPropertySourceManager.addPropertySource(polarisPropertySource);
+
+			LOGGER.info("[SCT Config] Load and inject polaris config file. file = {}", configFile);
+		}
+	}
+
+	private List<ConfigFileMetadata> getInternalConfigFiles() {
+		String namespace = polarisContextProperties.getNamespace();
+		String serviceName = polarisContextProperties.getService();
+		if (!StringUtils.hasText(serviceName)) {
+			serviceName = environment.getProperty("spring.application.name");
+		}
+
+		List<ConfigFileMetadata> internalConfigFiles = new LinkedList<>();
+
+		// priority: application-${profile} > application > boostrap-${profile} > boostrap
 		String[] activeProfiles = environment.getActiveProfiles();
 		String[] defaultProfiles = environment.getDefaultProfiles();
-		String serviceName = environment.getProperty("spring.application.name");
-		polarisConfigFilePuller.initInternalConfigFiles(
-				compositePropertySource, activeProfiles, defaultProfiles, serviceName);
+		List<String> profileList = new ArrayList<>();
+		if (ArrayUtils.isNotEmpty(activeProfiles)) {
+			profileList.addAll(Arrays.asList(activeProfiles));
+		}
+		else if (ArrayUtils.isNotEmpty(defaultProfiles)) {
+			profileList.addAll(Arrays.asList(defaultProfiles));
+		}
+		// build application config files
+		buildInternalApplicationConfigFiles(internalConfigFiles, namespace, serviceName, profileList);
+		// build bootstrap config files
+		buildInternalBootstrapConfigFiles(internalConfigFiles, namespace, serviceName, profileList);
 
-		// load custom config files
-		List<ConfigFileGroup> configFileGroups = polarisConfigProperties.getGroups();
-		if (CollectionUtils.isEmpty(configFileGroups)) {
-			return compositePropertySource;
+		return internalConfigFiles;
+	}
+
+	private void buildInternalApplicationConfigFiles(List<ConfigFileMetadata> internalConfigFiles, String namespace, String serviceName, List<String> profileList) {
+		for (String profile : profileList) {
+			if (!StringUtils.hasText(profile)) {
+				continue;
+			}
+			internalConfigFiles.add(new DefaultConfigFileMetadata(namespace, serviceName, "application-" + profile + ".properties"));
+			internalConfigFiles.add(new DefaultConfigFileMetadata(namespace, serviceName, "application-" + profile + ".yml"));
+			internalConfigFiles.add(new DefaultConfigFileMetadata(namespace, serviceName, "application-" + profile + ".yaml"));
 		}
-		polarisConfigFilePuller.initCustomPolarisConfigFiles(compositePropertySource, configFileGroups);
-		return compositePropertySource;
+		// build default config properties files.
+		internalConfigFiles.add(new DefaultConfigFileMetadata(namespace, serviceName, "application.properties"));
+		internalConfigFiles.add(new DefaultConfigFileMetadata(namespace, serviceName, "application.yml"));
+		internalConfigFiles.add(new DefaultConfigFileMetadata(namespace, serviceName, "application.yaml"));
+	}
+
+	private void buildInternalBootstrapConfigFiles(List<ConfigFileMetadata> internalConfigFiles, String namespace, String serviceName, List<String> profileList) {
+		for (String profile : profileList) {
+			if (!StringUtils.hasText(profile)) {
+				continue;
+			}
+			internalConfigFiles.add(new DefaultConfigFileMetadata(namespace, serviceName, "bootstrap-" + profile + ".properties"));
+			internalConfigFiles.add(new DefaultConfigFileMetadata(namespace, serviceName, "bootstrap-" + profile + ".yml"));
+			internalConfigFiles.add(new DefaultConfigFileMetadata(namespace, serviceName, "bootstrap-" + profile + ".yaml"));
+		}
+		// build default config properties files.
+		internalConfigFiles.add(new DefaultConfigFileMetadata(namespace, serviceName, "bootstrap.properties"));
+		internalConfigFiles.add(new DefaultConfigFileMetadata(namespace, serviceName, "bootstrap.yml"));
+		internalConfigFiles.add(new DefaultConfigFileMetadata(namespace, serviceName, "bootstrap.yaml"));
+	}
+
+	private void initCustomPolarisConfigFiles(CompositePropertySource compositePropertySource, List<ConfigFileGroup> configFileGroups) {
+		String namespace = polarisContextProperties.getNamespace();
+
+		for (ConfigFileGroup configFileGroup : configFileGroups) {
+			String group = configFileGroup.getName();
+
+			if (!StringUtils.hasText(group)) {
+				throw new IllegalArgumentException("polaris config group name cannot be empty.");
+			}
+
+			List<String> files = configFileGroup.getFiles();
+			if (CollectionUtils.isEmpty(files)) {
+				return;
+			}
+
+			for (String fileName : files) {
+				PolarisPropertySource polarisPropertySource = loadPolarisPropertySource(namespace, group, fileName);
+
+				compositePropertySource.addPropertySource(polarisPropertySource);
+
+				polarisPropertySourceManager.addPropertySource(polarisPropertySource);
+
+				LOGGER.info("[SCT Config] Load and inject polaris config file success. namespace = {}, group = {}, fileName = {}", namespace, group, fileName);
+			}
+		}
+	}
+
+	private PolarisPropertySource loadPolarisPropertySource(String namespace, String group, String fileName) {
+		ConfigKVFile configKVFile;
+		// unknown extension is resolved as properties file
+		if (ConfigFileFormat.isPropertyFile(fileName) || ConfigFileFormat.isUnknownFile(fileName)) {
+			configKVFile = configFileService.getConfigPropertiesFile(namespace, group, fileName);
+		}
+		else if (ConfigFileFormat.isYamlFile(fileName)) {
+			configKVFile = configFileService.getConfigYamlFile(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");
+		}
+
+		Map<String, Object> map = new ConcurrentHashMap<>();
+		for (String key : configKVFile.getPropertyNames()) {
+			map.put(key, configKVFile.getProperty(key, null));
+		}
+
+		return new PolarisPropertySource(namespace, group, fileName, configKVFile, map);
 	}
 }