通过实例讲解springboot整合WebSocket
作者：fleyX 发布时间：2023-03-07 07:02:03
标签：springboot,整合,WebSocket
一、背景
我们都知道 http 协议只能浏览器单方面向服务器发起请求获得响应，服务器不能主动向浏览器推送消息。想要实现浏览器的主动推送有两种主流实现方式：
轮询：缺点很多，但是实现简单
websocket：在浏览器和服务器之间建立 tcp 连接，实现全双工通信
springboot 使用 websocket 有两种方式，一种是实现简单的 websocket，另外一种是实现STOMP协议。这一篇实现简单的 websocket，STOMP 下一篇在讲。
注意：如下都是针对使用 springboot 内置容器
二、实现
1、依赖引入
要使用 websocket 关键是@ServerEndpoint这个注解，该注解是 javaee 标准中的注解,tomcat7 及以上已经实现了,如果使用传统方法将 war 包部署到 tomcat 中，只需要引入如下 javaee 标准依赖即可：
<dependency>
<groupId>javax</groupId>
<artifactId>javaee-api</artifactId>
<version>7.0</version>
<scope>provided</scope>
</dependency>
如使用 springboot 内置容器,无需引入，springboot 已经做了包含。我们只需引入如下依赖即可：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
<version>1.5.3.RELEASE</version>
<type>pom</type>
</dependency>
2、注入 Bean
首先注入一个ServerEndpointExporterBean,该 Bean 会自动注册使用@ServerEndpoint 注解申明的 websocket endpoint。代码如下：
@Configuration
public class WebSocketConfig {
@Bean
public ServerEndpointExporter serverEndpointExporter(){
return new ServerEndpointExporter();
}
}
3、申明 endpoint
建立MyWebSocket.java类，在该类中处理 websocket 逻辑
@ServerEndpoint(value = "/websocket") //接受websocket请求路径
@Component //注册到spring容器中
public class MyWebSocket {
//保存所有在线socket连接
private static Map<String,MyWebSocket> webSocketMap = new LinkedHashMap<>();
//记录当前在线数目
private static int count=0;
//当前连接（每个websocket连入都会创建一个MyWebSocket实例
private Session session;
private Logger log = LoggerFactory.getLogger(this.getClass());
//处理连接建立
@OnOpen
public void onOpen(Session session){
this.session=session;
webSocketMap.put(session.getId(),this);
addCount();
log.info("新的连接加入：{}",session.getId());
}
//接受消息
@OnMessage
public void onMessage(String message,Session session){
log.info("收到客户端{}消息：{}",session.getId(),message);
try{
this.sendMessage("收到消息："+message);
}catch (Exception e){
e.printStackTrace();
}
}
//处理错误
@OnError
public void onError(Throwable error,Session session){
log.info("发生错误{},{}",session.getId(),error.getMessage());
}
//处理连接关闭
@OnClose
public void onClose(){
webSocketMap.remove(this.session.getId());
reduceCount();
log.info("连接关闭:{}",this.session.getId());
}
//群发消息
//发送消息
public void sendMessage(String message) throws IOException {
this.session.getBasicRemote().sendText(message);
}
//广播消息
public static void broadcast(){
MyWebSocket.webSocketMap.forEach((k,v)->{
try{
v.sendMessage("这是一条测试广播");
}catch (Exception e){
}
});
}
//获取在线连接数目
public static int getCount(){
return count;
}
//操作count，使用synchronized确保线程安全
public static synchronized void addCount(){
MyWebSocket.count++;
}
public static synchronized void reduceCount(){
MyWebSocket.count--;
}
}
4、客户的实现
客户端使用 h5 原生 websocket，部分浏览器可能不支持。代码如下：
<html>
<head>
<title>websocket测试</title>
<meta charset="utf-8" />
</head>
<body>
<button onclick="sendMessage()">测试</button>
<script>
let socket = new WebSocket("ws://localhost:8080/websocket");
socket.onerror = err => {
console.log(err);
};
socket.onopen = event => {
console.log(event);
};
socket.onmessage = mess => {
console.log(mess);
};
socket.onclose = () => {
console.log("连接关闭");
};
function sendMessage() {
if (socket.readyState === 1) socket.send("这是一个测试数据");
else alert("尚未建立websocket连接");
}
</script>
</body>
</html>
三、测试
建立一个 controller 测试群发，代码如下：
@RestController
public class HomeController {
@GetMapping("/broadcast")
public void broadcast(){
MyWebSocket.broadcast();
}
}
然后打开上面的 html，可以看到浏览器和服务器都输出连接成功的信息：
浏览器：
Event {isTrusted: true, type: "open", target: WebSocket, currentTarget: WebSocket, eventPhase: 2, …}
服务端：
2018-08-01 14:05:34.727 INFO 12708 --- [nio-8080-exec-1] com.fxb.h5websocket.MyWebSocket : 新的连接加入：0
点击测试按钮，可在服务端看到如下输出：
2018-08-01 15:00:34.644 INFO 12708 --- [nio-8080-exec-6] com.fxb.h5websocket.MyWebSocket : 收到客户端2消息：这是一个测试数据
再次打开 html 页面，这样就有两个 websocket 客户端，然后在浏览器访问localhost:8080/broadcast测试群发功能,每个客户端都会输出如下信息：
MessageEvent {isTrusted: true, data: "这是一条测试广播", origin: "ws://localhost:8080", lastEventId: "", source: null, …}
源码可在 github 上下载
来源：https://www.tapme.top/categories/java/
0
投稿猜你喜欢
- Java 反射机制实例详解一、JAVA是动态语言吗？一般而言，说到动态言，都是指在程序运行时允许改变程序结构或者变量类型，从这个观点看，Ja
前言最近因为项目组需求，特研究了一下“回到顶部”效果，即：页面里有scrollview，内容很多，当滑动到页面下面或者更深时，需要回到顶部，- 一、length()返回此字符串的长度public static void main4(String[] args) { &n
- MVP(Model-View-Presenter) 是总所周知MVC模式的一个演变，他们的主要目的都是划分模块职责,降低模块耦合，易测试,提
- ＝＝＝＝＝最大线程数＝＝＝＝linux 系统中单个进程的最大线程数有其最大的限制 PTHREAD_THREADS_MAX这个限制可以在 /u
- 缓存在很多情况下需要用到，合理利用缓存可以一方面可以提高程序的响应速度，同时可以减少对特定资源访问的压力。本文主要针对自己在Winform方
- java中 String和StringBuffer的区别实例详解String: &
- SmartArt其实就是一个文字的可视化工具，用户可在PowerPoint，Word，Excel中使用该特性创建各种图形图表。SmartAr
- 在上周发布的 TienChin 项目视频中，我和大家一共梳理了六种幂等性解决方案，接口幂等性处理算是一个非常常见的需求了，我们在很多项目中其
- 在Android 5.0以后的版本中，定义一个button时，系统自动会加一个阴影的效果，有的时候这种效果看起来比较好，有的时候不符合UI的
- 最近项目中经常需要用到自定义控件，因此自定义属性也是经常要用到的，在此说明一下自定义属性的用法：自定义属性都存在于/value/attr.x
- Android RecyclerView小白今天第一次接触RecyclerView，前辈大神告诉我这是一个很神奇的控件，一看就是
- 用一个7 x 7的矩形表示迷宫，0和1分别表示的是通路和障碍。通过设计编写程序找到蓝色小球达到蓝色旗子的路线思路：构建一个迷宫（用二维数组）
- using System;using System.Collections.Generic;using System.Linq; using
- AndroidStduio3.0使用gradle将module打包jar文件,首先需要安装gradle。打开控制台输入
- 三种方式 下面为大家一一对应过滤器的方式 * 的方式过滤器的方式这种方式简单点 但是可配置性不高注意：一定得扫描到spring容器中创建一个
- 本文实现初次设置密码验证过程，首先实现如下效果布局如下：<?xml version="1.0" encoding=
- 本文实例讲述了C#导出数据到Excel文件的方法。分享给大家供大家参考。具体实现方法如下：/// <summary>/// 导出
- 总结:对应某个类的实例化的对象tc, 遍历获取所有属性(子成员)的方法(采用反射):Type t = tc.GetType();//获得该类
- 一、题目描述题目：模拟一个简单的银行系统，使用两个不同的线程向同一个账户存钱。实现：使用特殊域变量volatile实现同步。二、解题思路创建
