SpringBoot-Websocket

本文描述在spring boot下如何使用Websocket得两种方式，并以此文纪念我逝去的二抱和三抱

方式1：spring对javax的完全封装，可适用于复杂场景，例如IM即时通讯系统

方式2：javax注解+spring注解，场景适用于智能机器人客服，用户给服务器机器人发消息，服务器直接回复消息，配置上相对方式1来说简单一些

我个人觉得方式1更全面，所以我先阐述方式1

为了方便测试，首先我们自己建立一个HTML页面，超级简单，你可以新建一个文本文档，将后缀改成.html，然后直接复制下面我写好的代码，用浏览器打开即可，请注意我的端口是8081，请改成你需要的

<html>
怀念二抱三抱
<script>
var websocket= new WebSocket("ws://127.0.0.1:8081/ws");websocket.onopen = function(event) {console.log("WebSocket握手");
};
websocket.onmessage = function(event) {console.log("WebSocket客户端收到一条消息:",event.data);
};
websocket.onerror = function(event) {console.log("WebSocket发生错误 ");
};
websocket.onclose = function(event) {console.log("WebSocket已关闭");console.log(event);
}
function sendMsg(){   var v=document.getElementById("msg").value;console.log("WebSocket客户端发一条送消息:"+v);websocket.send(v);
}
</script>
<body><input type="text" placeholder="请输入要发送的信息" id="msg" /><input type="button" value="发送" onclick="sendMsg()" />
</body>
</html>

接下来开始写服务端，首先pom文件添加依赖

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

方式1
首先建立一个接受消息的类

public class MyWebSocketHandler implements WebSocketHandler {@Overridepublic void afterConnectionEstablished(WebSocketSession session) {//连接成功之后，应该在这个方法中将session保存起来，通常都用//一个Map来保存，key是用户ID（或其他唯一标识），这样的话想//给哪个用户发送消息，那么就直接拿到那个用户的session，然后//调用session.sendMessage方法发送消息就可以了System.out.println("连接成功");}@Overridepublic void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception {System.out.println("客户端过来一条消息，内容是:" + message.getPayload().toString());TextMessage textMessage = new TextMessage("客户端你好，我已经收到你的消息");session.sendMessage(textMessage);}@Overridepublic void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {System.out.println("错误处理");}@Overridepublic void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) {System.out.println("连接关闭");}@Overridepublic boolean supportsPartialMessages() {return false;}
}

然后将上面的类注入到WebSocket相关配置中，启动项目，刷新浏览器即可

@Component
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {//开始我没设置setAllowedOrigins，排查了很久很久，JS就提示//failed，然后没有任何原因，让我很恼火registry.addHandler(new MyWebSocketHandler(), "/ws").setAllowedOrigins("*");}
}

至此方式演示完毕，使用上面的代码就可以实现任何IM功能了，但是还有一个额外的小功能需要说一下，就是方式1的拦截器，如果设置了拦截器，WebSocket请求过来的时候会先走拦截器，这个时候spring会给咱们2个东西，一个是request，一个是Map
request：获取当前请求所有信息，比如请求的URL
map：我们可以往这个map放参数，然后在上面的MyWebSocketHandler中获取到

使用下面的代码设置拦截器

public class MyHandShake implements HandshakeInterceptor {private static final Logger LOG = LoggerFactory.getLogger(HandShake.class);@Overridepublic boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,Map<String, Object> attributes) {attributes.put("name", "兰博");return true;}@Overridepublic void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,Exception exception) {}
}

将拦截器注入到容器中，这需要对前文的代码进行一个修改

@Component
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {// 这行代码比前文的多了一个.addInterceptors(new MyHandShake())registry.addHandler(new MyWebSocketHandler(), "/ws").addInterceptors(new HandShake()).setAllowedOrigins("*");}
}

上述完毕之后，就可以在获取消息时，顺便获取拦截器中设置的name了，例如下面这样

session.getAttributes().get("name").toString();

方式2：很简单，只有这一个类，只要扫描到这类就可以了，不过不适用于多用户聊天

import org.springframework.web.socket.server.standard.ServerEndpointExporter;
import org.springframework.context.annotation.Bean;
import javax.websocket.OnClose;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;@ServerEndpoint("/ws")
@Component
public class MyWebSocketHandler{@Beanpublic ServerEndpointExporter serverEndpoint() {return new ServerEndpointExporter();}@OnOpenpublic void onOpen(Session session) {System.out.println("连接成功");}@OnClosepublic void onClose(Session session) {System.out.println("连接关闭");}@OnMessagepublic String onMsg(String text) throws IOException {System.out.println("客户端过来一条消息，内容是:" + text);return "客户端你好，我已经收到你的消息";}
}

SpringBoot-Websocket相关推荐

SpringBoot WebSocket Stomp
关注 "弋凡"(YiFan)微信公众号吧记录简单笔记做你的最爱 websocket 是什么? 是一种网络通信协议,很多高级功能都需要它为什么要使用websocket? 已经有 ...
springboot websocket
大家好,我是烤鸭: 今天想分享一下springboot+websocket. 之前接到一个需求,需要在页面监听后台的数据(输入邮箱后,需要用户打开邮箱,页面监听用户是否点击激活邮件).之前的实现方式, ...
SpringBoot +WebSocket实现简单聊天室功能实例
SpringBoot +WebSocket实现简单聊天室功能实例) 一.代码来源二.依赖下载三.数据库准备(sql) 数据库建表并插入sql 四.resources文件配置 application ...
springboot websocket 传递头信息协议头 token 的前后端解决方案
文章目录一.前言二.js websocket 传递token 2.1 基于协议头三.后台取出websocket协议头的参数 3.1 取出token 3.2 注意大坑四.结尾一.前言关于sp ...
Springboot + WebSocket 实现在线聊天
一.后端 1.在Springboot项目的pom.xml中添加依赖  <dependency><groupId>org.spri ...
springboot+websocket构建在线聊天室（群聊+单聊）
系列导读: 1.springboot+websocket构建在线聊天室(群聊+单聊) 2.Spring Boot WebSocket:单聊(实现思路) 3.Websocket Stomp+Rabbit ...
SpringBoot WebSocket之多人聊天室实现
SpringBoot WebSocket之多人聊天室实现 WebSocket简介什么是WebSocket? 为什么使用WebSocket? WebSocket的技术特点: WebSocket的技术优 ...
Springboot+WebSocket 自动重连机制
Springboot+WebSocket 自动重连机制 1.WebSocket WebSocket 是一种在单个TCP连接上进行全双工通信的协议,通信协议可能更熟悉的是HTTP,因此,学习WebSoc ...
vue+flv.js+SpringBoot+websocket实现视频监控与回放
vue+flv.js+SpringBoot+websocket实现视频监控与回放需求:vue+springboot的项目,需要在页面展示出海康的硬盘录像机连接的摄像头的实时监控画面以及回放功能. 之 ...
基于 SpringBoot+WebSocket 无DB实现在线聊天室（附源码）
文章目录基于 SpringBoot+WebSocket 无DB实现在线聊天室 0 项目说明 0.1 样例展示 0.2 源码地址 1 WebSocket 简介 1.1 HTTP 1.2 WebSock ...

SpringBoot-Websocket

SpringBoot-Websocket相关推荐

最新文章

热门文章