From 102003a52b101c85d7e378e25f35ec6488620fc1 Mon Sep 17 00:00:00 2001
From: AprilWind <2100166581@qq.com>
Date: 星期一, 27 五月 2024 12:23:28 +0800
Subject: [PATCH] update 完善websocket包注释
---
ruoyi-common/ruoyi-common-websocket/src/main/java/org/dromara/common/websocket/handler/PlusWebSocketHandler.java | 50 +++++++++++++++++++++++++++++---------------------
1 files changed, 29 insertions(+), 21 deletions(-)
diff --git a/ruoyi-common/ruoyi-common-websocket/src/main/java/org/dromara/common/websocket/handler/PlusWebSocketHandler.java b/ruoyi-common/ruoyi-common-websocket/src/main/java/org/dromara/common/websocket/handler/PlusWebSocketHandler.java
index 0400b56..759aece 100644
--- a/ruoyi-common/ruoyi-common-websocket/src/main/java/org/dromara/common/websocket/handler/PlusWebSocketHandler.java
+++ b/ruoyi-common/ruoyi-common-websocket/src/main/java/org/dromara/common/websocket/handler/PlusWebSocketHandler.java
@@ -1,10 +1,10 @@
package org.dromara.common.websocket.handler;
+import lombok.extern.slf4j.Slf4j;
import org.dromara.common.core.domain.model.LoginUser;
import org.dromara.common.websocket.dto.WebSocketMessageDto;
import org.dromara.common.websocket.holder.WebSocketSessionHolder;
import org.dromara.common.websocket.utils.WebSocketUtils;
-import lombok.extern.slf4j.Slf4j;
import org.springframework.web.socket.*;
import org.springframework.web.socket.handler.AbstractWebSocketHandler;
@@ -31,34 +31,42 @@
}
/**
- * 澶勭悊鍙戦�佹潵鐨勬枃鏈秷鎭�
+ * 澶勭悊鎺ユ敹鍒扮殑鏂囨湰娑堟伅
*
- * @param session
- * @param message
- * @throws Exception
+ * @param session WebSocket浼氳瘽
+ * @param message 鎺ユ敹鍒扮殑鏂囨湰娑堟伅
+ * @throws Exception 澶勭悊娑堟伅杩囩▼涓彲鑳芥姏鍑虹殑寮傚父
*/
@Override
protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
+ // 浠嶹ebSocket浼氳瘽涓幏鍙栫櫥褰曠敤鎴蜂俊鎭�
LoginUser loginUser = (LoginUser) session.getAttributes().get(LOGIN_USER_KEY);
- log.info("PlusWebSocketHandler, 杩炴帴锛�" + session.getId() + "锛屽凡鏀跺埌娑堟伅:" + message.getPayload());
- List<Long> userIds = List.of(loginUser.getUserId());
+
+ // 鍒涘缓WebSocket娑堟伅DTO瀵硅薄
WebSocketMessageDto webSocketMessageDto = new WebSocketMessageDto();
- webSocketMessageDto.setSessionKeys(userIds);
+ webSocketMessageDto.setSessionKeys(List.of(loginUser.getUserId()));
webSocketMessageDto.setMessage(message.getPayload());
WebSocketUtils.publishMessage(webSocketMessageDto);
}
+ /**
+ * 澶勭悊鎺ユ敹鍒扮殑浜岃繘鍒舵秷鎭�
+ *
+ * @param session WebSocket浼氳瘽
+ * @param message 鎺ユ敹鍒扮殑浜岃繘鍒舵秷鎭�
+ * @throws Exception 澶勭悊娑堟伅杩囩▼涓彲鑳芥姏鍑虹殑寮傚父
+ */
@Override
protected void handleBinaryMessage(WebSocketSession session, BinaryMessage message) throws Exception {
super.handleBinaryMessage(session, message);
}
/**
- * 蹇冭烦鐩戞祴鐨勫洖澶�
+ * 澶勭悊鎺ユ敹鍒扮殑Pong娑堟伅锛堝績璺崇洃娴嬶級
*
- * @param session
- * @param message
- * @throws Exception
+ * @param session WebSocket浼氳瘽
+ * @param message 鎺ユ敹鍒扮殑Pong娑堟伅
+ * @throws Exception 澶勭悊娑堟伅杩囩▼涓彲鑳芥姏鍑虹殑寮傚父
*/
@Override
protected void handlePongMessage(WebSocketSession session, PongMessage message) throws Exception {
@@ -66,11 +74,11 @@
}
/**
- * 杩炴帴鍑洪敊鏃�
+ * 澶勭悊WebSocket浼犺緭閿欒
*
- * @param session
- * @param exception
- * @throws Exception
+ * @param session WebSocket浼氳瘽
+ * @param exception 鍙戠敓鐨勫紓甯�
+ * @throws Exception 澶勭悊杩囩▼涓彲鑳芥姏鍑虹殑寮傚父
*/
@Override
public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
@@ -78,10 +86,10 @@
}
/**
- * 杩炴帴鍏抽棴鍚�
+ * 鍦╓ebSocket杩炴帴鍏抽棴鍚庢墽琛屾竻鐞嗘搷浣�
*
- * @param session
- * @param status
+ * @param session WebSocket浼氳瘽
+ * @param status 鍏抽棴鐘舵�佷俊鎭�
*/
@Override
public void afterConnectionClosed(WebSocketSession session, CloseStatus status) {
@@ -91,9 +99,9 @@
}
/**
- * 鏄惁鏀寔鍒嗙墖娑堟伅
+ * 鎸囩ず澶勭悊绋嬪簭鏄惁鏀寔鎺ユ敹閮ㄥ垎娑堟伅
*
- * @return
+ * @return 濡傛灉鏀寔鎺ユ敹閮ㄥ垎娑堟伅锛屽垯杩斿洖true锛涘惁鍒欒繑鍥瀎alse
*/
@Override
public boolean supportsPartialMessages() {
--
Gitblit v1.9.3