记录SpringBoot整合WebSocket

本文介绍了如何在SpringBoot项目中集成WebSocket,首先通过Spring Initializr生成WebSocket项目,然后逐步讲解配置过程,包括添加websocket starter、配置ServerEndpointExporter以发布接口,接着编写服务端代码并利用@Component注解使其可被容器扫描,最后通过在线工具进行测试,验证了服务端消息的正常发送和接收。
摘要由CSDN通过智能技术生成

通过https://start.spring.io/生成一个websocket项目。老项目则增加websocket的starter

其中websocket核心包

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

将生成的项目导入ide后开始配置websocket

第一步,增加websocket配置,ServerEndpointExporter将我们配置的websocket接口地址发布出来,外面才可以调用

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

@Configuration
public class WebSocketConfig {
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return
好的,下面是Spring Boot整合WebSocket的步骤: 1. 添加依赖 在Maven或Gradle中添加以下依赖: Maven: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> ``` Gradle: ``` implementation 'org.springframework.boot:spring-boot-starter-websocket' ``` 2. 创建WebSocket配置类 创建一个WebSocket配置类,实现WebSocketMessageBrokerConfigurer接口,并覆盖configureMessageBroker()和registerStompEndpoints()方法。 ```java @Configuration @EnableWebSocketMessageBroker public class WebSocketConfig implements WebSocketMessageBrokerConfigurer { @Override public void configureMessageBroker(MessageBrokerRegistry config) { config.enableSimpleBroker("/topic"); config.setApplicationDestinationPrefixes("/app"); } @Override public void registerStompEndpoints(StompEndpointRegistry registry) { registry.addEndpoint("/ws").withSockJS(); } } ``` - configureMessageBroker()方法用于配置消息代理,这里使用了基于内存的简单消息代理。它可以处理以“/topic”为前缀的消息,并将其广播到所有已订阅该主题的客户端。同时,还配置了以“/app”为前缀的应用程序消息。 - registerStompEndpoints()方法用于注册STOMP端点,将其映射到指定的URL。在此示例中,将“/ws”端点注册为SockJS端点,SockJS是一个JavaScript库,可在不支持WebSocket的浏览器中提供WebSocket功能。 3. 创建WebSocket处理程序 创建一个WebSocket处理程序,可以处理客户端发送的WebSocket消息。在此示例中,我们将创建一个简单的EchoHandler,将收到的消息返回给客户端。 ```java @Component public class EchoHandler extends TextWebSocketHandler { @Override public void handleTextMessage(WebSocketSession session, TextMessage message) throws IOException { session.sendMessage(new TextMessage("Echo: " + message.getPayload())); } } ``` 4. 发送和接收消息 在客户端上,您可以使用SockJS和STOMP客户端库与WebSocket服务进行通信。以下是一个简单的JavaScript示例,显示如何发送和接收消息: ```javascript var socket = new SockJS('/ws'); var stompClient = Stomp.over(socket); stompClient.connect({}, function(frame) { console.log('Connected: ' + frame); stompClient.subscribe('/topic/messages', function(message) { console.log('Received: ' + message.body); }); }); function sendMessage() { var message = document.getElementById('message').value; stompClient.send("/app/message", {}, message); } ``` 在此示例中,我们使用SockJS连接到WebSocket端点,然后使用STOMP客户端库进行订阅和发送消息。在连接到WebSocket后,我们订阅了“/topic/messages”主题,并在接收到消息时将其记录到控制台中。我们还定义了一个sendMessage()函数,该函数从输入框中获取消息并将其发送到“/app/message”应用程序消息。 希望这个简单的例子对你有所帮助。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值