This is an automated email from the ASF dual-hosted git repository.
xiaoyu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shenyu.git
The following commit(s) were added to refs/heads/master by this push:
new 30ff8f124 [ISSUE #3777] banning #printStackTrace in source code (#3791)
30ff8f124 is described below
commit 30ff8f124e8d1d6d72961f9fe6e160a7b395060d
Author: dragon-zhang <[email protected]>
AuthorDate: Wed Aug 3 10:40:12 2022 +0800
[ISSUE #3777] banning #printStackTrace in source code (#3791)
---
script/shenyu_checkstyle.xml | 4 ++++
.../disruptor/subcriber/ShenyuClientURIExecutorSubscriber.java | 2 +-
.../src/main/java/org/apache/shenyu/common/utils/GsonUtils.java | 2 +-
.../org/apache/shenyu/common/utils/UpstreamCheckUtilsTest.java | 6 +++++-
.../org/apache/shenyu/examples/grpc/demo/EventServiceImpl.java | 8 ++++++--
.../org/apache/shenyu/examples/grpc/demo/HelloServiceImpl.java | 8 ++++++--
.../org/apache/shenyu/examples/grpc/stream/StreamServiceImpl.java | 2 --
.../apache/shenyu/examples/websocket/config/WsSessionManager.java | 2 +-
.../apache/shenyu/plugin/sofa/cache/ApplicationConfigCache.java | 1 -
9 files changed, 24 insertions(+), 11 deletions(-)
diff --git a/script/shenyu_checkstyle.xml b/script/shenyu_checkstyle.xml
index 93487a381..bb524cd7c 100644
--- a/script/shenyu_checkstyle.xml
+++ b/script/shenyu_checkstyle.xml
@@ -44,6 +44,10 @@
<property name="format" value="@author"/>
<property name="message" value="Please remove @author tag in
javadoc!"/>
</module>
+ <module name="RegexpSingleline">
+ <property name="format" value="\.printStackTrace"/>
+ <property name="message" value="Prohibit invoking .printStackTrace in
source code ! Please use org.slf4j.Logger and write log instead."/>
+ </module>
<module name="TreeWalker">
diff --git
a/shenyu-client/shenyu-client-core/src/main/java/org/apache/shenyu/client/core/disruptor/subcriber/ShenyuClientURIExecutorSubscriber.java
b/shenyu-client/shenyu-client-core/src/main/java/org/apache/shenyu/client/core/disruptor/subcriber/ShenyuClientURIExecutorSubscriber.java
index 4017f3104..f8a44aa13 100644
---
a/shenyu-client/shenyu-client-core/src/main/java/org/apache/shenyu/client/core/disruptor/subcriber/ShenyuClientURIExecutorSubscriber.java
+++
b/shenyu-client/shenyu-client-core/src/main/java/org/apache/shenyu/client/core/disruptor/subcriber/ShenyuClientURIExecutorSubscriber.java
@@ -75,7 +75,7 @@ public class ShenyuClientURIExecutorSubscriber implements
ExecutorTypeSubscriber
try {
TimeUnit.MILLISECONDS.sleep(sleepTime);
} catch (InterruptedException ex) {
- ex.printStackTrace();
+ LOG.error("interrupted when sleep", ex);
}
}
}
diff --git
a/shenyu-common/src/main/java/org/apache/shenyu/common/utils/GsonUtils.java
b/shenyu-common/src/main/java/org/apache/shenyu/common/utils/GsonUtils.java
index ee7aa9cf6..4dd57b2de 100644
--- a/shenyu-common/src/main/java/org/apache/shenyu/common/utils/GsonUtils.java
+++ b/shenyu-common/src/main/java/org/apache/shenyu/common/utils/GsonUtils.java
@@ -190,7 +190,7 @@ public class GsonUtils {
.append(URLDecoder.decode(v, Constants.DECODE))
.append(AND);
} catch (UnsupportedEncodingException e) {
- e.printStackTrace();
+ LOG.error("decode:{} failed !", v, e);
}
});
final String r = stringBuilder.toString();
diff --git
a/shenyu-common/src/test/java/org/apache/shenyu/common/utils/UpstreamCheckUtilsTest.java
b/shenyu-common/src/test/java/org/apache/shenyu/common/utils/UpstreamCheckUtilsTest.java
index 7af66360d..47d86dbc7 100644
---
a/shenyu-common/src/test/java/org/apache/shenyu/common/utils/UpstreamCheckUtilsTest.java
+++
b/shenyu-common/src/test/java/org/apache/shenyu/common/utils/UpstreamCheckUtilsTest.java
@@ -19,6 +19,8 @@ package org.apache.shenyu.common.utils;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
import java.io.IOException;
import java.net.ServerSocket;
@@ -31,6 +33,8 @@ import static org.junit.jupiter.api.Assertions.assertTrue;
* Test cases for UpstreamCheckUtils.
*/
public final class UpstreamCheckUtilsTest {
+
+ private static final Logger LOG =
LoggerFactory.getLogger(UpstreamCheckUtilsTest.class);
private volatile int port = -1;
@@ -50,7 +54,7 @@ public final class UpstreamCheckUtilsTest {
Socket socket = serverSocket.accept();
socket.close();
} catch (IOException e) {
- e.printStackTrace();
+ LOG.error(e.getMessage());
}
};
new Thread(runnable).start();
diff --git
a/shenyu-examples/shenyu-examples-grpc/src/main/java/org/apache/shenyu/examples/grpc/demo/EventServiceImpl.java
b/shenyu-examples/shenyu-examples-grpc/src/main/java/org/apache/shenyu/examples/grpc/demo/EventServiceImpl.java
index e89798374..8704c59ac 100644
---
a/shenyu-examples/shenyu-examples-grpc/src/main/java/org/apache/shenyu/examples/grpc/demo/EventServiceImpl.java
+++
b/shenyu-examples/shenyu-examples-grpc/src/main/java/org/apache/shenyu/examples/grpc/demo/EventServiceImpl.java
@@ -23,12 +23,16 @@ import event.EventResponse;
import event.EventServiceGrpc;
import io.grpc.stub.StreamObserver;
import org.apache.shenyu.client.grpc.common.annotation.ShenyuGrpcClient;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Service;
@ShenyuGrpcClient("/eventService")
@Service
public class EventServiceImpl extends EventServiceGrpc.EventServiceImplBase {
-
+
+ private static final Logger LOG =
LoggerFactory.getLogger(EventServiceImpl.class);
+
@ShenyuGrpcClient("/sendEvent")
@Override
public void sendEvent(EventRequest request, StreamObserver<EventResponse>
responseObserver) {
@@ -51,7 +55,7 @@ public class EventServiceImpl extends
EventServiceGrpc.EventServiceImplBase {
@Override
public void onError(final Throwable t) {
- t.printStackTrace();
+ LOG.error(t.getMessage());
}
@Override
diff --git
a/shenyu-examples/shenyu-examples-grpc/src/main/java/org/apache/shenyu/examples/grpc/demo/HelloServiceImpl.java
b/shenyu-examples/shenyu-examples-grpc/src/main/java/org/apache/shenyu/examples/grpc/demo/HelloServiceImpl.java
index aa92fa219..d19ce8343 100644
---
a/shenyu-examples/shenyu-examples-grpc/src/main/java/org/apache/shenyu/examples/grpc/demo/HelloServiceImpl.java
+++
b/shenyu-examples/shenyu-examples-grpc/src/main/java/org/apache/shenyu/examples/grpc/demo/HelloServiceImpl.java
@@ -21,13 +21,17 @@ import hello.HelloResponse;
import hello.HelloServiceGrpc;
import io.grpc.stub.StreamObserver;
import org.apache.shenyu.client.grpc.common.annotation.ShenyuGrpcClient;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Service;
@ShenyuGrpcClient("/helloService/**")
@Service
public class HelloServiceImpl extends HelloServiceGrpc.HelloServiceImplBase {
-
+
+ private static final Logger LOG =
LoggerFactory.getLogger(HelloServiceImpl.class);
+
@Override
public void hello(HelloRequest request, StreamObserver<HelloResponse>
responseObserver) {
HelloResponse response = HelloResponse.newBuilder().setData("hello: "
+ request.getData()).build();
@@ -48,7 +52,7 @@ public class HelloServiceImpl extends
HelloServiceGrpc.HelloServiceImplBase {
@Override
public void onError(final Throwable t) {
- t.printStackTrace();
+ LOG.error(t.getMessage());
}
@Override
diff --git
a/shenyu-examples/shenyu-examples-grpc/src/main/java/org/apache/shenyu/examples/grpc/stream/StreamServiceImpl.java
b/shenyu-examples/shenyu-examples-grpc/src/main/java/org/apache/shenyu/examples/grpc/stream/StreamServiceImpl.java
index f6de4c1b7..2ac784900 100644
---
a/shenyu-examples/shenyu-examples-grpc/src/main/java/org/apache/shenyu/examples/grpc/stream/StreamServiceImpl.java
+++
b/shenyu-examples/shenyu-examples-grpc/src/main/java/org/apache/shenyu/examples/grpc/stream/StreamServiceImpl.java
@@ -74,7 +74,6 @@ public class StreamServiceImpl extends
StreamServiceGrpc.StreamServiceImplBase {
@Override
public void onError(final Throwable t) {
LOG.error(t.getMessage());
- t.printStackTrace();
}
@Override
@@ -106,7 +105,6 @@ public class StreamServiceImpl extends
StreamServiceGrpc.StreamServiceImplBase {
@Override
public void onError(final Throwable t) {
LOG.error(t.getMessage());
- t.printStackTrace();
}
@Override
diff --git
a/shenyu-examples/shenyu-examples-websocket/shenyu-example-spring-native-websocket/src/main/java/org/apache/shenyu/examples/websocket/config/WsSessionManager.java
b/shenyu-examples/shenyu-examples-websocket/shenyu-example-spring-native-websocket/src/main/java/org/apache/shenyu/examples/websocket/config/WsSessionManager.java
index a8e7c6ee6..eda516312 100644
---
a/shenyu-examples/shenyu-examples-websocket/shenyu-example-spring-native-websocket/src/main/java/org/apache/shenyu/examples/websocket/config/WsSessionManager.java
+++
b/shenyu-examples/shenyu-examples-websocket/shenyu-example-spring-native-websocket/src/main/java/org/apache/shenyu/examples/websocket/config/WsSessionManager.java
@@ -65,7 +65,7 @@ public class WsSessionManager {
try {
session.close();
} catch (IOException e) {
- e.printStackTrace();
+ log.error("session:{} close failed !", key, e);
}
}
}
diff --git
a/shenyu-plugin/shenyu-plugin-sofa/src/main/java/org/apache/shenyu/plugin/sofa/cache/ApplicationConfigCache.java
b/shenyu-plugin/shenyu-plugin-sofa/src/main/java/org/apache/shenyu/plugin/sofa/cache/ApplicationConfigCache.java
index 1715a1edc..e4aed5bf6 100644
---
a/shenyu-plugin/shenyu-plugin-sofa/src/main/java/org/apache/shenyu/plugin/sofa/cache/ApplicationConfigCache.java
+++
b/shenyu-plugin/shenyu-plugin-sofa/src/main/java/org/apache/shenyu/plugin/sofa/cache/ApplicationConfigCache.java
@@ -224,7 +224,6 @@ public final class ApplicationConfigCache {
}
} catch (Exception e) {
LOG.error("init sofa reference exception", e);
- e.printStackTrace();
}
return reference;
}
