榆林免费做网站,办公空间设计网站,wordpress 报名表单,平面设计图片大全简介 WebSocket 是基于TCP/IP协议#xff0c;独立于HTTP协议的通信协议。WebSocket 连接允许客户端和服务器之间的全双工通信#xff0c;以便任何一方都可以通过已建立的连接将数据推送到另一方。 我们常用的HTTP是客户端通过「请求-响应」的方式与服务器建立通信的#x…简介 WebSocket 是基于TCP/IP协议独立于HTTP协议的通信协议。WebSocket 连接允许客户端和服务器之间的全双工通信以便任何一方都可以通过已建立的连接将数据推送到另一方。 我们常用的HTTP是客户端通过「请求-响应」的方式与服务器建立通信的必须是客户端主动触发的行为服务端只是做好接口被动等待请求。而在某些场景下的动作是需要服务端主动触发的比如向客户端发送消息、实时通讯、远程控制等。客户端是不知道这些动作几时触发的假如用HTTP的方式那么设备端需要不断轮询服务端这样的方式对服务器压力太大同时产生很多无效请求且具有延迟性。于是才采用可以建立双向通讯的长连接协议。通过握手建立连接后服务端可以实时发送数据与指令到设备端服务器压力小。 Spring WebSocket是Spring框架的一部分提供了在Web应用程序中实现实时双向通信的能力。本教程将引导你通过一个简单的例子演示如何使用Spring WebSocket建立一个实时通信应用。 准备工作 确保你的项目中已经引入了Spring框架的WebSocket模块。你可以通过Maven添加以下依赖 dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-websocket/artifactId /dependency创建WebSocket配置类实现WebSocketConfigurer接口 首先创建一个配置类用于配置WebSocket的相关设置。 package com.ci.erp.human.config;import com.ci.erp.human.handler.WebSocketHandler; import com.ci.erp.human.interceptor.WebSocketHandleInterceptor; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.web.socket.config.annotation.EnableWebSocket; import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker; import org.springframework.web.socket.config.annotation.WebSocketConfigurer; import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;/**** Websocket配置类** author lucky_fd* since 2024-01-17*/ Configuration EnableWebSocket public class WebSocketConfig implements WebSocketConfigurer {Overridepublic void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {// 注册websocket处理器和拦截器registry.addHandler(webSocketHandler(), /websocket/server).addInterceptors(webSocketHandleInterceptor()).setAllowedOrigins(*);registry.addHandler(webSocketHandler(), /sockjs/server).setAllowedOrigins(*).addInterceptors(webSocketHandleInterceptor()).withSockJS();}Beanpublic WebSocketHandler webSocketHandler() {return new WebSocketHandler();}Beanpublic WebSocketHandleInterceptor webSocketHandleInterceptor() {return new WebSocketHandleInterceptor();} } 上面的配置类使用EnableWebSocket注解启用WebSocket并通过registerWebSocketHandlers方法注册WebSocket处理器。 registerWebSocketHandlers这个方法是向spring容器注册一个handler处理器及对应映射地址可以理解成MVC的Handler控制器方法websocket客户端通过请求的url查找处理器进行处理 addInterceptors拦截器当建立websocket连接的时候我们可以通过继承spring的HttpSessionHandshakeInterceptor来做一些事情。 setAllowedOrigins跨域设置*表示所有域名都可以不限制 域包括ipport, 指定*可以是任意的域名不加的话默认localhost本服务端口 withSockJS 这个是应对浏览器不支持websocket协议的时候降级为轮询的处理。 创建WebSocket消息处理器实现TextWebSocketHandler 接口 接下来创建一个消息处理器处理客户端发送的消息。 package com.ci.erp.human.handler;import cn.hutool.core.util.ObjectUtil; import com.ci.erp.common.core.utils.JsonUtils; import com.ci.erp.human.domain.thirdVo.YYHeartbeat; import org.springframework.web.socket.CloseStatus; import org.springframework.web.socket.TextMessage; import org.springframework.web.socket.WebSocketSession; import org.springframework.web.socket.handler.TextWebSocketHandler;import java.io.IOException; import java.util.HashMap; import java.util.Map;/**** websocket处理类* 实现WebSocketHandler接口** - websocket建立连接后执行afterConnectionEstablished回调接口* - websocket关闭连接后执行afterConnectionClosed回调接口* - websocket接收客户端消息执行handleTextMessage接口* - websocket传输异常时执行handleTransportError接口** author lucky_fd* since 2024-01-17*/public class WebSocketHandler extends TextWebSocketHandler {/*** 存储websocket客户端连接* */private static final MapString, WebSocketSession connections new HashMap();/*** 建立连接后触发* */Overridepublic void afterConnectionEstablished(WebSocketSession session) throws Exception {System.out.println(成功建立websocket连接);// 建立连接后将连接以键值对方式存储便于后期向客户端发送消息// 以客户端连接的唯一标识为key,可以通过客户端发送唯一标识connections.put(session.getRemoteAddress().getHostName(), session);System.out.println(当前客户端连接数 connections.size());}/*** 接收消息* */Overrideprotected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {System.out.println(收到消息: message.getPayload());// 收到客户端请求消息后进行相应业务处理返回结果this.sendMessage(session.getRemoteAddress().getHostName(),new TextMessage(收到消息: message.getPayload()));}/*** 传输异常处理* */Overridepublic void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {super.handleTransportError(session, exception);}/*** 关闭连接时触发* */Overridepublic void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {System.out.println(触发关闭websocket连接);// 移除连接connections.remove(session.getRemoteAddress().getHostName());}Overridepublic boolean supportsPartialMessages() {return super.supportsPartialMessages();}/*** 向连接的客户端发送消息** author lucky_fd* param clientId 客户端标识* param message 消息体**/public void sendMessage(String clientId, TextMessage message) {for (String client : connections.keySet()) {if (client.equals(clientId)) {try {WebSocketSession session connections.get(client);// 判断连接是否正常if (session.isOpen()) {session.sendMessage(message);}} catch (IOException e) {System.out.println(e.getMessage());}break;}}} } 通过消息处理器在开发中我们就可以实现向指定客户端或所有客户端发送消息实现相应业务功能。 创建拦截器 拦截器会在握手时触发可以用来进行权限验证 package com.ci.erp.human.interceptor;import org.springframework.http.server.ServerHttpRequest; import org.springframework.http.server.ServerHttpResponse; import org.springframework.web.socket.WebSocketHandler; import org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor;import java.util.Map;/**** Websocket拦截器类** author lucky_fd* since 2024-01-17*/public class WebSocketHandleInterceptor extends HttpSessionHandshakeInterceptor {Overridepublic boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, MapString, Object attributes) throws Exception {System.out.println(拦截器前置触发);return super.beforeHandshake(request, response, wsHandler, attributes);}Overridepublic void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception ex) {System.out.println(拦截器后置触发);super.afterHandshake(request, response, wsHandler, ex);} } 创建前端页面客户端 最后创建一个简单的HTML页面用于接收用户输入并显示实时聊天信息。 !DOCTYPE html html langen headmeta charsetUTF-8titleSpring WebSocket Chat/titlescript srchttps://code.jquery.com/jquery-3.6.4.min.js/scriptscript srchttp://cdn.bootcss.com/sockjs-client/1.1.1/sockjs.js/script /head body请输入input typetext idmessage placeholderType your message button onclicksendMessage()Send/button button onclickwebsocketClose()关闭连接/button div idchat/divscriptvar socket null;if (WebSocket in window) {// 后端服务port为22900socket new WebSocket(ws://localhost:22900/websocket/server);} else if (MozWebSocket in window) {socket new MozWebSocket(ws://localhost:22900/websocket/server);} else {socket new SockJS(http://localhost:22900/sockjs/server);}// 接收消息触发socket.onmessage function (event) {showMessage(event.data);};// 创建连接触发socket.onopen function (event) {console.log(event.type);};// 连接异常触发socket.onerror function (event) {console.log(event)};// 关闭连接触发socket.onclose function (closeEvent) {console.log(closeEvent.reason);};//发送消息function sendMessage() {if (socket.readyState socket.OPEN) {var message document.getElementById(message).value;socket.send(message);console.log(发送成功!);} else {console.log(连接失败!);}}function showMessage(message) {document.getElementById(chat).innerHTML p message /p;}function websocketClose() {socket.close();console.log(连接关闭);}window.close function () {socket.onclose();};/script/body /html这个页面使用了WebSocket对象来建立连接并通过onmessage监听收到的消息。通过输入框发送消息将会在页面上显示。 测试结果 后端日志 前端界面 Java客户端 添加依赖 dependencygroupIdorg.java-websocket/groupIdartifactIdJava-WebSocket/artifactIdversion1.4.0/version /dependency创建客户端类继承WebsocketClient package com.river.websocket;import org.java_websocket.client.WebSocketClient; import org.java_websocket.handshake.ServerHandshake;import java.net.URI; import java.net.URISyntaxException;public class MyWebSocketClient extends WebSocketClient {MyWebSocketClient(String url) throws URISyntaxException {super(new URI(url));}// 建立连接Overridepublic void onOpen(ServerHandshake shake) {System.out.println(shake.getHttpStatusMessage());}// 接收消息Overridepublic void onMessage(String paramString) {System.out.println(paramString);}// 关闭连接Overridepublic void onClose(int paramInt, String paramString, boolean paramBoolean) {System.out.println(关闭);}// 连接异常Overridepublic void onError(Exception e) {System.out.println(发生错误);} }测试websocket package com.river.websocket;import org.java_websocket.enums.ReadyState;import java.net.URISyntaxException;/*** author lucky_fd* date 2024-1-17*/ public class Client {public static void main(String[] args) throws URISyntaxException, InterruptedException {MyWebSocketClient client new MyWebSocketClient(ws://localhost:22900/websocket/server);client.connect();while (client.getReadyState() ! ReadyState.OPEN) {System.out.println(连接状态 client.getReadyState());Thread.sleep(100);}client.send(测试数据);client.close();} }参考链接 通过注解方式实现websocketspringboot集成websocket持久连接权限过滤拦截spring websocket实现前后端通信