SpringBoot整合WebSocket实现后端向前端主动推送消息方式

目录

一、引入websocket依赖二、WebSocket配置三、WebSocket服务四、消息推送

一、引入websocket依赖

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

复制代码

二、WebSocket配置

1. @Configuration
2. public class WebSocketConfig {
3.   @Bean
4.   public ServerEndpointExporter serverEndpointExporter() {
5.     return new ServerEndpointExporter();
6.   }
7. }

复制代码

三、WebSocket服务

（前端连接地址ws://ip:端口/websocket，请自行替换ip、端口和接口名称）

1. @ServerEndpoint(value = "/websocket")
2. @Component
3. public class WebSocketServer {
4.   private final static Logger log = LoggerFactory.getLogger(WeSocketServer.class);
6.   //静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
7.   private static int onlineCount = 0;
8.   //concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。
9.   private static CopyOnWriteArraySet<WebSocketServer> webSocketSet = new CopyOnWriteArraySet<WebSocketServer>();
11.   //与某个客户端的连接会话，需要通过它来给客户端发送数据
12.   private Session session;
14.   /**
15.   * 连接建立成功调用的方法
16.   */
17.   @OnOpen
18.   public void onOpen(Session session) {
19.     this.session = session;
20.     //加入set中
21.     webSocketSet.add(this);
22.     //在线数加1
23.     addOnlineCount();
24.     log.info("有新连接加入！当前在线人数为" + getOnlineCount());
25.     try {
26.       sendMessage("连接成功");
27.     } catch (IOException e) {
28.       log.error("websocket IO异常");
29.     }
30.   }
32.   /**
33.   * 连接关闭调用的方法
34.   */
35.   @OnClose
36.   public void onClose() {
37.     //从set中删除
38.     webSocketSet.remove(this);
39.     //在线数减1
40.     subOnlineCount();
41.     log.info("有一连接关闭！当前在线人数为" + getOnlineCount());
42.   }
44.   /**
45.   * 收到客户端消息后调用的方法
46.   *
47.   * @param message 客户端发送过来的消息
48.   */
49.   @OnMessage
50.   public void onMessage(String message, Session session) {
51.     log.info("来自客户端的消息:" + message);
53.     //群发消息
54.     for (WebSocketServer item : webSocketSet) {
55.       try {
56.         item.sendMessage(message);
57.       } catch (IOException e) {
58.         e.printStackTrace();
59.       }
60.     }
61.   }
63.   /**
64.   * @param session
65.   * @param error
66.   */
67.   @OnError
68.   public void onError(Session session, Throwable error) {
69.     log.error("发生错误");
70.     error.printStackTrace();
71.   }
73.   public void sendMessage(String message) throws IOException {
74.     this.session.getBasicRemote().sendText(message);
75.   }
77.   /**
78.   * 群发自定义消息
79.   */
80.   public static void sendInfo(String message) throws IOException {
81.     log.info(message);
82.     for (WebSocketServer item : webSocketSet) {
83.       try {
84.         item.sendMessage(message);
85.       } catch (IOException e) {
86.         continue;
87.       }
88.     }
89.   }
91.   public static synchronized int getOnlineCount() {
92.     return onlineCount;
93.   }
95.   public static synchronized void addOnlineCount() {
96.     WebSocketServer.onlineCount++;
97.   }
99.   public static synchronized void subOnlineCount() {
100.     WebSocketServer.onlineCount--;
101.   }
102. }

复制代码

四、消息推送

后端调用WebServer的sendInfo接口（例如：WebSocketServer.sendInfo("Hello World");）实现主动向前端推送消息
以上为个人经验，希望能给大家一个参考，也希望大家多多支持中国红客联盟。