springboot中websocket简单实现
作者:C~LOVER
本文主要介绍了springboot中websocket简单实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
websocket简单实现
websocket是HTML5下一种新的协议,本质上websocket是一个基于tcp的协议。它实现了浏览器与服务器之间的双向通信,能更好的节省服务器资源和宽带并实现实时的通信。
websocket的几个优点?
1、使用的资源少,因为它的头更小。
2、实时性更强:服务端可以通过连接主动向客户端推送消息。
3、有状态:开启连接之后可以不用每次都携带状态信息。
下面介绍spring集成的websocket的使用方法。
引入依赖包
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> <version>2.4.3</version> </dependency>
实现WebSocketHandler 接口重写相关方法。
主要有以下几个方法:
afterConnectionEstablished:连接成功后调用。
handleMessage:处理发送来的消息。
handleTransportError: WS 连接出错时调用。
afterConnectionClosed:连接关闭后调用。
supportsPartialMessages:是否支持分片消息。
import cn.hutool.core.collection.CollUtil; import lombok.extern.slf4j.Slf4j; import org.springframework.stereotype.Component; import org.springframework.web.socket.*; import java.io.IOException; import java.util.concurrent.CopyOnWriteArrayList; /** * 测试websocket * * @author yjj * @version 1.0 * @since 2022 -12-28 14:55:29 */ @Slf4j @Component public class TestWebsocket implements WebSocketHandler { protected static final CopyOnWriteArrayList<WebSocketSession> WEB_SOCKET_SESSIONS = new CopyOnWriteArrayList<>(); /** * 建立连接后操作 * * @param session 连接session信息 * @throws Exception exception */ @Override public void afterConnectionEstablished(WebSocketSession session) throws Exception { WEB_SOCKET_SESSIONS.add(session); sendMessage("连接成功~~~~~~,sessionId=" + session.getId()); } /** * 接收到消息后的处理 * * @param session 连接session信息 * @param message 信息 * @throws Exception exception */ @Override public void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception { sendMessage("接收到的消息为=【"+ message +"】,sessionId=【"+ session.getId() +"】,回复消息=【你好呀!】"); } /** * ws连接出错时调用 * * @param session session连接信息 * @param exception exception * @throws Exception exception */ @Override public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception { if(session.isOpen()){ sendMessage("ws连接出错,即将关闭此session,sessionId=【"+ session.getId() +"】"); session.close(); } WEB_SOCKET_SESSIONS.remove(session); } /** * 连接关闭后调用 * * @param session session连接信息 * @param closeStatus 关闭状态 * @throws Exception exception */ @Override public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception { if(session.isOpen()){ sendMessage("ws连接即将关闭此session,sessionId=【"+ session.getId() +"】"); session.close(); } WEB_SOCKET_SESSIONS.remove(session); } /** * 是否支持分片消息 */ @Override public boolean supportsPartialMessages() { return false; } /** * 发送消息 * @param message 消息 * @throws IOException ioException */ public void sendMessage(String message) throws IOException { if(CollUtil.isNotEmpty(WEB_SOCKET_SESSIONS)){ for (WebSocketSession webSocketSession : WEB_SOCKET_SESSIONS) { webSocketSession.sendMessage(new TextMessage(message)); } } } }
监听某个URL,websocket配置
import org.springframework.context.annotation.Configuration; import org.springframework.web.socket.WebSocketHandler; 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; /** * websocket配置 * * @author yjj * @version 1.0 * @since 2022 -12-28 15:10:11 */ @EnableWebSocket @Configuration public class WebSocketConfig implements WebSocketConfigurer { @Resource private TestWebsocket testWebsocket; /** * Register {@link WebSocketHandler WebSocketHandlers} including SockJS fallback options if desired. * * @param registry */ @Override public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) { registry.addHandler(testWebsocket, "/test").setAllowedOrigins("*"); } }
测试
使用websocket工具进行连接后效果图如下:
到此这篇关于springboot中websocket简单实现的文章就介绍到这了,更多相关springboot websocket实现内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!
您可能感兴趣的文章:
- Springboot实现人脸识别与WebSocket长连接的实现代码
- SpringBoot+WebSocket实现IM及时通讯的代码示例
- SpringBoot+websocket实现消息对话功能
- SpringBoot 整合WebSocket 前端 uniapp 访问的详细方法
- Springboot+WebSocket+Netty实现在线聊天/群聊系统
- SpringBoot集成WebSocket的两种方式(JDK内置版和Spring封装版)
- SpringBoot中使用WebSocket的教程分享
- SpringBoot实现WebSocket全双工通信的项目实践
- 使用WebSocket+SpringBoot+Vue搭建简易网页聊天室的实现代码
- SpringBoot整合WebSocket实现后端向前端发送消息的实例代码
- Springboot+WebSocket实现在线聊天功能
- Spring Boot中的WebSocketMessageBrokerConfigurer接口使用