【Java】SpringBoot快速整合WebSocket实现客户端服务端相互推送信息_业界新闻

发布时间:2024-07-17 23:44

阅读量:1

什么是webSocket？

WebSocket是一种在单个TCP连接上进行全双工通信的协议。WebSocket使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。而Http请求只能从客户端请求服务端才能得到响应。在WebSocket API中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。

webSocket可以用来做什么?

利用双向数据传输的特点可以用来完成很多功能，不需要前端轮询，浪费资源。例如：
聊天功能、数据实时更新和视频弹幕等

webSocket协议
本协议有两部分：握手和数据传输。
握手是基于http协议的。

来自客户端的握手看起来像如下形式：

GET ws://localhost/chat HTTP/1.1
Host: localhost
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Key:dGhlIHNhbXBsZSBub25jZQ==
Sec-WebSocket-Protocol: chat,superchat
Sec-WebSocket-Version: 13

来自服务器的握手看起来像如下形式

HTTP/1.1 101 Switching Protocols
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Accept:s3pPLMBiTxaQ9kYGzzhZRbK+xOo=
Sec-WebSocket-Protocol: chat

SpringBoot快速整合WebSocket代码案例：

下面我就使用SpringBoot快速整合WebSocket实现服务端与客户端的相互推送消息；

代码层级结构

maven依赖

     <!--WebSocket的依赖-->         <dependency>             <groupId>org.springframework.boot</groupId>             <artifactId>spring-boot-starter-websocket</artifactId>         </dependency>

WebSocket配置类

package com.example.springboot_websocket_demo01;  import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.web.socket.server.standard.ServerEndpointExporter; @Configuration public class WebSocketConfig {     /**      *   注入ServerEndpointExporter，      *   这个bean会自动注册使用了@ServerEndpoint注解声明的Websocket endpoint      */     @Bean     public ServerEndpointExporter serverEndpointExporter() {         return new ServerEndpointExporter();     }      }

WebSocket操作类

通过该类WebSocket可以进行群推送以及单点推送

package com.example.springboot_websocket_demo01;  import jakarta.websocket.*; import jakarta.websocket.server.PathParam; import jakarta.websocket.server.ServerEndpoint; import lombok.extern.slf4j.Slf4j; import org.springframework.stereotype.Component;  import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.CopyOnWriteArraySet;  @Component @Slf4j @ServerEndpoint("/websocket/{userId}")  // 接口路径 ws://localhost:8087/webSocket/userId; public class WebSocket {      //与某个客户端的连接会话，需要通过它来给客户端发送数据     private Session session;     /**      * 用户ID      */     private String userId;      //concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。     //虽然@Component默认是单例模式的，但springboot还是会为每个websocket连接初始化一个bean，所以可以用一个静态set保存起来。     //  注：底下WebSocket是当前类名     private static CopyOnWriteArraySet<WebSocket> webSockets = new CopyOnWriteArraySet<>();     // 用来存在线连接用户信息     private static ConcurrentHashMap<String, Session> sessionPool = new ConcurrentHashMap<String, Session>();      /**      * 链接成功调用的方法      */     @OnOpen     public void onOpen(Session session, @PathParam(value = "userId") String userId) {         try {             this.session = session;             this.userId = userId;             webSockets.add(this);             sessionPool.put(userId, session);             log.info("【websocket消息】有新的连接，总数为:" + webSockets.size());         } catch (Exception e) {         }     }      /**      * 链接关闭调用的方法      */     @OnClose     public void onClose() {         try {             webSockets.remove(this);             sessionPool.remove(this.userId);             log.info("【websocket消息】连接断开，总数为:" + webSockets.size());         } catch (Exception e) {         }     }      /**      * 收到客户端消息后调用的方法      *      * @param message      */     @OnMessage     public void onMessage(String message) {         log.info("【websocket消息】收到客户端消息:" + message);     }      /**      * 发送错误时的处理      *      * @param session      * @param error      */     @OnError     public void onError(Session session, Throwable error) {         log.error("用户错误,原因:" + error.getMessage());         error.printStackTrace();     }      // 此为广播消息     public void sendAllMessage(String message) {         log.info("【websocket消息】广播消息:" + message);         for (WebSocket webSocket : webSockets) {             try {                 if (webSocket.session.isOpen()) {                     webSocket.session.getAsyncRemote().sendText(message);                 }             } catch (Exception e) {                 e.printStackTrace();             }         }     }      // 此为单点消息     public void sendOneMessage(String userId, String message) {         Session session = sessionPool.get(userId);         if (session != null && session.isOpen()) {             try {                 log.info("【websocket消息】 单点消息:" + message);                 session.getAsyncRemote().sendText(message);             } catch (Exception e) {                 e.printStackTrace();             }         }     }      // 此为单点消息(多人)     public void sendMoreMessage(String[] userIds, String message) {         for (String userId : userIds) {             Session session = sessionPool.get(userId);             if (session != null && session.isOpen()) {                 try {                     log.info("【websocket消息】 单点消息:" + message);                     session.getAsyncRemote().sendText(message);                 } catch (Exception e) {                     e.printStackTrace();                 }             }         }      }  }

注意：WebSocketConfig和WebSocket必须放在同一层级下，否则Websocket扫描不到ServerEndpoint注解。