Spring5高级编程------Spring-WebSocket实现在客户端和服务器之间发送消息的全双工单套接字连接

最新推荐文章于 2025-05-11 11:30:29 发布

原创

最新推荐文章于 2025-05-11 11:30:29 发布 · 1k 阅读

1 ·

CC 4.0 BY-SA版权

本文详细介绍如何在Spring框架中使用WebSocket，包括WebSocket的基本概念、在Spring中实现WebSocket的方式、使用WebSocket API进行配置的具体步骤，以及基于STOMP协议的WebSocket配置方法。文章还提供了前端测试代码示例，帮助读者快速上手。

Spring-WebSocket

一、WebSocket介绍
二、Spring中使用WebSocket
三、使用WebSocket API
四、基于stomp协议的WebSocket配置
五、两个配置类的详细介绍
- 1、WebSocketConfigurer
- 2、WebSocketMessageBrokerConfigurer

一、WebSocket介绍

WebSocket是作为HTML5计划的一部分而开发的一种规范，可以实现在客户端和服务器之间发送消息的全双工单套接字连接。过去，需要实现更新功能的Web应用程序会通过打开多个连接或是使用长轮询来定期轮询服务器端组件以获取更新数据。WebSocket的单套接字能够避免每个客户端需要多个连接并减少开销。

二、Spring中使用WebSocket

从版本4.0开始，Spring框架开始支持WebSocket样式的消息传递以及STOMP作为应用程序级别的子协议。在框架内，可以在spring-websocket模块中找到对WebSocket的支持，该模块与JSR-356兼容。需要注意的是不是所有浏览器都支持WebSocket协议，为了处理这种情况，Spring通过SockJS协议提供了透明的后被选项（根据浏览器的真实情况自动决定使用匹配的协议）。
Spring-WebSocket

三、使用WebSocket API

1、下面是WebSocket API的组件Maven引入方式

注意：SpringMVC项目依赖的其他组件不再这里列出

<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-websocket</artifactId>
	<version>5.2.6.RELEASE</version>
</dependency>
<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-messaging</artifactId>
	<version>5.2.6.RELEASE</version>
</dependency>

2、下面是用于测试通信的前端单页面

<!DOCTYPE html>
<html>
<head>
<title>WebSocket Tester</title>
<script type="text/javascript"
	src="https://cdn.staticfile.org/jquery/1.10.2/jquery.min.js">
	
</script>
<script type="text/javascript">
	var ping;
	var websocket;
	jQuery(function($) {
   
   
		function writePing(message) {
   
   
			$('#pingOutput').append(message + '\n');
		}

		function writeStatus(message) {
   
   
			$('#statusOutput').val($("#statusOutput").val() + message + '\n');
		}

		function writeMessage(message) {
   
   
			$('#messageOutput').append(message + '\n');
		}

		$('#connect').click(function doConnect() {
   
   
			websocket = new WebSocket($("#target").val());

			websocket.onopen = function(evt) {
   
   
				writeStatus("CONNECTED");

				var ping = setInterval(function() {
   
   
					if (websocket != "undefined") {
   
   
						websocket.send("ping");
					}
				}, 3000);
			};

			websocket.onclose = function(evt) {
   
   
				writeStatus("DISCONNECTED");
			};

			websocket.onmessage = function(evt) {
   
   
				if (evt.data === "ping") {
   
   
					writePing(evt.data);
				} else {
   
   
					writeMessage('ECHO: ' + evt.data);
				}
			};

			websocket.onerror = function(evt) {
   
   
				onError(writeStatus('ERROR: ' + evt.data))
			};
		});

		$('#disconnect').click(function() {
   
   
			if (typeof websocket != 'undefined') {
   
   
				websocket.close();
				websocket = undefined;
			} else {
   
   
				alert("Not connected.");
			}
		});

		$('#send').click(function() {
   
   
			if (typeof websocket != 'undefined') {
   
   
				websocket.send($('#message').val());
			} else {
   
   
				alert("Not connected.");
			}
		});
	});
</script>

</head>
<body>
	<h2>WebSocket Tester</h2>
	Target:
	<input id="target" size="40"
		value="ws://127.0.0.1:8081/wholesmart-springmvc-web/echoHandler">
	<br>
	<button id="connect">Connect</button>
	<button id="disconnect">Disconnect</button>
	<br>
	<br