SpringBoot整合websocket

秋梦蓝枫

1.websocket介绍

WebSocket协议是基于TCP的一种新的网络协议。它实现了浏览器与服务器全双工(full-duplex)通信——允许服务器主动发送信息给客户端。websocket 协议是在 http 协议上的一种补充协议，是 html5 的新特性，是一种持久化的协议。

2.应用场景

• 系统实时通告
  
• 聊天室
  
• ....
  

3.spring boot 整合(亲测有效)

（1）导入pom

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

复制代码

（2）websocket配置类:

1. package com.ruoyi.framework.config.websocked;
3. import org.springframework.context.annotation.Bean;
4. import org.springframework.context.annotation.Configuration;
5. import org.springframework.web.socket.server.standard.ServerEndpointExporter;
8. @Configuration
9. public class WebSocketConfig {
10.     @Bean
11.     public ServerEndpointExporter serverEndpointExporter() {
13.         return new ServerEndpointExporter();
14.     }
15. }

复制代码

作用：可以将带有 @ServerEndpoint 注解的 WebSocket 端点注册到应用程序中，以便能够处理 WebSocket 连接。

（3）websocket操作类:

1. package com.ruoyi.project.websorcked;
3. import org.slf4j.Logger;
4. import org.slf4j.LoggerFactory;
5. import org.springframework.stereotype.Component;
7. import javax.websocket.*;
8. import javax.websocket.server.PathParam;
9. import javax.websocket.server.ServerEndpoint;
10. import java.util.concurrent.ConcurrentHashMap;
11. import java.util.concurrent.CopyOnWriteArraySet;
14. @Component
15. @ServerEndpoint("/websocket/{userId}")
16. public class WebSocketServer {
17.     /**
18.      * 日志工具
19.      */
20.     private Logger logger = LoggerFactory.getLogger(this.getClass());
21.     /**
22.      * 与某个客户端的连接会话，需要通过它来给客户端发送数据
23.      */
24.     private Session session;
25.     /**
26.      * 用户id
27.      */
28.     private String userId;
29.     /**
30.      * 用来存放每个客户端对应的MyWebSocket对象
31.      */
32.     private static CopyOnWriteArraySet<WebSocketServer> webSockets = new CopyOnWriteArraySet<>();
33.     /**
34.      * 用来存在线连接用户信息
35.      */
36.     private static ConcurrentHashMap<String, Session> sessionPool = new ConcurrentHashMap<String, Session>();
38.     /**
39.      * 链接成功调用的方法
40.      */
41.     @OnOpen
42.     public void onOpen(Session session, @PathParam(value = "userId") String userId) {
43.         try {
44.             this.session = session;
45.             this.userId = userId;
46.             webSockets.add(this);
47.             sessionPool.put(userId, session);
48.             logger.info("【websocket消息】有新的连接，总数为:" + webSockets.size());
49.         } catch (Exception e) {
50.         }
51.     }
53.     /**
54.      * 链接关闭调用的方法
55.      */
56.     @OnClose
57.     public void onClose() {
58.         try {
59.             webSockets.remove(this);
60.             sessionPool.remove(this.userId);
61.             logger.info("【websocket消息】连接断开，总数为:" + webSockets.size());
62.         } catch (Exception e) {
63.         }
64.     }
66.     /**
67.      * 收到客户端消息后调用的方法
68.      */
69.     @OnMessage
70.     public void onMessage(String message) {
71.         logger.info("【websocket消息】收到客户端消息:" + message);
72.     }
74.     /**
75.      * 发送错误时的处理
76.      *
77.      * @param session
78.      * @param error
79.      */
80.     @OnError
81.     public void onError(Session session, Throwable error) {
82.         logger.error("用户错误,原因:" + error.getMessage());
83.         error.printStackTrace();
84.     }
86.     /**
87.      * 此为广播消息
88.      */
89.     public static void sendAllMessage(String message) {
90. //        logger.info("【websocket消息】广播消息:" + message);
91.         System.out.println("【websocket消息】广播消息:" + message);
92.         for (WebSocketServer webSocket : webSockets) {
93.             try {
94.                 if (webSocket.session.isOpen()) {
95.                     webSocket.session.getAsyncRemote().sendText(message);
96.                 }
97.             } catch (Exception e) {
98.                 e.printStackTrace();
99.             }
100.         }
101.     }
103.     /**
104.      * 此为单点消息
105.      */
106.     public void sendOneMessage(String userId, String message) {
107.         Session session = sessionPool.get(userId);
108.         if (session != null && session.isOpen()) {
109.             try {
110.                 logger.info("【websocket消息】 单点消息:" + message);
111.                 session.getAsyncRemote().sendText(message);
112.             } catch (Exception e) {
113.                 e.printStackTrace();
114.             }
115.         }
116.     }
118.     /**
119.      * 此为单点消息(多人)
120.      */
121.     public void sendMoreMessage(String[] userIds, String message) {
122.         for (String userId : userIds) {
123.             Session session = sessionPool.get(userId);
124.             if (session != null && session.isOpen()) {
125.                 try {
126.                     logger.info("【websocket消息】 单点消息:" + message);
127.                     session.getAsyncRemote().sendText(message);
128.                 } catch (Exception e) {
129.                     e.printStackTrace();
130.                 }
131.             }
132.         }
134.     }
135. }

复制代码

说明

• (1)@ServerEndpoint(“/websocket/{userId}”) 前端通过此 URI 和后端交互，建立连接
  
• (2)@Component 不用说将此类交给 spring 管理
  
• (3)@OnOpen websocket 建立连接的注解，前端触发上面 URI 时会进入此注解标注的方法
  
• (4)@OnMessage 收到前端传来的消息后执行的方法
  
• (5)@OnClose 顾名思义关闭连接，销毁 session
  （4）前端样例:
  

1. var userId = "your_user_id"; // 替换为实际的用户 ID
2. var socket = new WebSocket("ws://your_server_address/websocket/" + userId);
4. socket.onopen = function(event) {
5.     // WebSocket 连接已打开
6. };
8. socket.onmessage = function(event) {
9.     // 收到来自服务器的消息
10.     var message = event.data;
11.     console.log("Received message: " + message);
12. };
14. socket.onclose = function(event) {
15.     // WebSocket 连接已关闭
16. };

复制代码

（5）前端demo:

1. <!DOCTYPE html>
2. <html lang="en">
3. <head>
4.     <meta charset="UTF-8">
5.   <title>websocket通讯</title>
6. </head>
7. <body>
8. <p>【socket开启者的ID信息】：<input id="userId" name="userId" type="text" value="10">
9. <p>【客户端向服务器发送的内容】：<input id="toUserId" name="toUserId" type="text" value="20">
10.   <input id="contentText" name="contentText" type="text" value="hello websocket">
11. <p>【操作】：<button><a onclick="openSocket()">开启socket</a></button>
12. <p>【操作】：<button><a onclick="sendMessage()">发送消息</a></button>
13. <p>【操作】：<button><a onclick="getMessage()">获取后台广播消息</a></button>
14. </body>
17. </html>

复制代码

（6）效果图:

（7）通过后端接口发送消息到客户端，客户端成功接收:

代码如下

1. package com.ruoyi.project.websorcked;
3. import com.ruoyi.framework.web.domain.AjaxResult;
4. import io.swagger.annotations.Api;
5. import io.swagger.annotations.ApiImplicitParam;
6. import io.swagger.annotations.ApiImplicitParams;
7. import io.swagger.annotations.ApiOperation;
8. import org.springframework.beans.factory.annotation.Autowired;
9. import org.springframework.web.bind.annotation.RequestMapping;
10. import org.springframework.web.bind.annotation.RequestMethod;
11. import org.springframework.web.bind.annotation.RequestParam;
12. import org.springframework.web.bind.annotation.RestController;
15. @RestController
16. @RequestMapping(value = "/api/v1/websocket")
17. @Api(tags = "websocket接口", value = "AlarmDpController")
18. public class WebSocketController {
19.     @Autowired
20.     private WebSocketServer webSocketServer;
22.     /**
23.      * 模拟数据发送
24.      */
25.     @ApiOperation(value = "模拟数据发送", notes = "模拟数据发送")
26.     @ApiImplicitParams({
27.             @ApiImplicitParam(paramType = "query", name = "message", value = "模拟消息", required = true, dataType = "String"),
28.     })
29.     @RequestMapping(value = "/sendTestMessage", method = RequestMethod.GET)
30.     public AjaxResult sendTestMessage(@RequestParam("message")String message) {
31.         AjaxResult ajaxJson = new AjaxResult();
32.         try {
33.             webSocketServer.sendAllMessage(message);
34.         } catch (Exception e) {
35.             e.printStackTrace();
36. //            return AjaxJson.returnExceptionInfo(LoitStatusMsg.LOIT_USER_LOGIN_FAIL);
37.         }
38.         return ajaxJson;
39.     }
40. }

复制代码

4.遇到的问题

（1) websocket发送连接请求到服务端，报错Filed

解决如下，因为我使用的是若依的项目，使用的安全框架为shiro，在shiro的config类中添加白名单放行

来源:https://www.cnblogs.com/sy2022/p/17611638.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！