[ISSUE#11956] Fix logging module old bugs (alibaba#12011)

* Remove log4j dependencies from nacos-client. * Fix logback listener don't add to context. * Fix can't adapter low version logback below 1.1.10. * For checkstyle.
syshenyao · Apr 24, 2024 · da3e88b · da3e88b
1 parent de10c07
commit da3e88b
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 22 deletions.
diff --git a/client/pom.xml b/client/pom.xml
@@ -72,24 +72,6 @@
             <artifactId>nacos-log4j2-adapter</artifactId>
             <version>${project.version}</version>
         </dependency>
-
-        <dependency>
-            <groupId>org.apache.logging.log4j</groupId>
-            <artifactId>log4j-core</artifactId>
-            <optional>true</optional>
-        </dependency>
-
-        <dependency>
-            <groupId>org.apache.logging.log4j</groupId>
-            <artifactId>log4j-api</artifactId>
-            <optional>true</optional>
-        </dependency>
-
-        <dependency>
-            <groupId>org.apache.logging.log4j</groupId>
-            <artifactId>log4j-slf4j-impl</artifactId>
-            <optional>true</optional>
-        </dependency>
 
         <dependency>
             <artifactId>commons-codec</artifactId>

diff --git a/logger-adapter-impl/log4j2-adapter/src/main/resources/nacos-log4j2.xml b/logger-adapter-impl/log4j2-adapter/src/main/resources/nacos-log4j2.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-  ~ Copyright 1999-2018 Alibaba Group Holding Ltd.
+  ~ 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.

diff --git a/.../src/main/java/com/alibaba/nacos/logger/adapter/logback12/LogbackNacosLoggingAdapter.java b/.../src/main/java/com/alibaba/nacos/logger/adapter/logback12/LogbackNacosLoggingAdapter.java
@@ -20,7 +20,6 @@
 import ch.qos.logback.classic.Logger;
 import ch.qos.logback.classic.LoggerContext;
 import ch.qos.logback.classic.spi.LoggerContextListener;
-import ch.qos.logback.core.CoreConstants;
 import com.alibaba.nacos.common.logging.NacosLoggingAdapter;
 import com.alibaba.nacos.common.logging.NacosLoggingProperties;
 import com.alibaba.nacos.common.utils.ResourceUtils;
@@ -91,7 +90,7 @@ public void loadConfiguration(NacosLoggingProperties loggingProperties) {
         String location = loggingProperties.getLocation();
         configurator.setLoggingProperties(loggingProperties);
         LoggerContext loggerContext = loadConfigurationOnStart(location);
-        if (loggerContext.getObject(CoreConstants.RECONFIGURE_ON_CHANGE_TASK) != null && hasNoListener(loggerContext)) {
+        if (hasNoListener(loggerContext)) {
             addListener(loggerContext, location);
         }
     }

diff --git a/...in/java/com/alibaba/nacos/logger/adapter/logback12/NacosLogbackConfiguratorAdapterV1.java b/...in/java/com/alibaba/nacos/logger/adapter/logback12/NacosLogbackConfiguratorAdapterV1.java
@@ -71,7 +71,12 @@ public void configure(URL url) throws Exception {
             URLConnection urlConnection = url.openConnection();
             urlConnection.setUseCaches(false);
             in = urlConnection.getInputStream();
-            doConfigure(in, url.toExternalForm());
+            if (hasNewDoConfigureApi()) {
+                doConfigure(in, url.toExternalForm());
+            } else {
+                // adapter old version of logback below 1.1.10
+                doConfigure(in);
+            }
         } catch (IOException ioe) {
             String errMsg = "Could not open URL [" + url + "].";
             addError(errMsg, ioe);
@@ -89,4 +94,17 @@ public void configure(URL url) throws Exception {
         }
     }
 
+    /**
+     * Since logback 1.1.10, Add new doConfigure API with sax systemId and use this API to do configure.
+     *
+     * @return {@code true} when logback is upper 1.1.10, otherwise {@code false}
+     */
+    private boolean hasNewDoConfigureApi() {
+        try {
+            this.getClass().getMethod("doConfigure", InputStream.class, String.class);
+            return true;
+        } catch (NoSuchMethodException e) {
+            return false;
+        }
+    }
 }