【WebSocket】在SSM项目中配置websocket
创始人
2024-05-31 14:26:36
0

在SSM项目中配置websocket

最近在ssm项目中配置了websocket,踩了很多坑,来分享一下

本文暂不提供发送消息等内容的代码逻辑(后续也许会补充),如果你直接复制这类可能会对配置造成更大的麻烦(博主就是复制了他人逻辑导致连接后秒断开连接,排查了很长时间),建议看完本文配置成功后,去其他文章或者github寻找相应代码逻辑

1.Maven依赖

首先是jackson的依赖

		com.fasterxml.jackson.corejackson-annotations2.3.0com.fasterxml.jackson.corejackson-core2.3.1com.fasterxml.jackson.corejackson-databind2.3.3

然后是spring关于websocket的依赖

		org.springframeworkspring-websocket${spring.version}org.springframeworkspring-messaging${spring.version}

这里的${spring.version}需要注意,一定要和自己的spring版本匹配,所以推荐用这种形式,而不是直接用x.x.x.RELEASE

另外在spring4.0.5.RELEASE之前与其以后,session获取参数的方法有些不同,需要注意

本文使用的是

4.2.5.RELEASE

注意:请删除所有关于javax的依赖,将本地的tomcat引入库中,否则可能会出现类型转换异常导致连接报错(你可以继续下面的步骤,如果在启动测试时出现该问题,再回来尝试解决)
在这里插入图片描述
在这里插入图片描述

2.配置类

首先在我们的项目中创建如下结构
在这里插入图片描述

当然也可以不使用这样的结构,如果你的项目中本来有config、Interceptor、handler包,可以将这些类放入其中

注意以下代码没有给出包名,如需复制请注意

首先是WebSocketConfig.java

import org.springframework.stereotype.Component;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;import javax.annotation.Resource;/*** WebScoket配置处理器*/
@Component
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {@ResourceMyWebSocketHandler handler;@ResourceHandShake handShake;public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {//浏览器支持websocketregistry.addHandler(handler, "/ws").addInterceptors(handShake);//浏览器不支持的话,需要socketjs引入支持registry.addHandler(handler, "/ws/sockjs").addInterceptors(handShake).withSockJS();}}

这个类的作用是配置websocket的链接地址,分为浏览器支持websocket和不支持websocket的情况,不支持可以引入sockjs(某些环境下使用这行代码会导致无法连接,不放心可以删去)

websocket连接地址是

ws://ip:端口号/项目名称/ws

ws与上述配置类相对应

这个连接地址是可以以?的形式传参数的,例如

"ws://ip:端口号/项目名称/ws?userId="+userId

第二个类是HandShake.java

import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.http.server.ServletServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.server.HandshakeInterceptor;import javax.servlet.http.HttpSession;
import java.util.Map;/*** Socket建立连接(握手)和断开*/
@Component
public class HandShake implements HandshakeInterceptor {@Overridepublic boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map attributes) throws Exception {// 1.获取sessionServletServerHttpRequest servletRequest = (ServletServerHttpRequest) request;HttpSession session = servletRequest.getServletRequest().getSession(false);// 2.从session中获取uidLong uid = (Long) session.getAttribute("uid");// 3.做正向判断,如果uid是空值直接返回false,拒绝握手if (uid == null){return false;}// 4.输出日志System.out.println("Websocket:用户[ID:" + uid + "]准备进行握手");// 5.将用户id存入mapattributes.put("uid", uid);// 6.可以进行握手return true;}@Overridepublic void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception exception) {System.out.println("after hand");}}

这个类是websocket的握手拦截器,会拦截websocket链接地址的请求,进行握手,不建议在该类中做业务处理

最后是MyWebSocketHandler.java

import org.springframework.stereotype.Component;
import org.springframework.web.socket.*;
import java.io.IOException;/*** Socket处理器*/
@Component
public class MyWebSocketHandler implements WebSocketHandler {@Overridepublic void afterConnectionEstablished(WebSocketSession session)throws Exception {System.out.println("ConnectionEstablished");}@Overridepublic void handleMessage(WebSocketSession session, WebSocketMessage message) throws Exception {}/*** 消息传输错误处理*/@Overridepublic void handleTransportError(WebSocketSession session,Throwable exception) throws Exception {System.out.println("TransportError");}/*** 关闭连接后*/@Overridepublic void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {System.out.println("ConnectionClosed");}@Overridepublic boolean supportsPartialMessages() {return false;}
}

这个类是对websocket的各种状态作出相应的处理,如开头所说,本文不会给出相应的逻辑,防止出现错误,这里真的很坑

大体思路就是通过方法中的WebSocketSession获取到session中的用户id,再注入自己的userService(或者其他service层)去完成业务,同时可以在本类中使用ConcurrentHashMap或者直接开一个线程来实现同时在线人数等功能

发送信息的逻辑推荐对信息进行封装,构建实体类

此外你还可以创建一个相应的Controller,通过注入MyWebSocketHandler来建立相应功能的请求地址

import com.webchat.websocket.MyWebSocketHandler;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;@RestController
@RequestMapping("/websocket")
public class WebSocketController {@AutowiredMyWebSocketHandler handler;}

3.JS部分

最后是js部分

		let websocket = new WebSocket("ws://ip:端口号/项目名称/ws?userId="+userId);websocket.onmessage = function(event) {console.log(event.data)};websocket.onopen = function (event){console.log("连接成功")}websocket.onerror = function (event){console.log("连接错误")}websocket.onclose = function (event){console.log('websocket 断开: ' + event.code + ' ' + event.reason + ' ' + event.wasClean)}

注意更改地址

4.测试结果

测试结果如下
在这里插入图片描述
在这里插入图片描述
至此,ssm项目中配置websocket就完成了

如果在测试中出现其他错误,可以根据输出的event.code来匹配错误原因,如果连接后直接断开并显示1011请检查后端代码规范性

编码原因
1000正常关闭 当你的会话成功完成时发送这个代码
1001离开 因应用程序离开且不期望后续的连接尝试而关闭连接时,发送这一代码。服务器可能关闭,或者客户端应用程序可能关闭
1002协议错误 当因协议错误而关闭连接时发送这一代码
1003不可接受的数据类型 当应用程序接收到一条无法处理的意外类型消息时发送这一代码
1004保留 不要发送这一代码。根据 RFC 6455,这个状态码保留,可能在未来定义
1005保留 不要发送这一代码。WebSocket API 用这个代码表示没有接收到任何代码
1006保留 不要发送这一代码。WebSocket API 用这个代码表示连接异常关闭
1007无效数据 在接收一个格式与消息类型不匹配的消息之后发送这一代码。如果文本消息包含错误格式的 UTF-8 数据,连接应该用这个代码关闭
1008消息违反政策 当应用程序由于其他代码所不包含的原因终止连接,或者不希望泄露消息无法处理的原因时,发送这一代码
1009消息过大 当接收的消息太大,应用程序无法处理时发送这一代码(记住,帧的载荷长度最多为64 字节。即使你有一个大服务器,有些消息也仍然太大。)
1010需要扩展 当应用程序需要一个或者多个服务器无法协商的特殊扩展时,从客户端(浏览器)发送这一代码
1011意外情况 当应用程序由于不可预见的原因,无法继续处理连接时,发送这一代码
1015TLS失败(保留) 不要发送这个代码。WebSocket API 用这个代码表示 TLS 在 WebSocket 握手之前失败。
0 ~ 999禁止 1000 以下的代码是无效的,不能用于任何目的
1000 ~ 2999保留 这些代码保留以用于扩展和 WebSocket 协议的修订版本。按照标准规定使用这些代码,参见表 3-4
3000 ~ 3999需要注册 这些代码用于“程序库、框架和应用程序”。这些代码应该在 IANA(互联网编号分配机构)公开注册
4000 ~ 4999私有 在应用程序中将这些代码用于自定义用途。因为它们没有注册,所以不要期望它们能被其他 WebSocket广泛理解

相关内容

热门资讯

安卓系统能转什么系统好,探索最... 你有没有想过,你的安卓手机是不是也能换换口味,体验一下其他系统的魅力呢?没错,今天就来聊聊这个话题:...
龙之狂热安卓系统,释放龙族狂热 亲爱的手机控们,你是否曾为拥有一款独特的安卓系统而疯狂?今天,就让我带你走进一个充满奇幻色彩的龙之狂...
vivo手机安卓系统怎么升级系... 亲爱的手机控们,你是不是也和我一样,对手机的新功能充满期待呢?尤其是vivo手机的用户,是不是也在想...
鸿蒙2.0退回安卓系统,一场系... 你知道吗?最近科技圈里可是炸开了锅,因为华为的鸿蒙2.0操作系统竟然要退回安卓系统了!这可不是一个简...
安卓系统怎么复制卡,安卓系统卡... 你有没有遇到过这种情况:手机里的照片、视频或者重要文件,突然想备份到电脑上,却发现安卓系统的卡复制功...
app兼容低安卓系统,打造全民... 你有没有发现,现在手机APP更新换代的速度简直就像坐上了火箭!不过,你知道吗?有些APP可是特别贴心...
中间安卓系统叫什么,中间安卓系... 你有没有想过,安卓系统里竟然还有一个中间的版本?没错,就是那个让很多手机用户既熟悉又陌生的版本。今天...
安卓怎么用os系统,利用And... 你有没有想过,你的安卓手机其实可以变身成一个功能强大的操作系统呢?没错,就是那个我们平时在电脑上使用...
pe系统安卓能做么,探索安卓平... 亲爱的读者,你是否曾好奇过,那款在安卓设备上大受欢迎的PE系统,它究竟能做什么呢?今天,就让我带你一...
安卓 打印机系统,安卓打印机系... 你有没有想过,家里的安卓手机和打印机之间竟然能建立起如此紧密的联系?没错,就是那个安卓打印机系统!今...
安卓系统视频做铃声,轻松将视频... 你有没有想过,手机里那些动人心弦的视频,竟然可以变成手机铃声?没错,就是那种一响起就能瞬间抓住你耳朵...
海信电视安卓系统更新,畅享智能... 亲爱的电视迷们,你是否也像我一样,对家里的那台海信电视充满了期待?最近,海信电视安卓系统迎来了一次大...
安卓系统网页不能载入,排查与解... 最近是不是你也遇到了安卓系统网页不能载入的烦恼?别急,让我来帮你一探究竟,找出解决之道!一、问题现象...
赛欧3安卓系统,智能出行新体验 你有没有发现,现在的汽车越来越智能了?这不,我最近就发现了一款特别有意思的车型——赛欧3,它竟然搭载...
能装安卓系统吗,哪些设备能轻松... 你有没有想过,那些看起来普普通通的平板电脑,其实里面藏着大大的秘密呢?没错,就是能装安卓系统!今天,...
安卓能变苹果系统吗,技术揭秘与... 你有没有想过,安卓手机能不能变成苹果系统呢?这听起来就像是科幻电影里的情节,但今天,我们就来揭开这个...
车载安卓系统好卡,车载安卓系统... 你有没有遇到过这样的情况?你的车载安卓系统突然变得超级卡,就像蜗牛一样慢吞吞的,让人抓狂!没错,我就...
安卓系统怎样删除固件,轻松优化... 你有没有遇到过这种情况:手机里的安卓系统突然变得卡顿,或者某个固件版本让你觉得不爽,想要重新来过?别...
安卓鸿蒙系统视频对比,性能与体... 亲爱的读者们,你是否也像我一样,对安卓和鸿蒙系统之间的较量充满了好奇?今天,就让我们一起揭开这场科技...
电脑安卓系统横评,横跨性能与体... 你有没有想过,你的手机和电脑,其实就像两个超级英雄,各有各的本领和特点?今天,就让我带你来一场电脑安...