• Springboot 集成 WebSocket

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

    1.添加依赖包

    1. <!--webSocket-->
    2. <dependency>
    3.     <groupId>org.springframework.boot</groupId>
    4.     <artifactId>spring-boot-starter-websocket</artifactId>
    5. </dependency>

    2.添加WebSocket配置

    1. import org.springframework.context.annotation.Bean;
    2. import org.springframework.context.annotation.Configuration;
    3. import org.springframework.web.socket.server.standard.ServerEndpointExporter;
    4.  
    5. @Configuration
    6. public class WebSocketConfig {
    7.  
    8.     @Bean
    9.     public ServerEndpointExporter serverEndpointExporter() {
    10.         return new ServerEndpointExporter();
    11.     }
    12.  
    13. }

    3.编写web服务端

    1. import lombok.extern.slf4j.Slf4j;
    2. import org.springframework.stereotype.Component;
    3.  
    4. import javax.websocket.*;
    5. import javax.websocket.server.PathParam;
    6. import javax.websocket.server.ServerEndpoint;
    7. import java.util.concurrent.ConcurrentHashMap;
    8. import java.util.concurrent.CopyOnWriteArraySet;
    9.  
    10. @Component
    11. @ServerEndpoint("/websocket/{clientId}")
    12. @Slf4j
    13. public class WebSocketServer {
    14.  
    15.     /**
    16.      * 客户端的连接会话，需要通过它来给客户端发送数据
    17.      */
    18.     private Session session;
    19.  
    20.     /**
    21.      * 客户端id
    22.      */
    23.     private String clientId;
    24.  
    25.     /**
    26.      * 用来存放每个客户端对应的MyWebSocket对象
    27.      */
    28.     private static CopyOnWriteArraySet webSockets = new CopyOnWriteArraySet<>();
    29.  
    30.     /**
    31.      * 用来存在线连接用户信息
    32.      */
    33.     private static ConcurrentHashMap sessionPool = new ConcurrentHashMap();
    34.  
    35.     /**
    36.      * 链接成功调用的方法
    37.      */
    38.     @OnOpen
    39.     public void onOpen(Session session, @PathParam(value = "clientId") String clientId) {
    40.         try {
    41.             this.session = session;
    42.             this.clientId = clientId;
    43.             webSockets.add(this);
    44.             sessionPool.put(clientId, session);
    45.             log.info("【websocket消息】有新的连接 clientId:{}，总数为:{}", clientId, webSockets.size());
    46.         } catch (Exception e) {
    47.             log.info("【websocket消息】有新的连接构建失败 clientId:{}，总数为:{}，error:", clientId, webSockets.size(), e);
    48.         }
    49.     }
    50.  
    51.     /**
    52.      * 链接关闭调用的方法
    53.      */
    54.     @OnClose
    55.     public void onClose() {
    56.         try {
    57.             webSockets.remove(this);
    58.             sessionPool.remove(this.clientId);
    59.             log.info("【websocket消息】连接断开 clientId:{}，总数为:{}", this.clientId, webSockets.size());
    60.         } catch (Exception e) {
    61.             log.info("【websocket消息】连接断开失败 clientId:{}，总数为:{}，error:", clientId, webSockets.size(), e);
    62.         }
    63.     }
    64.  
    65.     /**
    66.      * 收到客户端消息后调用的方法
    67.      */
    68.     @OnMessage
    69.     public void onMessage(String message) {
    70.         log.info("【websocket消息】收到客户端消息:{}", message);
    71.     }
    72.  
    73.     /**
    74.      * 发送错误时的处理
    75.      *
    76.      * @param session
    77.      * @param error
    78.      */
    79.     @OnError
    80.     public void onError(Session session, Throwable error) {
    81.         log.error("【websocket消息】发生错误，原因:", error);
    82.     }
    83.  
    84.     /**
    85.      * 此为广播消息
    86.      */
    87.     public void sendBroadcastMessage(String message) {
    88.         log.info("【websocket消息】广播消息:{}", message);
    89.         for (WebSocketServer webSocket : webSockets) {
    90.             try {
    91.                 if (webSocket.session.isOpen()) {
    92.                     webSocket.session.getAsyncRemote().sendText(message);
    93.                 }
    94.             } catch (Exception e) {
    95.                 log.error("【websocket消息】广播消息异常，消息:{}，error:", message, e);
    96.             }
    97.         }
    98.     }
    99.  
    100.     /**
    101.      * 此为单点消息
    102.      */
    103.     public void sendSinglePointMessage(String targetId, String message) {
    104.         Session session = sessionPool.get(targetId);
    105.         if (session != null && session.isOpen()) {
    106.             try {
    107.                 session.getAsyncRemote().sendText(message);
    108.                 log.info("【websocket消息】单点消息，targetId:{}，消息:{}", targetId, message);
    109.             } catch (Exception e) {
    110.                 log.error("【websocket消息】单点消息异常，targetId:{}，消息:{}，error:", targetId, message, e);
    111.             }
    112.         }
    113.     }
    114.  
    115. }

    4.html测试页面

    1. html>
    2. <html>
    3. <head>
    4.     <meta charset="utf-8">
    5.     <title>Websocket客户端title>
    6. head>
    7. <script src="https://cdn.bootcss.com/jquery/3.3.1/jquery.js">script>
    8. <script>
    9.     var socket;
    10.  
    11.     function openSocket() {
    12.         const socketUrl = "ws://localhost:8081/websocket/" + $("#clientId").val();
    13.         console.log(socketUrl);
    14.         if (socket != null) {
    15.             socket.close();
    16.             socket = null;
    17.         }
    18.         socket = new WebSocket(socketUrl);
    19.         // 开启WebSocket连接
    20.         socket.onopen = function () {
    21.             console.log("websocket已开启");
    22.         };
    23.         // 获得消息事件
    24.         socket.onmessage = function (msg) {
    25.             console.log(msg.data);
    26.         };
    27.         // 关闭事件
    28.         socket.onclose = function () {
    29.             console.log("websocket已关闭");
    30.         };
    31.         // 发生了错误事件
    32.         socket.onerror = function () {
    33.             console.log("websocket发生了错误");
    34.         }
    35.     }
    36.  
    37.     function sendMessage() {
    38.         socket.send('{"targetId":"' + $("#targetId").val() + '","contentText":"' + $("#contentText").val() + '"}');
    39.         console.log('{"targetId":"' + $("#targetId").val() + '","contentText":"' + $("#contentText").val() + '"}');
    40.     }
    41. script>
    42. <body>
    43.  
    44. <div>
    45.     客户端身份标识ID
    46.     <input id="clientId" type="text" value="10">
    47.     <button style="color: cornflowerblue"><a onclick="openSocket()">开启WebSocket连接a>button>
    48. div>
    49. <br><br>
    50. <div>
    51.     客户端向服务器发送的内容
    52.     <input id="targetId" type="text" value="20">
    53.     <input id="contentText" type="text" value="hello WebSocket">
    54.     <button style="color: cornflowerblue"><a onclick="sendMessage()">发送消息a>button>
    55. div>
    56.  
    57.  
    58. body>
    59. html>

    5.模拟服务端发送消息

    1. import lombok.extern.slf4j.Slf4j;
    2. import org.springframework.stereotype.Component;
    3.  
    4. import javax.websocket.*;
    5. import javax.websocket.server.PathParam;
    6. import javax.websocket.server.ServerEndpoint;
    7. import java.util.concurrent.ConcurrentHashMap;
    8. import java.util.concurrent.CopyOnWriteArraySet;
    9.  
    10. @Component
    11. @ServerEndpoint("/websocket/{clientId}")
    12. @Slf4j
    13. public class WebSocketServer {
    14.  
    15.     /**
    16.      * 客户端的连接会话，需要通过它来给客户端发送数据
    17.      */
    18.     private Session session;
    19.  
    20.     /**
    21.      * 客户端id
    22.      */
    23.     private String clientId;
    24.  
    25.     /**
    26.      * 用来存放每个客户端对应的MyWebSocket对象
    27.      */
    28.     private static CopyOnWriteArraySet webSockets = new CopyOnWriteArraySet<>();
    29.  
    30.     /**
    31.      * 用来存在线连接用户信息
    32.      */
    33.     private static ConcurrentHashMap sessionPool = new ConcurrentHashMap();
    34.  
    35.     /**
    36.      * 链接成功调用的方法
    37.      */
    38.     @OnOpen
    39.     public void onOpen(Session session, @PathParam(value = "clientId") String clientId) {
    40.         try {
    41.             this.session = session;
    42.             this.clientId = clientId;
    43.             webSockets.add(this);
    44.             sessionPool.put(clientId, session);
    45.             log.info("【websocket消息】有新的连接 clientId:{}，总数为:{}", clientId, webSockets.size());
    46.         } catch (Exception e) {
    47.             log.info("【websocket消息】有新的连接构建失败 clientId:{}，总数为:{}，error:", clientId, webSockets.size(), e);
    48.         }
    49.     }
    50.  
    51.     /**
    52.      * 链接关闭调用的方法
    53.      */
    54.     @OnClose
    55.     public void onClose() {
    56.         try {
    57.             webSockets.remove(this);
    58.             sessionPool.remove(this.clientId);
    59.             log.info("【websocket消息】连接断开 clientId:{}，总数为:{}", this.clientId, webSockets.size());
    60.         } catch (Exception e) {
    61.             log.info("【websocket消息】连接断开失败 clientId:{}，总数为:{}，error:", clientId, webSockets.size(), e);
    62.         }
    63.     }
    64.  
    65.     /**
    66.      * 收到客户端消息后调用的方法
    67.      */
    68.     @OnMessage
    69.     public void onMessage(String message) {
    70.         log.info("【websocket消息】收到客户端消息:{}", message);
    71.     }
    72.  
    73.     /**
    74.      * 发送错误时的处理
    75.      *
    76.      * @param session
    77.      * @param error
    78.      */
    79.     @OnError
    80.     public void onError(Session session, Throwable error) {
    81.         log.error("【websocket消息】发生错误，原因:", error);
    82.     }
    83.  
    84.     /**
    85.      * 此为广播消息
    86.      */
    87.     public void sendBroadcastMessage(String message) {
    88.         log.info("【websocket消息】广播消息:{}", message);
    89.         for (WebSocketServer webSocket : webSockets) {
    90.             try {
    91.                 if (webSocket.session.isOpen()) {
    92.                     webSocket.session.getAsyncRemote().sendText(message);
    93.                 }
    94.             } catch (Exception e) {
    95.                 log.error("【websocket消息】广播消息异常，消息:{}，error:", message, e);
    96.             }
    97.         }
    98.     }
    99.  
    100.     /**
    101.      * 此为单点消息
    102.      */
    103.     public void sendSinglePointMessage(String targetId, String message) {
    104.         Session session = sessionPool.get(targetId);
    105.         if (session != null && session.isOpen()) {
    106.             try {
    107.                 session.getAsyncRemote().sendText(message);
    108.                 log.info("【websocket消息】单点消息，targetId:{}，消息:{}", targetId, message);
    109.             } catch (Exception e) {
    110.                 log.error("【websocket消息】单点消息异常，targetId:{}，消息:{}，error:", targetId, message, e);
    111.             }
    112.         }
    113.     }
    114.  
    115. }

    发送广播消息：http://localhost:8081/api//websocket/sendBroadcastMessage?message=hello

    发送点对点消息：http://localhost:8081/api//websocket/sendSinglePointMessage?message=hello&targetId=10

  • 相关阅读:
    JAVA毕业设计河南口腔医疗机构线上服务系统计算机源码+lw文档+系统+调试部署+数据库
    机器人过程自动化(RPA)入门 4. 数据处理
    Android音视频开发：MediaCodec解码视频，得到YUV值，一帧一帧加载到SD卡中保存
    系统介绍浏览器缓存机制及前端优化方案
    （附源码）计算机毕业设计SSM教师教学质量评价系统
    VS2019 Qt源码编译
    力扣题解7.27
    【论文阅读】 Dimensionality reduction for large-scale neural recordings
    docker概念
    Vue里面怎么使用站点地图Sitemap做SEO
  • 原文地址：https://blog.csdn.net/qq_34253002/article/details/133807170