feat WebSocketListener See the code documentation for details;

Kloping · Kloping · commit 75e56995301a · 2024-06-01T17:26:20.000+08:00
fix #24; revise WebSocket ConnectionLostTimeout to 86 default.
diff --git a/docs/network.md b/docs/network.md
@@ -0,0 +1,97 @@
+## 网络相关文档
+
+
+### 主要新增
+
+```java
+
+/**
+ * WebSocketClient的监听处理
+ * <br>  根据提示文档自行处理操作
+ *
+ * @author github.kloping
+ */
+public interface WebSocketListener {
+    /**
+     * @param client
+     * @param handshake
+     * @return 决定是否进行框架接下来的操作 true执行
+     */
+    boolean onOpen(WebSocketClient client, ServerHandshake handshake)
+
+    /**
+     * @param client
+     * @param msg
+     * @return 决定是否进行框架接下来的操作 true执行 此处若false则不执行(所有事件无法触发)
+     */
+    boolean onMessage(WebSocketClient client, String msg)
+
+    /**
+     * @param client
+     * @param msg
+     * @return 决定是否进行框架接下来的操作 true执行 若为false将无法发送消息
+     */
+    boolean onSend(WebSocketClient client, String msg)
+
+    /**
+     * Called after the websocket connection has been closed.
+     *
+     * @param client
+     * @param code   The codes can be looked up here: {@link CloseFrame}
+     * @param reason Additional information string
+     * @param remote Returns whether or not the closing of the connection was initiated by the remote
+     *               host.
+     * @return 决定是否进行框架接下来的操作 true执行 若为false将不自动重连
+     */
+    boolean onClose(WebSocketClient client, int code, String reason, boolean remote)
+
+    /**
+     * @param client
+     * @param e
+     * @return 同上 框架操作仅日志
+     */
+    boolean onError(WebSocketClient client, Exception e)
+}
+
+```
+
+> 使用示例
+
+```java
+public class demo{
+    public static void main(String[] args) {
+        starter.getConfig().setWebSocketListener(new WebSocketListener() {
+            @Override
+            public boolean onOpen(WebSocketClient client, ServerHandshake handshake) {
+                client.setConnectionLostTimeout(10);
+                System.out.println("ws打开了");
+                return true;
+            }
+
+            @Override
+            public boolean onMessage(WebSocketClient client, String msg) {
+                System.out.println("ws接收到消息了");
+                return true;
+            }
+
+            @Override
+            public boolean onSend(WebSocketClient client, String msg) {
+                System.out.println("ws将发送消息");
+                return true;
+            }
+
+            @Override
+            public boolean onClose(WebSocketClient client, int code, String reason, boolean remote) {
+                System.out.println("ws关闭了");
+                return true;
+            }
+
+            @Override
+            public boolean onError(WebSocketClient client, Exception e) {
+                System.out.println("ws内部发送报错");
+                return true;
+            }
+        });
+    }
+}
+```
diff --git a/docs/readme.md b/docs/readme.md
@@ -21,6 +21,7 @@ _**待完善..**_
 - **[事件 event](event.md)**
 - **[消息 message](message.md)**
 - **[动作 action](action.md)**
+- **[网络相关设置](network.md)**
 
 <hr>
 
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>io.github.kloping</groupId>
     <artifactId>bot-qqpd-java</artifactId>
-    <version>1.5.1-Beta2</version>
+    <version>1.5.1-L1</version>
 
     <packaging>jar</packaging>
     <name>bot-qqpd-java</name>
diff --git a/src/main/java/io/github/kloping/qqbot/Starter.java b/src/main/java/io/github/kloping/qqbot/Starter.java
@@ -10,10 +10,12 @@
 import io.github.kloping.qqbot.impl.ListenerHost;
 import io.github.kloping.qqbot.interfaces.ImageUploadInterceptor;
 import io.github.kloping.qqbot.network.Events;
+import io.github.kloping.qqbot.network.WebSocketListener;
 import io.github.kloping.qqbot.network.WssWorker;
 import io.github.kloping.qqbot.utils.LoggerImpl;
 import lombok.Data;
 import lombok.Getter;
+import org.java_websocket.client.WebSocketClient;
 
 import java.util.HashSet;
 import java.util.Set;
@@ -187,6 +189,7 @@ public static class Config {
         private Boolean reconnect = true;
         private Set<ListenerHost> listenerHosts = new HashSet<>();
         private ImageUploadInterceptor interceptor0;
+        private WebSocketListener webSocketListener;
     }
 
     public Bot getBot() {
diff --git a/src/main/java/io/github/kloping/qqbot/impl/BaseConnectedEvent.java b/src/main/java/io/github/kloping/qqbot/impl/BaseConnectedEvent.java
@@ -41,6 +41,6 @@ public String getClassName() {
 
     @Override
     public String toString() {
-        return String.format("Bot(%s) Connected! By author kloping of bot-qqpd-java for version 1.5.1-Beta2", bot.getConfig().getAppid());
+        return String.format("Bot(%s) Connected! By author kloping of bot-qqpd-java for version 1.5.1-L1", bot.getConfig().getAppid());
     }
 }
diff --git a/src/main/java/io/github/kloping/qqbot/network/WebSocketListener.java b/src/main/java/io/github/kloping/qqbot/network/WebSocketListener.java
@@ -0,0 +1,63 @@
+package io.github.kloping.qqbot.network;
+
+import org.java_websocket.client.WebSocketClient;
+import org.java_websocket.framing.CloseFrame;
+import org.java_websocket.handshake.ServerHandshake;
+
+/**
+ * WebSocketClient的监听处理
+ * <br>  根据提示文档自行处理操作
+ *
+ * @author github.kloping
+ */
+public interface WebSocketListener {
+    /**
+     * @param client
+     * @param handshake
+     * @return 决定是否进行框架接下来的操作 true执行
+     */
+    default boolean onOpen(WebSocketClient client, ServerHandshake handshake) {
+        return true;
+    }
+
+    /**
+     * @param client
+     * @param msg
+     * @return 决定是否进行框架接下来的操作 true执行 此处若false则不执行(所有事件无法触发)
+     */
+    default boolean onMessage(WebSocketClient client, String msg) {
+        return true;
+    }
+
+    /**
+     * @param client
+     * @param msg
+     * @return 决定是否进行框架接下来的操作 true执行 若为false将无法发送消息
+     */
+    default boolean onSend(WebSocketClient client, String msg) {
+        return true;
+    }
+
+    /**
+     * Called after the websocket connection has been closed.
+     *
+     * @param client
+     * @param code   The codes can be looked up here: {@link CloseFrame}
+     * @param reason Additional information string
+     * @param remote Returns whether or not the closing of the connection was initiated by the remote
+     *               host.
+     * @return 决定是否进行框架接下来的操作 true执行 若为false将不自动重连
+     */
+    default boolean onClose(WebSocketClient client, int code, String reason, boolean remote) {
+        return true;
+    }
+
+    /**
+     * @param client
+     * @param e
+     * @return 同上 框架操作仅日志
+     */
+    default boolean onError(WebSocketClient client, Exception e) {
+        return true;
+    }
+}
diff --git a/src/main/java/io/github/kloping/qqbot/network/WssWorker.java b/src/main/java/io/github/kloping/qqbot/network/WssWorker.java
@@ -38,6 +38,9 @@ public class WssWorker implements Runnable {
     @AutoStand
     private Logger logger;
 
+    @AutoStand
+    Starter.Config config;
+
     public WebSocketClient webSocket;
 
     protected Integer msgr = 0;
@@ -62,11 +65,15 @@ public void run() {
 
                 @Override
                 public void onOpen(ServerHandshake serverHandshake) {
+                    if (preMethods(serverHandshake)) return;
                     logger.info("wss opened");
                 }
 
                 @Override
                 public void onMessage(String s) {
+                    if (config.getWebSocketListener() != null)
+                        if (!config.getWebSocketListener().onMessage(webSocket, s))
+                            return;
                     Pack pack = GSON.fromJson(s, Pack.class);
                     logger.log(String.format("receive %s", s));
                     if (pack == null) {
@@ -80,14 +87,16 @@ public void onMessage(String s) {
                 }
 
                 @Override
-                public void send(String text) throws NotYetConnectedException {
-                    super.send(text);
-                    logger.log("wss send: " + text);
+                public void send(String msg) throws NotYetConnectedException {
+                    if (preMethods(msg)) return;
+                    super.send(msg);
+                    logger.log("wss send: " + msg);
                     msgs++;
                 }
 
                 @Override
                 public void onClose(int i, String s, boolean b) {
+                    if (preMethods(i, s, b)) return;
                     logger.waring("wss closed with code " + i + " " + s);
                     for (OnCloseListener onCloseListener : closeListeners) {
                         onCloseListener.onClose(i, webSocket);
@@ -96,12 +105,13 @@ public void onClose(int i, String s, boolean b) {
 
                 @Override
                 public void onError(Exception e) {
+                    if (preMethods(e)) return;
                     logger.error("wss error");
                     e.printStackTrace();
                 }
             };
             //两次心跳的事件
-            webSocket.setConnectionLostTimeout(120);
+            webSocket.setConnectionLostTimeout(86);
             webSocket.run();
         } catch (Exception e) {
             logger.error("在WebSocketClient启动时失败");
@@ -115,11 +125,8 @@ public void onError(Exception e) {
             run();
         }
     }
-
-    @AutoStand
-    Starter.Config config;
-
     public List<OnCloseListener> closeListeners = new ArrayList<>();
+
     public List<OnPackReceive> onPackReceives = new LinkedList<>();
 
     public Boolean getReconnect() {
@@ -135,6 +142,18 @@ public List<OnPackReceive> getOnPackReceives() {
         return onPackReceives;
     }
 
-    public void close() {
+    private boolean preMethods(Object... objects) {
+        WebSocketListener listener = config.getWebSocketListener();
+        if (listener == null) return false;
+        Object o1 = objects[0];
+        if (o1 instanceof Exception) {
+            return !listener.onError(webSocket, (Exception) o1);
+        } else if (o1 instanceof String) {
+            return !listener.onSend(webSocket, o1.toString());
+        } else if (o1 instanceof ServerHandshake) {
+            return !listener.onOpen(webSocket, (ServerHandshake) o1);
+        } else if (o1 instanceof Integer) {
+            return !listener.onClose(webSocket, (Integer) objects[0], (String) objects[1], (boolean) objects[2]);
+        } else return false;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,6 @@ public String getClassName() {`
`41`	`41`
`42`	`42`	`@Override`
`43`	`43`	`public String toString() {`
`44`		`- return String.format("Bot(%s) Connected! By author kloping of bot-qqpd-java for version 1.5.1-Beta2", bot.getConfig().getAppid());`
	`44`	`+ return String.format("Bot(%s) Connected! By author kloping of bot-qqpd-java for version 1.5.1-L1", bot.getConfig().getAppid());`
`45`	`45`	`}`
`46`	`46`	`}`