Spring Boot中整合WebSocket

左手的ㄟ右手 2023-10-16 13:59 64阅读 0赞

## Spring Boot中整合WebSocket ##

### 按照以下步骤进行操作： ###

#### 1、添加依赖：在`pom.xml`文件中添加以下依赖： ####

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

#### 2、创建 WebSocket 配置类：创建一个配置类来配置和启用WebSocket支持。 ####

@Configuration
    @EnableWebSocket
    public class WebSocketConfig implements WebSocketConfigurer {
        
    
        @Override
        public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        
            registry.addHandler(myWebSocketHandler(), "/my-websocket").setAllowedOrigins("*");
        }
    
        @Bean
        public WebSocketHandler myWebSocketHandler() {
        
            return new MyWebSocketHandler();
        }
    }

##### 在上述代码中，`registerWebSocketHandlers()` 方法用于注册WebSocket处理器，并指定处理器的路径和允许的来源。`myWebSocketHandler()` 方法创建并返回自定义的WebSocket处理器对象。 #####

#### 2.1、创建 WebSocket 处理器：创建一个WebSocket处理器来处理WebSocket连接和消息。 ####

public class MyWebSocketHandler extends TextWebSocketHandler {
        
    
        @Override
        public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        
            // 当连接建立时调用
        }
    
        @Override
        protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        
            // 处理收到的文本消息
        }
    
        @Override
        public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        
            // 连接关闭时调用
        }
    }

##### 在上述代码中，您可以重写 `afterConnectionEstablished()` 方法处理连接建立时的逻辑，`handleTextMessage()` 方法处理接收到的文本消息，`afterConnectionClosed()` 方法处理连接关闭时的逻辑。 #####

#### 2.2、创建控制器类：创建一个控制器类来处理客户端的请求和转发。 ####

@RestController
    public class WebSocketController {
    
        @Autowired
        private SimpMessagingTemplate messagingTemplate;
    
        @RequestMapping("/send-message")
        public String sendMessage() {
            messagingTemplate.convertAndSend("/my-websocket", "Hello, WebSocket!");
            return "Message sent";
        }
    }

在上述代码中，使用 `SimpMessagingTemplate` 来发送消息到WebSocket。在 `/send-message` 的请求处理方法中，调用 `convertAndSend()` 方法发送消息给指定的WebSocket路径 `/my-websocket`。

#### 2.3、创建前端页面：在前端页面中，使用JavaScript代码来与WebSocket进行交互。 ####

在上述代码中，通过创建WebSocket实例来连接到指定的WebSocket路径。然后，可以使用 `onopen`、`onmessage` 和 `onclose` 事件处理程序来处理WebSocket连接的打开、接收消息和关闭。

1.  启动应用程序：运行Spring Boot应用程序，并访问前端页面或调用控制器的接口通过 `/send-message` 请求发送消息到WebSocket以与WebSocket进行交互

现在，您已经成功地在Spring Boot应用程序中整合了WebSocket。当客户端连接到 `/my-websocket` 路径时，`MyWebSocketHandler` 中的相应方法将会被调用，您可以在这些方法中实现您的自定义逻辑。同时，您可以使用 `messagingTemplate` 在其他地方发送消息到WebSocket。