关键词：
0. 开发环境
- JDK：1.8
- Spring Boot：2.1.1.RELEASE
1. 引入依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
2. 新建WebSocket配置类
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
*
* @return
*/
@Bean
public ServerEndpointExporter serverEndpointExporter()
return new ServerEndpointExporter();
3. 新建WebSocket服务类
package cn.wbnull.springbootdemo.service;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
@Component
@ServerEndpoint("/websocket/terminalId")
public class WebSocketService
private final Logger logger = LoggerFactory.getLogger(WebSocketService.class);
/**
* 保存连接信息
*/
private static final Map<String, Session> CLIENTS = new ConcurrentHashMap<>();
@OnOpen
public void onOpen(@PathParam("terminalId") String terminalId, Session session) throws Exception
logger.info(session.getRequestURI().getPath() + "，打开连接开始：" + session.getId());
//当前连接已存在，关闭
if (CLIENTS.containsKey(terminalId))
onClose(CLIENTS.get(terminalId));
CLIENTS.put(terminalId, session);
logger.info(session.getRequestURI().getPath() + "，打开连接完成：" + session.getId());
@OnClose
public void onClose(@PathParam("terminalId") String terminalId, Session session) throws Exception
logger.info(session.getRequestURI().getPath() + "，关闭连接开始：" + session.getId());
CLIENTS.remove(terminalId);
logger.info(session.getRequestURI().getPath() + "，关闭连接完成：" + session.getId());
@OnMessage
public void onMessage(String message, Session session)
logger.info("前台发送消息：" + message);
@OnError
public void onError(Session session, Throwable error)
logger.error(error.toString());
public void onClose(Session session)
//判断当前连接是否在线
// if (!session.isOpen())
// return;
//
try
session.close();
catch (IOException e)
logger.error("金斗云关闭连接异常：" + e);
public void sendMessage(String message, Session session)
try
session.getAsyncRemote().sendText(message);
logger.info("推送成功：" + message);
catch (Exception e)
logger.error("推送异常：" + e);
public boolean sendMessage(String terminalId, String message)
try
Session session = CLIENTS.get(terminalId);
session.getAsyncRemote().sendText(message);
logger.info("推送成功：" + message);
return true;
catch (Exception e)
logger.error("推送异常：" + e);
return false;
4. 新建Web端连接页面
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>WebSocket Test</title>
</head>
<body>
<label for="text"></label><input id="text" type="text"/>
<button onclick="sendMessage()">发送消息</button>
<button onclick="closeWebSocket()">关闭连接</button>
<div id="message"></div>
</body>
<script type="text/javascript">
let websocket = null;
//判断当前浏览器是否支持WebSocket
if ('WebSocket' in window)
websocket = new WebSocket("ws://localhost:8090/websocket/123456");
else
alert('Not support websocket');
//连接发生错误的回调方法
websocket.onerror = function ()
showMessage("打开连接失败");
;
//连接成功建立的回调方法
websocket.onopen = function (event)
showMessage("打开连接成功");
//接收到消息的回调方法
websocket.onmessage = function (event)
showMessage(event.data);
//连接关闭的回调方法
websocket.onclose = function ()
showMessage("关闭连接成功");
//监听窗口关闭事件，当窗口关闭时，主动关闭WebSocket连接
window.onbeforeunload = function ()
websocket.close();
function showMessage(message)
document.getElementById('message').innerHTML += message + '<br/>';
function closeWebSocket()
websocket.close();
//发送消息
function sendMessage()
const message = document.getElementById('text').value;
websocket.send(message);
</script>
</html>
5. 设置后端消息推送
为便于测试，直接修改WebSocketService，当收到前台消息时，直接给前台发送消息
@OnMessage
public void onMessage(String message, Session session)
logger.info("前台发送消息：" + message);
sendMessage("收到消息：" + message, session);
6. 测试
浏览器访问http://127.0.0.1:8090/，页面显示如下：
后台日志如下：
2022-07-02 21:03:22.753 INFO 9168 --- [nio-8090-exec-2] c.w.s.service.WebSocketService : /websocket/123456，打开连接开始：0
2022-07-02 21:03:22.753 INFO 9168 --- [nio-8090-exec-2] c.w.s.service.WebSocketService : /websocket/123456，打开连接完成：0
当我们浏览器打开第二个页面，第一个页面会显示断开连接
后台日志如下：
2022-07-02 21:04:01.936 INFO 9168 --- [nio-8090-exec-4] c.w.s.service.WebSocketService : /websocket/123456，打开连接开始：1
2022-07-02 21:04:01.938 INFO 9168 --- [nio-8090-exec-4] c.w.s.service.WebSocketService : /websocket/123456，关闭连接开始：0
2022-07-02 21:04:01.938 INFO 9168 --- [nio-8090-exec-4] c.w.s.service.WebSocketService : /websocket/123456，关闭连接完成：0
2022-07-02 21:04:01.938 INFO 9168 --- [nio-8090-exec-4] c.w.s.service.WebSocketService : /websocket/123456，打开连接完成：1
前台页面录入消息并发送，后台可正常收到消息
2022-07-02 21:08:21.860 INFO 1772 --- [nio-8090-exec-3] c.w.s.service.WebSocketService : 前台发送消息：测试消息
2022-07-02 21:08:21.863 INFO 1772 --- [nio-8090-exec-3] c.w.s.service.WebSocketService : 推送成功：收到消息：测试消息
前台页面显示正常
点击关闭连接，可以正常关闭
7. 服务保活
对于实时消息推送相关服务，都存在保活问题。这里我们采用心跳保活。 修改WebSocketService类
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.atomic.AtomicInteger;
@Component
@ServerEndpoint("/websocket/terminalId")
public class WebSocketService
private final Logger logger = LoggerFactory.getLogger(WebSocketService.class);
/**
* 保存连接信息
*/
private static final Map<String, Session> CLIENTS = new ConcurrentHashMap<>();
private static final Map<String, AtomicInteger> TERMINAL_IDS = new HashMap<>();
@OnOpen
public void onOpen(@PathParam("terminalId") String terminalId, Session session) throws Exception
logger.info(session.getRequestURI().getPath() + "，打开连接开始：" + session.getId());
//当前连接已存在，关闭
if (CLIENTS.containsKey(terminalId))
onClose(CLIENTS.get(terminalId));
TERMINAL_IDS.put(terminalId, new AtomicInteger(0));
CLIENTS.put(terminalId, session);
logger.info(session.getRequestURI().getPath() + "，打开连接完成：" + session.getId());
@OnClose
public void onClose(@PathParam("terminalId") String terminalId, Session session) throws Exception
logger.info(session.getRequestURI().getPath() + "，关闭连接开始：" + session.getId());
CLIENTS.remove(terminalId);
TERMINAL_IDS.remove(terminalId);
logger.info(session.getRequestURI().getPath() + "，关闭连接完成：" + session.getId());
@OnMessage
public void onMessage(String message, Session session)
logger.info("前台发送消息：" + message);
if ("心跳".equals(message))
//重置当前终端心跳次数
TERMINAL_IDS.get(message).set(0);
return;
sendMessage("收到消息：" + message, session);
@OnError
public void onError(Session session, Throwable error)
logger.error(error.toString());
public void onClose(Session session)
//判断当前连接是否在线
// if (!session.isOpen())
// return;
//
try
session.close();
catch (IOException e)
logger.error("金斗云关闭连接异常：" + e);
public void heartbeat()
//检查所有终端心跳次数
for (String key : TERMINAL_IDS.keySet())
//心跳3次及以上的主动断开
if ((TERMINAL_IDS.get(key).intValue() >= 3))
logger.info("心跳超时，关闭连接：" + key);
onClose(CLIENTS.get(key));
for (String key : CLIENTS.keySet())
//记录当前终端心跳次数
TERMINAL_IDS.get(key).incrementAndGet();
sendMessage("心跳", CLIENTS.get(key));
public void sendMessage(String message, Session session)
try
session.getAsyncRemote().sendText(message);
logger.info("推送成功：" + message);
catch (Exception e)
logger.error("推送异常：" + e);
public boolean sendMessage(String terminalId, String message)
try
Session session = CLIENTS.get(terminalId);
session.getAsyncRemote().sendText(message);
logger.info("推送成功：" + message);
return true;
catch (Exception e)
logger.error("推送异常：" + e);
return false;
8. 新增定时任务
新增定时任务，定时给连接到WebSocket的终端发送消息，超过指定次数未回应的终端视为离线，主动关闭连接。
import cn.wbnull.springbootdemo.service查看详情
springboot整合websocket实现客户端与服务端通信(代码片段)
定义?WebSocket是通过单个TCP连接提供全双工（双向通信）通信信道的计算机通信协议。此WebSocketAPI可在用户的浏览器和服务器之间进行双向通信。用户可以向服务器发送消息并接收事件驱动的响应，而无需轮询服务器。它可以让... 查看详情
springboot整合websocket
...t：在浏览器和服务器之间建立tcp连接，实现全双工通信??springboot使用websocket有两种方式，一种是实现简单的websocket，另外一种是实现STOMP协议。这一篇实现简单的webso 查看详情
springboot2系列教程(十六)|整合websocket实现广播
前言如题，今天介绍的是SpringBoot整合WebSocket实现广播消息。什么是WebSocket？WebSocket为浏览器和服务器提供了双工异步通信的功能，即浏览器可以向服务器发送信息，反之也成立。WebSocket是通过一个socket来实现双工异步通信能力... 查看详情
springboot整合websocket实现登录挤退现象
在项目期间遇到了同一个账号不能在不同的地方同时登录的情况，解决方法用到了websocket。关于websocket的原理网上有很多，我这里就不写了，推荐博客：https://www.cnblogs.com/myzhibie/p/4470065.html这里我主要记录一下websocket来实现的登... 查看详情
springboot2系列教程(十七)|整合websocket实现聊天室
...基础之上，为便于更好理解今天这一篇，推荐先阅读：「SpringBoot整合WebSocket实现广播消息」 查看详情
springboot整合websocket实现即时聊天功能
...期，公司需要新增即时聊天的业务，于是用websocket整合到Springboot完成业务的实现。一、我们来简单的介绍下websocket的交互原理：1.客户端先服务端发起websocket请求；2.服务端接收到请求之后，把请求响应返回给客户端；3.客户端... 查看详情
springboot整合websocket实现简单聊天室(代码片段)
项目结构：效果展示：实现步骤步骤一：添加依赖<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-thymeleaf</artifactId></dependency> 查看详情
springboot+websocket实时消息推送
...术A商家的后台管理系统实现新订单提醒推送功能，利用SpringBoot+WebSocket实时消息推送的方式进行实现。引入依赖，我使用的是SpringBoot版本2.2.6.RELEASE，自动管理依赖版本配置类WebSocketConfig，扫描并注册带有@ServerEndpoint注解的所有w... 查看详情
springboot1.5.9整合websocket
一.WebSocket介绍 1.WebSocket是什么? WebSocket是协议,是HTML5开始提供的基于TCP(传输层)的一种新的网络协议, 它实现了浏览器与服务器全双工(full-duplex)通信,即允许服务器主动发送消息给客户端 WebSocket使得客... 查看详情
补习系列(20)-大话websocket与"尬聊"的实现(代码片段)
目录一、聊聊WebSocket二、Stomp是个什么鬼三、SpringBoot整合WebSocketA.引入依赖B.WebSocket配置C.控制器D.前端实现四、参考文档一、聊聊WebSocket从HTML5技术流行至今，WebSocket已经有非常广泛的应用：在线游戏，提供实时的操作交互体验... 查看详情
springboot整合websocket简单聊天室(代码片段)
springboot整合websocket（一）简单聊天室springboot整合websocket（一）简单聊天室springboot整合websocket（二）上传文件（引导篇）springboot整合websocket（三）上传文件（终篇& 查看详情
springboot入门：集成websocket,实时显示系统日志
以前面的博客为基础，最近一篇为SpringBoot入门（十）：集成Redis哨兵模式，实现Mybatis二级缓存。本篇博客主要介绍了SpringBoot集成WebSocket进行日志的推送，并实时显示在页面上。1.导入jar包第一个jar包是websocket的，第二个jar包是... 查看详情
springboot+websocket实现实时获取系统数据(代码片段)
SpringBoot+WebSocket实现实时获取系统数据引入maven依赖<dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-websocket</artifactId></dependency><dependency><groupId>cn.hutool</groupId&... 查看详情
springboot-websocket实现及原理
本文章包括websocket面试相关问题以及springboot如何整合webSocket。参考文档https://blog.csdn.net/prayallforyou/article/details/53737901、https://www.cnblogs.com/bianzy/p/5822426.html webSocket是HTML5的一种新协议，它实现了服务端与客户端的全双工通信，... 查看详情
springboot+websocket实时监控异常(代码片段)
写在前面此异常非彼异常，标题所说的异常是业务上的异常。最近做了一个需求，消防的设备巡检，如果巡检发现异常，通过手机端提交，后台的实时监控页面实时获取到该设备的信息及位置，然后安排员... 查看详情
springboot整合websocket，使用stomp协议，前后端整合实战(代码片段)
... 一篇极简风，最最最基础的方式整合websocket：《SpringBoot整合WebSocket简单实战案例》地址： https://blog.csdn.net/qq_35387940/article/details/ 查看详情
重学springboot系列之服务器推送技术(代码片段)
重学Springboot系列之服务器推送技术主流服务器推送技术说明需求与背景服务端推送常用技术全双工通信:WebSocket服务端主动推送:SSE(ServerSendEvent)websocket与SSE比较服务端推送事件SSE模拟网络支付场景应用场景sse规范模拟实现服务端... 查看详情