From 6c10e80d71a7ce768d4fd44006c707c599b3960e Mon Sep 17 00:00:00 2001 From: Charles7c Date: Sun, 23 Jun 2024 11:30:03 +0800 Subject: [PATCH] =?UTF-8?q?refactor(messaging/websocket):=20=E4=BC=98?= =?UTF-8?q?=E5=8C=96=20WebSocket=20=E7=9B=B8=E5=85=B3=E9=85=8D=E7=BD=AE?= =?UTF-8?q?=E5=8F=8A=E5=91=BD=E5=90=8D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../WebSocketAutoConfiguration.java | 10 ++-- .../autoconfigure/WebSocketProperties.java | 12 ++-- ...vider.java => WebSocketClientService.java} | 11 ++-- .../websocket/core/WebSocketHandler.java | 39 +++++++++---- .../websocket/core/WebSocketInterceptor.java | 12 ++-- .../websocket/model/CurrentUser.java | 58 ------------------- .../websocket/util/WebSocketUtils.java | 8 +-- .../exception/GlobalExceptionHandler.java | 1 - 8 files changed, 54 insertions(+), 97 deletions(-) rename continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/core/{CurrentUserProvider.java => WebSocketClientService.java} (76%) delete mode 100644 continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/model/CurrentUser.java diff --git a/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/autoconfigure/WebSocketAutoConfiguration.java b/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/autoconfigure/WebSocketAutoConfiguration.java index 8ed0c3ef..6c45d550 100644 --- a/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/autoconfigure/WebSocketAutoConfiguration.java +++ b/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/autoconfigure/WebSocketAutoConfiguration.java @@ -31,7 +31,7 @@ import org.springframework.web.socket.config.annotation.EnableWebSocket; import org.springframework.web.socket.config.annotation.WebSocketConfigurer; import org.springframework.web.socket.server.HandshakeInterceptor; import top.continew.starter.core.constant.PropertiesConstants; -import top.continew.starter.messaging.websocket.core.CurrentUserProvider; +import top.continew.starter.messaging.websocket.core.WebSocketClientService; import top.continew.starter.messaging.websocket.core.WebSocketInterceptor; import top.continew.starter.messaging.websocket.dao.WebSocketSessionDao; import top.continew.starter.messaging.websocket.dao.WebSocketSessionDaoDefaultImpl; @@ -73,7 +73,7 @@ public class WebSocketAutoConfiguration { @Bean @ConditionalOnMissingBean public HandshakeInterceptor handshakeInterceptor() { - return new WebSocketInterceptor(properties, SpringUtil.getBean(CurrentUserProvider.class)); + return new WebSocketInterceptor(properties, SpringUtil.getBean(WebSocketClientService.class)); } /** @@ -86,12 +86,12 @@ public class WebSocketAutoConfiguration { } /** - * 当前用户 Provider（如不提供，则报错） + * WebSocket 客户端服务（如不提供，则报错） */ @Bean @ConditionalOnMissingBean - public CurrentUserProvider currentUserProvider() { - throw new NoSuchBeanDefinitionException(CurrentUserProvider.class); + public WebSocketClientService webSocketClientService() { + throw new NoSuchBeanDefinitionException(WebSocketClientService.class); } @PostConstruct diff --git a/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/autoconfigure/WebSocketProperties.java b/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/autoconfigure/WebSocketProperties.java index eb13c5a3..d564c51b 100644 --- a/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/autoconfigure/WebSocketProperties.java +++ b/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/autoconfigure/WebSocketProperties.java @@ -52,9 +52,9 @@ public class WebSocketProperties { private List allowedOrigins = new ArrayList<>(ALL); /** - * 当前登录用户 Key + * 客户端 ID Key */ - private String currentUserKey = "CURRENT_USER"; + private String clientIdKey = "CLIENT_ID"; public boolean isEnabled() { return enabled; @@ -80,11 +80,11 @@ public class WebSocketProperties { this.allowedOrigins = allowedOrigins; } - public String getCurrentUserKey() { - return currentUserKey; + public String getClientIdKey() { + return clientIdKey; } - public void setCurrentUserKey(String currentUserKey) { - this.currentUserKey = currentUserKey; + public void setClientIdKey(String clientIdKey) { + this.clientIdKey = clientIdKey; } } diff --git a/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/core/CurrentUserProvider.java b/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/core/WebSocketClientService.java similarity index 76% rename from continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/core/CurrentUserProvider.java rename to continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/core/WebSocketClientService.java index bb8ac3fe..ef1dd8dc 100644 --- a/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/core/CurrentUserProvider.java +++ b/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/core/WebSocketClientService.java @@ -17,21 +17,20 @@ package top.continew.starter.messaging.websocket.core; import org.springframework.http.server.ServletServerHttpRequest; -import top.continew.starter.messaging.websocket.model.CurrentUser; /** - * 当前登录用户 Provider + * WebSocket 客户端服务 * * @author Charles7c * @since 2.1.0 */ -public interface CurrentUserProvider { +public interface WebSocketClientService { /** - * 获取当前登录用户 + * 获取当前客户端 ID * * @param request 请求对象 - * @return 当前登录用户 + * @return 当前客户端 ID */ - CurrentUser getCurrentUser(ServletServerHttpRequest request); + String getClientId(ServletServerHttpRequest request); } diff --git a/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/core/WebSocketHandler.java b/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/core/WebSocketHandler.java index 11261a88..9264ca55 100644 --- a/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/core/WebSocketHandler.java +++ b/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/core/WebSocketHandler.java @@ -22,10 +22,12 @@ import org.slf4j.LoggerFactory; import org.springframework.web.socket.CloseStatus; import org.springframework.web.socket.TextMessage; import org.springframework.web.socket.WebSocketSession; -import org.springframework.web.socket.handler.AbstractWebSocketHandler; +import org.springframework.web.socket.handler.TextWebSocketHandler; import top.continew.starter.messaging.websocket.autoconfigure.WebSocketProperties; import top.continew.starter.messaging.websocket.dao.WebSocketSessionDao; +import java.io.IOException; + /** * WebSocket 处理器 * @@ -33,7 +35,7 @@ import top.continew.starter.messaging.websocket.dao.WebSocketSessionDao; * @author Charles7c * @since 2.1.0 */ -public class WebSocketHandler extends AbstractWebSocketHandler { +public class WebSocketHandler extends TextWebSocketHandler { private static final Logger log = LoggerFactory.getLogger(WebSocketHandler.class); private final WebSocketProperties webSocketProperties; @@ -46,26 +48,41 @@ public class WebSocketHandler extends AbstractWebSocketHandler { @Override protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception { - log.info("WebSocket receive message. sessionId: {}, message: {}.", session.getId(), message.getPayload()); + String clientId = this.getClientId(session); + log.info("WebSocket receive message. clientId: {}, message: {}.", clientId, message.getPayload()); super.handleTextMessage(session, message); } @Override public void afterConnectionEstablished(WebSocketSession session) { - String sessionKey = Convert.toStr(session.getAttributes().get(webSocketProperties.getCurrentUserKey())); - webSocketSessionDao.add(sessionKey, session); - log.info("WebSocket connect successfully. sessionKey: {}.", sessionKey); + String clientId = this.getClientId(session); + webSocketSessionDao.add(clientId, session); + log.info("WebSocket client connect successfully. clientId: {}.", clientId); } @Override public void afterConnectionClosed(WebSocketSession session, CloseStatus status) { - String sessionKey = Convert.toStr(session.getAttributes().get(webSocketProperties.getCurrentUserKey())); - webSocketSessionDao.delete(sessionKey); - log.info("WebSocket connect closed. sessionKey: {}.", sessionKey); + String clientId = this.getClientId(session); + webSocketSessionDao.delete(clientId); + log.info("WebSocket client connect closed. clientId: {}.", clientId); } @Override - public void handleTransportError(WebSocketSession session, Throwable exception) { - log.error("WebSocket transport error. sessionId: {}.", session.getId(), exception); + public void handleTransportError(WebSocketSession session, Throwable exception) throws IOException { + String clientId = this.getClientId(session); + if (session.isOpen()) { + session.close(); + } + webSocketSessionDao.delete(clientId); + } + + /** + * 获取客户端 ID + * + * @param session 会话 + * @return 客户端 ID + */ + private String getClientId(WebSocketSession session) { + return Convert.toStr(session.getAttributes().get(webSocketProperties.getClientIdKey())); } } diff --git a/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/core/WebSocketInterceptor.java b/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/core/WebSocketInterceptor.java index 390468d6..79d03d59 100644 --- a/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/core/WebSocketInterceptor.java +++ b/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/core/WebSocketInterceptor.java @@ -22,7 +22,6 @@ import org.springframework.http.server.ServletServerHttpRequest; import org.springframework.web.socket.WebSocketHandler; import org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor; import top.continew.starter.messaging.websocket.autoconfigure.WebSocketProperties; -import top.continew.starter.messaging.websocket.model.CurrentUser; import java.util.Map; @@ -36,11 +35,12 @@ import java.util.Map; public class WebSocketInterceptor extends HttpSessionHandshakeInterceptor { private final WebSocketProperties webSocketProperties; - private final CurrentUserProvider currentUserProvider; + private final WebSocketClientService webSocketClientService; - public WebSocketInterceptor(WebSocketProperties webSocketProperties, CurrentUserProvider currentUserProvider) { + public WebSocketInterceptor(WebSocketProperties webSocketProperties, + WebSocketClientService webSocketClientService) { this.webSocketProperties = webSocketProperties; - this.currentUserProvider = currentUserProvider; + this.webSocketClientService = webSocketClientService; } @Override @@ -48,8 +48,8 @@ public class WebSocketInterceptor extends HttpSessionHandshakeInterceptor { ServerHttpResponse response, WebSocketHandler wsHandler, Map attributes) { - CurrentUser currentUser = currentUserProvider.getCurrentUser((ServletServerHttpRequest)request); - attributes.put(webSocketProperties.getCurrentUserKey(), currentUser.getUserId()); + String clientId = webSocketClientService.getClientId((ServletServerHttpRequest)request); + attributes.put(webSocketProperties.getClientIdKey(), clientId); return true; } diff --git a/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/model/CurrentUser.java b/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/model/CurrentUser.java deleted file mode 100644 index 917b1987..00000000 --- a/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/model/CurrentUser.java +++ /dev/null @@ -1,58 +0,0 @@ -/* - * Copyright (c) 2022-present Charles7c Authors. All Rights Reserved. - *

- * Licensed under the GNU LESSER GENERAL PUBLIC LICENSE 3.0; - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - *

- * http://www.gnu.org/licenses/lgpl.html - *

- * 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 top.continew.starter.messaging.websocket.model; - -import java.io.Serial; -import java.io.Serializable; - -/** - * 当前登录用户信息 - * - * @author Charles7c - * @since 2.1.0 - */ -public class CurrentUser implements Serializable { - - @Serial - private static final long serialVersionUID = 1L; - - /** - * 用户 ID - */ - private String userId; - - /** - * 扩展字段 - */ - private Object extend; - - public String getUserId() { - return userId; - } - - public void setUserId(String userId) { - this.userId = userId; - } - - public Object getExtend() { - return extend; - } - - public void setExtend(Object extend) { - this.extend = extend; - } -} diff --git a/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/util/WebSocketUtils.java b/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/util/WebSocketUtils.java index 88bd1d81..a56685ed 100644 --- a/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/util/WebSocketUtils.java +++ b/continew-starter-messaging/continew-starter-messaging-websocket/src/main/java/top/continew/starter/messaging/websocket/util/WebSocketUtils.java @@ -44,11 +44,11 @@ public class WebSocketUtils { /** * 发送消息 * - * @param sessionKey 会话 Key - * @param message 消息内容 + * @param clientId 客户端 ID + * @param message 消息内容 */ - public static void sendMessage(String sessionKey, String message) { - WebSocketSession session = SESSION_DAO.get(sessionKey); + public static void sendMessage(String clientId, String message) { + WebSocketSession session = SESSION_DAO.get(clientId); sendMessage(session, message); } diff --git a/continew-starter-web/src/main/java/top/continew/starter/web/autoconfigure/exception/GlobalExceptionHandler.java b/continew-starter-web/src/main/java/top/continew/starter/web/autoconfigure/exception/GlobalExceptionHandler.java index 24e8cdfc..4c827ff0 100644 --- a/continew-starter-web/src/main/java/top/continew/starter/web/autoconfigure/exception/GlobalExceptionHandler.java +++ b/continew-starter-web/src/main/java/top/continew/starter/web/autoconfigure/exception/GlobalExceptionHandler.java @@ -32,7 +32,6 @@ import org.springframework.web.bind.MethodArgumentNotValidException; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.RestControllerAdvice; import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException; -import org.springframework.web.multipart.MaxUploadSizeExceededException; import org.springframework.web.multipart.MultipartException; import top.continew.starter.core.constant.StringConstants; import top.continew.starter.core.exception.BadRequestException;