[ISSUE #12872]Refactor ConfigCache and related pathways ,uniformly us…

…e UTF-8 encoding for md5 fields (#12931)

* Refactor ConfigCache and related pathways optimize encoding for md5 fields. Utilize the SPI mechanism in related pathways and methods to ensure extensibility for config cache

common/src/test/java/com/alibaba/nacos/common/notify/DefaultSharePublisherTest.java

@@ -106,7 +106,7 @@ void testIgnoreExpiredEvent() throws InterruptedException {
         defaultSharePublisher.addSubscriber(smartSubscriber2, MockSlowEvent2.class);
         defaultSharePublisher.publish(mockSlowEvent1);
         defaultSharePublisher.publish(mockSlowEvent2);
-        TimeUnit.MILLISECONDS.sleep(1100);
+        TimeUnit.MILLISECONDS.sleep(1500);
         verify(smartSubscriber1).onEvent(mockSlowEvent1);
         verify(smartSubscriber2).onEvent(mockSlowEvent2);
         reset(smartSubscriber1);

config/src/main/java/com/alibaba/nacos/config/server/configuration/NacosConfigConfiguration.java

@@ -19,6 +19,7 @@
 import com.alibaba.nacos.config.server.filter.CircuitFilter;
 import com.alibaba.nacos.config.server.filter.NacosWebFilter;
 import com.alibaba.nacos.persistence.configuration.condition.ConditionDistributedEmbedStorage;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.web.servlet.FilterRegistrationBean;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Conditional;
@@ -34,6 +35,7 @@
 public class NacosConfigConfiguration {
 
     @Bean
+    @ConditionalOnProperty(name = "nacos.web.charset.filter", havingValue = "nacos", matchIfMissing = true)
     public FilterRegistrationBean<NacosWebFilter> nacosWebFilterRegistration() {
         FilterRegistrationBean<NacosWebFilter> registration = new FilterRegistrationBean<>();
         registration.setFilter(nacosWebFilter());

config/src/main/java/com/alibaba/nacos/config/server/model/CacheItem.java

@@ -35,7 +35,7 @@ public class CacheItem {
 
     public String type;
 
-    ConfigCache configCache = new ConfigCache();
+    ConfigCache configCache = ConfigCacheFactoryDelegate.getInstance().createConfigCache();
 
     /**
      * Use for gray.
@@ -92,7 +92,7 @@ public void initConfigGrayIfEmpty() {
     public void initConfigGrayIfEmpty(String grayName) {
         initConfigGrayIfEmpty();
         if (!this.configCacheGray.containsKey(grayName)) {
-            this.configCacheGray.put(grayName, new ConfigCacheGray(grayName));
+            this.configCacheGray.put(grayName, ConfigCacheFactoryDelegate.getInstance().createConfigCacheGray(grayName));
         }
     }
 

config/src/main/java/com/alibaba/nacos/config/server/model/ConfigCache.java

@@ -21,18 +21,14 @@
 
 import java.io.Serializable;
 
-import static java.nio.charset.StandardCharsets.UTF_8;
-
 /**
  * config cache .
  *
  * @author shiyiyue1102
  */
 public class ConfigCache implements Serializable {
 
-    volatile String md5Gbk = Constants.NULL;
-
-    volatile String md5Utf8 = Constants.NULL;
+    volatile String md5 = Constants.NULL;
 
     volatile String encryptedDataKey;
 
@@ -42,21 +38,21 @@ public class ConfigCache implements Serializable {
      * clear cache.
      */
     public void clear() {
-        this.md5Gbk = Constants.NULL;
-        this.md5Utf8 = Constants.NULL;
+        this.md5 = Constants.NULL;
         this.encryptedDataKey = null;
         this.lastModifiedTs = -1L;
     }
 
     public ConfigCache() {
     }
 
-    public String getMd5(String encode) {
-        if (UTF_8.name().equalsIgnoreCase(encode)) {
-            return md5Utf8;
-        } else {
-            return md5Gbk;
-        }
+    public ConfigCache(String md5, long lastModifiedTs) {
+        this.md5 = StringPool.get(md5);
+        this.lastModifiedTs = lastModifiedTs;
+    }
+
+    public String getMd5() {
+        return md5;
     }
 
     public String getEncryptedDataKey() {
@@ -67,26 +63,8 @@ public void setEncryptedDataKey(String encryptedDataKey) {
         this.encryptedDataKey = encryptedDataKey;
     }
 
-    public ConfigCache(String md5Gbk, String md5Utf8, long lastModifiedTs) {
-        this.md5Gbk = StringPool.get(md5Gbk);
-        this.md5Utf8 = StringPool.get(md5Utf8);
-        this.lastModifiedTs = lastModifiedTs;
-    }
-
-    public String getMd5Gbk() {
-        return md5Gbk;
-    }
-
-    public void setMd5Gbk(String md5Gbk) {
-        this.md5Gbk = StringPool.get(md5Gbk);
-    }
-
-    public String getMd5Utf8() {
-        return md5Utf8;
-    }
-
-    public void setMd5Utf8(String md5Utf8) {
-        this.md5Utf8 = StringPool.get(md5Utf8);
+    public void setMd5(String md5) {
+        this.md5 = StringPool.get(md5);
     }
 
     public long getLastModifiedTs() {

config/src/main/java/com/alibaba/nacos/config/server/model/ConfigCacheFactory.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright 1999-2024 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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 com.alibaba.nacos.config.server.model;
+
+/**
+ * The interface Config cache factory.
+ *
+ * @author Sunrisea
+ */
+public interface ConfigCacheFactory {
+
+    /**
+     * Create config cache config cache.
+     *
+     * @return the config cache
+     */
+    public ConfigCache createConfigCache();
+
+    /**
+     * Create config cache gray config cache gray.
+     *
+     * @return the config cache gray
+     */
+    public ConfigCacheGray createConfigCacheGray();
+
+    /**
+     * Gets config cache factroy name.
+     *
+     * @return the config cache factory name
+     */
+    public String getName();
+}

config/src/main/java/com/alibaba/nacos/config/server/model/ConfigCacheFactoryDelegate.java

@@ -0,0 +1,119 @@
+/*
+ * Copyright 1999-2024 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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 com.alibaba.nacos.config.server.model;
+
+import com.alibaba.nacos.common.spi.NacosServiceLoader;
+import com.alibaba.nacos.common.utils.StringUtils;
+import com.alibaba.nacos.sys.env.EnvUtil;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.Collection;
+
+/**
+ * The type Config cache factory delegate.
+ *
+ * @author Sunrisea
+ */
+public class ConfigCacheFactoryDelegate {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(ConfigCacheFactoryDelegate.class);
+
+    private static final ConfigCacheFactoryDelegate INSTANCE = new ConfigCacheFactoryDelegate();
+
+    private String configCacheFactoryType = EnvUtil.getProperty("nacos.config.cache.type", "nacos");
+
+    private ConfigCacheFactory configCacheFactory = null;
+
+    private ConfigCacheFactoryDelegate() {
+        Collection<ConfigCacheFactory> configCacheFactories = NacosServiceLoader.load(ConfigCacheFactory.class);
+        for (ConfigCacheFactory each : configCacheFactories) {
+            if (StringUtils.isEmpty(each.getName())) {
+                LOGGER.warn(
+                        "[ConfigCacheFactoryDelegate] Load ConfigCacheFactory({}) ConfigFactroyName (null/empty) fail. "
+                                + "Please add ConfigFactoryName to resolve", each.getClass().getName());
+                continue;
+            }
+            LOGGER.info(
+                    "[ConfigCacheFactoryDelegate] Load ConfigCacheFactory({}) ConfigCacheFactoryName({}) successfully. ",
+                    each.getClass().getName(), each.getName());
+            if (StringUtils.equals(configCacheFactoryType, each.getName())) {
+                LOGGER.info("[ConfigCacheFactoryDelegate] Matched ConfigCacheFactory found,set configCacheFactory={}",
+                        each.getClass().getName());
+                this.configCacheFactory = each;
+            }
+        }
+        if (this.configCacheFactory == null) {
+            LOGGER.info(
+                    "[ConfigCacheFactoryDelegate] Matched ConfigCacheFactory not found, Load Default NacosConfigCacheFactory successfully.");
+            this.configCacheFactory = new NacosConfigCacheFactory();
+        }
+    }
+
+    /**
+     * Gets instance.
+     *
+     * @return the instance
+     */
+    public static ConfigCacheFactoryDelegate getInstance() {
+        return INSTANCE;
+    }
+
+    /**
+     * Create config cache config cache.
+     *
+     * @return the config cache
+     */
+    public ConfigCache createConfigCache() {
+        return configCacheFactory.createConfigCache();
+    }
+
+    /**
+     * Create config cache config cache.
+     *
+     * @param md5            the md 5
+     * @param lastModifiedTs the last modified ts
+     * @return the config cache
+     */
+    public ConfigCache createConfigCache(String md5, long lastModifiedTs) {
+        ConfigCache configCache = this.createConfigCache();
+        configCache.setMd5(md5);
+        configCache.setLastModifiedTs(lastModifiedTs);
+        return configCache;
+    }
+
+    /**
+     * Create config cache gray config cache gray.
+     *
+     * @return the config cache gray
+     */
+    public ConfigCacheGray createConfigCacheGray() {
+        return configCacheFactory.createConfigCacheGray();
+    }
+
+    /**
+     * Create config cache gray config cache gray.
+     *
+     * @param grayName the gray name
+     * @return the config cache gray
+     */
+    public ConfigCacheGray createConfigCacheGray(String grayName) {
+        ConfigCacheGray configCacheGray = configCacheFactory.createConfigCacheGray();
+        configCacheGray.setGrayName(grayName);
+        return configCacheGray;
+    }
+}

config/src/main/java/com/alibaba/nacos/config/server/model/ConfigCacheGray.java

@@ -41,6 +41,8 @@ public void clear() {
         super.clear();
     }
 
+    public ConfigCacheGray() {}
+
     public ConfigCacheGray(String grayName) {
         this.grayName = grayName;
     }
@@ -49,15 +51,6 @@ public GrayRule getGrayRule() {
         return grayRule;
     }
 
-    public ConfigCacheGray(String md5Gbk, String md5Utf8, long lastModifiedTs, String grayRule)
-            throws RuntimeException {
-        super(md5Gbk, md5Utf8, lastModifiedTs);
-        this.grayRule = GrayRuleManager.constructGrayRule(GrayRuleManager.deserializeConfigGrayPersistInfo(grayRule));
-        if (this.grayRule == null || !this.grayRule.isValid()) {
-            throw new RuntimeException("raw gray rule is invalid");
-        }
-    }
-
     public String getGrayName() {
         return grayName;
     }

config/src/main/java/com/alibaba/nacos/config/server/model/ConfigCachePostProcessor.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 1999-2024 Alibaba Group Holding Ltd.
+ *
+ * Licensed 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 com.alibaba.nacos.config.server.model;
+
+/**
+ * The interface Config cache md5 post processor.
+ *
+ * @author Sunrisea
+ */
+public interface ConfigCachePostProcessor {
+
+    /**
+     * Gets post processor name.
+     *
+     * @return the post processor name
+     */
+    public String getName();
+
+    /**
+     * Post process.
+     *
+     * @param configCache the config cache
+     * @param content     the content
+     */
+    public void postProcess(ConfigCache configCache, String content);
+}