【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广泛理解

相关内容

热门资讯

如何删除安卓系统信息,安卓系统... 手机里的信息越来越多,是不是感觉自己的隐私都快要被暴露无遗了?别担心,今天就来教你怎么轻松删除安卓系...
国产安卓系统哪个流畅,揭秘哪家... 你有没有想过,手机里的操作系统就像是我们的大脑,有时候它运行得快慢,直接影响我们的使用体验呢?今天,...
安卓怎么刷主机系统,掌握主机系... 你有没有想过,你的安卓手机或者平板,是不是也能像电脑一样,装上各种酷炫的系统呢?没错,今天就要来给你...
安卓系统桌面显示时间,见证日常... 你有没有发现,每次打开安卓手机,那桌面上的时间总是一闪一闪的,仿佛在告诉你:“时间不等人哦!”今天,...
os云刷安卓系统,畅享智能新体... 你有没有想过,你的安卓手机是不是也能像电脑一样,装上各种酷炫的系统呢?没错,今天就要来跟你聊聊这个神...
安卓系统如何装siri,安卓设... 你有没有想过,在安卓手机上也能享受到Siri的智能语音助手服务呢?没错,就是那个在iPhone上呼之...
电脑怎么安卓双系统,电脑安装安... 你有没有想过,一台电脑同时运行安卓和Windows系统,那得多酷啊!想象一边处理工作,一边刷刷抖音,...
linux操作系统与安卓系统,... 你有没有想过,为什么你的手机可以随时随地给你发送信息,而你的电脑却能帮你处理复杂的任务呢?这背后,就...
安卓大屏系统信息,功能与体验全... 你有没有发现,最近手机界的大屏风潮真是势不可挡啊!安卓大屏系统信息,这可是个热门话题呢!想象拿着一块...
苹果7转安卓系统,探索安卓系统... 你有没有想过,从苹果7转到安卓系统会是怎样的体验呢?想象你手中的那个曾经陪伴你度过无数美好时光的苹果...
安卓系统打卡手机推荐,高效便捷... 你有没有想过,每天早上起床后,第一件事就是拿出手机打卡签到?这已经成为现代生活中不可或缺的一部分了。...
安卓手机装了小米系统,小米系统... 你有没有想过,把安卓手机的灵魂换成小米的系统,会是怎样的体验呢?想象原本流畅的安卓系统,突然间被注入...
安卓汽车系统怎么升级,轻松实现... 亲爱的安卓车主们,你是否也像我一样,对汽车系统升级充满了好奇和期待呢?想象你的爱车就像一部智能手机,...
手机怎么变安卓系统,轻松实现系... 你有没有想过,你的手机居然可以变身成为安卓系统呢?没错,就是那个自由度极高的操作系统!今天,就让我来...
安卓仿ios系统横条,打造流畅... 你有没有发现,最近安卓手机上出现了一种特别的新花样——仿iOS系统的横条设计!这可不是简单的模仿,而...
谷歌汽车安卓系统下载,引领智能... 你有没有想过,未来的汽车可能会变成一个移动的智能中心?想象你的汽车不仅能够带你穿梭在城市的大街小巷,...
安卓系统硬件修复软件,全面解析... 手机里的安卓系统突然卡顿,是不是让你头疼不已?别急,今天就来给你揭秘那些神奇的安卓系统硬件修复软件,...
鸿蒙系统比安卓系统大么,体积对... 你有没有想过,手机里的操作系统,就像是手机的心脏,它的大小、性能,都直接影响到手机的使用体验。今天,...
安卓系统 刷机模式,刷机模式操... 你有没有想过,你的安卓手机其实就像一个隐藏着无限可能的宝藏呢?没错,今天就要来跟你聊聊这个宝藏的秘密...
案卷制作系统下载安卓,高效便捷... 你有没有想过,在手机上也能轻松制作案卷呢?没错,现在就有这么一款神器——案卷制作系统,而且它还支持安...