Add module enabled packages scan filter.

Author: KomachiSion

config/src/main/java/com/alibaba/nacos/config/server/filter/ConfigEnabledFilter.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright 1999-2023 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.filter;
+
+import com.alibaba.nacos.common.utils.StringUtils;
+import com.alibaba.nacos.config.server.Config;
+import com.alibaba.nacos.sys.env.EnvUtil;
+import com.alibaba.nacos.sys.filter.NacosPackageExcludeFilter;
+
+import java.util.Set;
+
+import static com.alibaba.nacos.sys.env.EnvUtil.FUNCTION_MODE_CONFIG;
+
+/**
+ * Config module enabled filter by spring packages scan.
+ *
+ * @author xiweng.yy
+ */
+public class ConfigEnabledFilter implements NacosPackageExcludeFilter {
+    
+    @Override
+    public String getResponsiblePackagePrefix() {
+        return Config.class.getPackage().getName();
+    }
+    
+    @Override
+    public boolean isExcluded(String className, Set<String> annotationNames) {
+        String functionMode = EnvUtil.getFunctionMode();
+        // When not specified config mode or specified all mode, the config module not start and load.
+        if (StringUtils.isEmpty(functionMode)) {
+            return false;
+        }
+        return !FUNCTION_MODE_CONFIG.equals(functionMode);
+    }
+}

config/src/main/resources/META-INF/services/com.alibaba.nacos.sys.filter.NacosPackageExcludeFilter

@@ -0,0 +1,17 @@
+#
+# Copyright 1999-2023 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.
+#
+
+com.alibaba.nacos.config.server.filter.ConfigEnabledFilter

istio/src/main/java/com/alibaba/nacos/istio/config/IstioEnabledFilter.java

@@ -0,0 +1,68 @@
+/*
+ * Copyright 1999-2023 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.istio.config;
+
+import com.alibaba.nacos.common.utils.StringUtils;
+import com.alibaba.nacos.istio.IstioApp;
+import com.alibaba.nacos.sys.env.EnvUtil;
+import com.alibaba.nacos.sys.filter.NacosPackageExcludeFilter;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.Set;
+
+import static com.alibaba.nacos.sys.env.EnvUtil.FUNCTION_MODE_NAMING;
+
+/**
+ * Istio module enabled filter by spring packages scan.
+ *
+ * @author xiweng.yy
+ */
+public class IstioEnabledFilter implements NacosPackageExcludeFilter {
+    
+    private static final Logger LOGGER = LoggerFactory.getLogger(IstioEnabledFilter.class);
+    
+    private static final String ISTIO_ENABLED_KEY = "nacos.extension.naming.istio.enabled";
+    
+    @Override
+    public String getResponsiblePackagePrefix() {
+        return IstioApp.class.getPackage().getName();
+    }
+    
+    @Override
+    public boolean isExcluded(String className, Set<String> annotationNames) {
+        String functionMode = EnvUtil.getFunctionMode();
+        // When not specified naming mode or specified all mode, the naming module not start and load.
+        if (isNamingDisabled(functionMode)) {
+            LOGGER.warn("Istio module disabled because function mode is {}, and Istio depend naming module",
+                    functionMode);
+            return true;
+        }
+        boolean istioDisabled = !EnvUtil.getProperty(ISTIO_ENABLED_KEY, Boolean.class, false);
+        if (istioDisabled) {
+            LOGGER.warn("Istio module disabled because set {} as false", ISTIO_ENABLED_KEY);
+        }
+        return istioDisabled;
+    }
+    
+    private boolean isNamingDisabled(String functionMode) {
+        if (StringUtils.isEmpty(functionMode)) {
+            return false;
+        }
+        return !FUNCTION_MODE_NAMING.equals(functionMode);
+    }
+}

istio/src/main/resources/META-INF/services/com.alibaba.nacos.sys.filter.NacosPackageExcludeFilter

@@ -0,0 +1,17 @@
+#
+# Copyright 1999-2023 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.
+#
+
+com.alibaba.nacos.istio.config.IstioEnabledFilter

naming/src/main/java/com/alibaba/nacos/naming/config/NamingEnabledFilter.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright 1999-2023 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.naming.config;
+
+import com.alibaba.nacos.common.utils.StringUtils;
+import com.alibaba.nacos.naming.NamingApp;
+import com.alibaba.nacos.sys.env.EnvUtil;
+import com.alibaba.nacos.sys.filter.NacosPackageExcludeFilter;
+
+import java.util.Set;
+
+import static com.alibaba.nacos.sys.env.EnvUtil.FUNCTION_MODE_NAMING;
+
+/**
+ * Naming module enabled filter by spring packages scan.
+ *
+ * @author xiweng.yy
+ */
+public class NamingEnabledFilter implements NacosPackageExcludeFilter {
+    
+    @Override
+    public String getResponsiblePackagePrefix() {
+        return NamingApp.class.getPackage().getName();
+    }
+    
+    @Override
+    public boolean isExcluded(String className, Set<String> annotationNames) {
+        String functionMode = EnvUtil.getFunctionMode();
+        // When not specified naming mode or specified all mode, the naming module not start and load.
+        if (StringUtils.isEmpty(functionMode)) {
+            return false;
+        }
+        return !FUNCTION_MODE_NAMING.equals(functionMode);
+    }
+}

naming/src/main/resources/META-INF/services/com.alibaba.nacos.sys.filter.NacosPackageExcludeFilter

@@ -0,0 +1,17 @@
+#
+# Copyright 1999-2023 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.
+#
+
+com.alibaba.nacos.naming.config.NamingEnabledFilter

sys/src/main/java/com/alibaba/nacos/sys/filter/NacosPackageExcludeFilter.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright 1999-2023 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.sys.filter;
+
+import java.util.Set;
+
+/**
+ * Nacos server module execute filter.
+ *
+ * @author xiweng.yy
+ */
+public interface NacosPackageExcludeFilter {
+    
+    /**
+     * Get the responsible module package prefix of filter.
+     *
+     * @return package prefix
+     */
+    String getResponsiblePackagePrefix();
+    
+    /**
+     * According the class name and annotations to judge whether the class should be excluded by spring bean.
+     *
+     * @param className       name of this class
+     * @param annotationNames annotations of this class
+     * @return {@code true} if should be excluded, otherwise {@code false}
+     */
+    boolean isExcluded(String className, Set<String> annotationNames);
+}

sys/src/main/java/com/alibaba/nacos/sys/filter/NacosTypeExcludeFilter.java

@@ -0,0 +1,76 @@
+/*
+ * Copyright 1999-2023 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.sys.filter;
+
+import com.alibaba.nacos.common.spi.NacosServiceLoader;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.core.type.classreading.MetadataReader;
+import org.springframework.core.type.classreading.MetadataReaderFactory;
+import org.springframework.core.type.filter.TypeFilter;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ * Nacos server execute filter. To exclude some beans or features by config
+ *
+ * @author xiweng.yy
+ */
+public class NacosTypeExcludeFilter implements TypeFilter {
+    
+    private static final Logger LOGGER = LoggerFactory.getLogger(NacosTypeExcludeFilter.class);
+    
+    private final Map<String, NacosPackageExcludeFilter> packageExcludeFilters;
+    
+    public NacosTypeExcludeFilter() {
+        this.packageExcludeFilters = new HashMap<>(2);
+        for (NacosPackageExcludeFilter each : NacosServiceLoader.load(NacosPackageExcludeFilter.class)) {
+            packageExcludeFilters.put(each.getResponsiblePackagePrefix(), each);
+            LOGGER.info("Load Nacos package exclude filter success, package prefix {}, filter {}",
+                    each.getResponsiblePackagePrefix(), each.getClass().getCanonicalName());
+        }
+    }
+    
+    @Override
+    public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory)
+            throws IOException {
+        // If no exclude filters, all classes should be load.
+        if (packageExcludeFilters.isEmpty()) {
+            return false;
+        }
+        boolean isSpringBootApplication = metadataReader.getAnnotationMetadata()
+                .hasAnnotation(SpringBootApplication.class.getCanonicalName());
+        String className = metadataReader.getClassMetadata().getClassName();
+        if (isSpringBootApplication) {
+            LOGGER.info("Skip @SpringBootApplication annotation for class {} to avoid duplicate scan", className);
+            return true;
+        }
+        for (Map.Entry<String, NacosPackageExcludeFilter> entry : packageExcludeFilters.entrySet()) {
+            // If match the package exclude filter, judged by filter.
+            if (className.startsWith(entry.getKey())) {
+                Set<String> annotations = metadataReader.getAnnotationMetadata().getAnnotationTypes();
+                return entry.getValue().isExcluded(className, annotations);
+            }
+        }
+        // No match filter, load class
+        return false;
+    }
+}