Springboot怎么实现WebSocket通信(一)
创始人
2024-05-30 00:38:39
0
文章示例环境配置信息
jdk版本:1.8
开发工具:Intellij iDEA 2020.1
springboot:2.3.9.RELEASE

什么是WebSocket?

WebSocket,是HTML5下一种新的协议,支持web浏览器和服务器端之间双向全双工通信 ,基于TCP协议实现。

WebSocket主要特性

1、WebSocket是一种全新的协议,不属于http无状态协议,协议名为“ws”;

2、WebSocket是基于TCP的,属于可靠性传输协议,按OSI网络模型划分,归属应用层协议;

3、WebSocket是双向通信协议,可以双向发送或接受信息,与http相比最明显的区别就是允许服务端向客户端浏览器主动推送数据,而HTTP是单向的,只能由客户端发起请求,服务端针对客户端请求作出响应;

4、使用WebSocket通信前,浏览器和服务器端需要先进行握手建立连接;

5、WebSocket在握手建立连接的时候,数据是通过HTTP传输的,但是在建立连接之后,真正传输数据的时候是不需要HTTP协议的;

6、WebSocket建立连接后,数据是以帧序列的形式传输,浏览器端与服务器端的发送和接受消息是在同一个持久连接上发起,即浏览器端与服务器端的WebSocket连接未断开时,不需要重新发起连接请求就可以多次发送和接受消息;在并发及交互负载流量大的情况下,极大节省了网络带宽资源,有明显的性能优势,实现了真正的“长连接”;

WebSocket基本使用演示

通过WebSocket功能特性来看,WebSocket是一个非常重要的有实际应用意义的通信协议,下面以单机模式下的Springboot项目中集成WebSocket,来学习一下WebSocket使用方法及主要功能特性。

后端

1、引入WebSocket所需要starter模块依赖包;

org.springframework.bootspring-boot-starter-websocket

2、定义WebSocketConfig配置类,引入WebSocket的Springboot的自动配置类ServerEndpointExporter,这个配置类主要用于扫描WebSocket相关的注解;

@Configuration
public class WebSocketConfig {@Beanpublic ServerEndpointExporter serverEndpointExporter(){return new ServerEndpointExporter();}
}

3、定义一个WebSocket类,使用@Component注解把WebSocket类注册到Spring容器中,使用@ServerEndpoint注解把当前类定义成一个服务器端并标记好客户端发起WebSocket连接请求的URL;在WebSocket类内用到了四个注解:@Open、@Close、@OnMessage、@OnError:

@Open:当WebSocket连接建立成功后会触发这个注解修饰的方法;

@Close:当WebSocket连接关闭或中断后会触发这个注解修饰的方法;

@OnMessage:当客户端发送消息到服务端时,会触发这个注解修饰的方法;

@OnError:当 websocket 建立连接时出现异常会触发这个注解修饰的方法;

@Component
@ServerEndpoint("/websocket/{userId}")
@Slf4j
public class WebSocket {private Session session;private static Map webSocketMap = new ConcurrentHashMap<>();/*** 客户端发起websocket连接请求成功建立连接时触发* @param session* @param userId*/@OnOpenpublic void onOpen(Session session, @PathParam("userId") String userId) {this.session = session;this.webSocketMap.put(userId, this);log.info("【websocket消息】有新的连接, 总数:{}", webSocketMap.size());}/*** 客户端关闭时websocket连接时触发*/@OnClosepublic void onClose(@PathParam("userId") String userId) throws IOException {session.close();this.webSocketMap.remove(userId);log.info("【websocket消息】连接断开, 总数:{}", webSocketMap.size());}/*** 客户端向服务端发送消息时触发* @param session* @param message* @throws IOException*/@OnMessagepublic void onMessage(Session session,  String message) throws IOException {Map> requestParameterMap = session.getRequestParameterMap();String userId = requestParameterMap.get("userId").get(0);log.info("【websocket消息】收到客户端发来的消息:{}", message);if (message.startsWith("hello")) {session.getBasicRemote().sendText("你好,"+userId+"!信息已经收到,欢迎光临" + message.replace("hello", ""));}}/*** 当 websocket 建立连接时出现异常会触发* @param session*/@OnErrorpublic void onError(Session session){Map> requestParameterMap = session.getRequestParameterMap();String userId = requestParameterMap.get("userId").get(0);log.info("连接异常,请求参数:"+userId);}
}

前端

在resources目录下的静态资源目录static下,新建一个index.html;

index.html的逻辑很简单,就是在页面上放三个按钮,分别用于建立websocket连接、关闭websocket连接、向服务端发送文本消息;具体的实现步骤是这样的:

1、引入jquery.js,这样就可以使用"$"符号了;

2、在body标签内分别放置三个按钮,标签id分别是open、close、send;

3、定义一个div标签,用来显示操作信息和从服务端发送过来的文本消息;

4、在标签内,声明websocket变量,然后在open按钮的点击事件触发进,向服务端发起连接请求,这里要特别注意一下,请求的URL是:“ws://172.18.229.61/websocket/gaox2”;与http请求类似的是,http请求的开头是http,websocket请求的开头是ws;

5、与服务端比较类似的是,客户端在websocket连接建立后,也会注册websocket连接事件在连接成功建立、连接发生错误、接收到服务端消息、连接关闭时的回调方法;

6、websocket连接建立成功后,在发送信息、关闭连接按钮被触发时,编写相应的处理逻辑;



websocket测试


测试结果

总结

至此,在Springboot项目中,如何使用WebSocket进行数据交互的基本方法就是这样了。其实还是挺简单的,主要就是两部分:1、前端如何发起请求和处理服务端发回的消息;2、后端处理如何处理前端发起的websocket请求以及如何主动发消息给浏览器端;

但是大家有没有发现一个问题:单机模式下,浏览器端向服务端发起websocket请求,服务端处理请求并主动发消息给浏览器端,这种点对点的通信确实不复杂,但是实际的业务场景中,大部分项目都是分布式部署的,一个工程布署了多个服务节点,前端并不直接请求具体服务节点,而是先到nginx或其他代理服务器,通过nginx的负载均衡机制再转发到具体的服务节点,浏览器端在发起websocket连接时,直接连接到具体的服务节点显然不太合适的,那么向nginx发起websocket连接,再由其转发到具体的节点是否可以呢?又是怎么配置的呢?另外服务端向客户端发送消息时,用到了session,当然这里的session和servlet的session不是一个session,servlet中的session是jvm级别的,本身是不支持跨节点共享的,那websocket的session是否支持跨节点共享?如果不支持,则用什么办法实现session的共享?

这篇文章和大家一块简单学习一下websocket的基本使用方法,下一篇文章再来和大家一块分享一下,如何把websocket应用到实际的业务开发中。

相关内容

热门资讯

如何关闭iphone系统安卓,... 你有没有想过,你的iPhone里竟然藏着安卓的影子?没错,有时候,我们这些手机控们,就是喜欢探索那些...
安卓怎样打开定位系统,安卓设备... 你有没有发现,现在的生活越来越离不开定位系统了呢?无论是导航出行,还是寻找附近的美食,定位系统都成了...
安卓手机苹果iso系统主题,探... 你有没有发现,手机的世界就像是个五彩斑斓的万花筒,每个人都能在其中找到属于自己的那一抹色彩?今天,咱...
鸿蒙系统是复制安卓吗 最近手机圈可是热闹非凡呢!鸿蒙系统这个新面孔横空出世,让人不禁好奇:这鸿蒙系统是不是就是安卓的“克隆...
macm1安卓系统,开启新篇章 亲爱的读者们,你是否曾想过,苹果的Mac电脑和安卓系统能有什么交集呢?今天,就让我带你一起探索这个奇...
安卓智能车载系统ygdh,引领... 你有没有发现,现在的汽车越来越聪明了?没错,这就是我要跟你分享的——安卓智能车载系统ygdh。想象你...
安卓系统审美疲劳,审美疲劳下的... 你有没有发现,最近你的安卓手机是不是越来越让你提不起兴趣了呢?是不是每次打开它,都感觉有点审美疲劳,...
安卓系统最新款的,颠覆性创新与... 你有没有发现,最近手机圈里又掀起了一股热潮?没错,就是安卓系统最新款手机的发布!这款手机不仅在外观上...
用burp扫描安卓系统 你有没有想过,你的安卓手机其实就像一个隐藏的宝藏,里面藏着无数的密码和秘密?今天,就让我带你一起探索...
安卓系统微信后台关闭,揭秘安卓... 你有没有发现,手机里的微信后台总是悄悄地消耗着电量和流量呢?别急,今天就来跟你聊聊安卓系统微信后台关...
安卓系统图片查看器,探索安卓系... 你有没有发现,手机里的照片越来越多,有时候找起来就像大海捞针一样?别急,今天就来给你安利一款神器——...
横店攻略系统和安卓互通,安卓互... 你打算去横店玩一圈,是不是有点手忙脚乱,不知道从何下手呢?别急,今天我就来给你安利一个神器——横店攻...
华为和安卓系统区别,技术差异与... 你知道吗?在手机江湖里,有两个大侠,一个叫华为,一个叫安卓系统。他们一个是江湖中的武林高手,一个是江...
carpaly互联支持安卓系统... 你有没有听说最近的一款超级好用的手机支架——Carpaly?这款支架不仅设计独特,而且据说支持多种操...
安卓8.1替换系统应用,个性化... 你有没有想过,你的安卓手机里那些默认的系统应用,是不是有点儿太老套了?别急,今天就来给你支个招,教你...
怎样把安卓系统弄崩溃 你有没有想过,安卓系统那么强大,怎么就能被你这个小手一挥就弄崩溃呢?别急,今天就来给你揭秘怎样把安卓...
安卓系统手机报废年限,环保先行 你有没有想过,你的安卓手机用了多久了呢?是不是已经有点儿力不从心,卡顿得让你抓狂?别急,今天就来聊聊...
安卓如何开面容支付系统,And... 你有没有想过,在手机上轻轻一扫,就能完成支付,那感觉是不是超级酷炫?没错,这就是安卓手机上的面容支付...
findx升安卓10系统吗,升... 亲爱的手机控们,今天我要和你聊聊一个超级热门的话题——OPPO Find X升级安卓10系统的事情。...
爱家视怎么安装安卓系统 亲爱的读者们,你是不是也和我一样,对家里的爱家视电视盒子充满了好奇?想要给它升级让它也能流畅运行安卓...