使用WebFlux处理WebSocket连接的全生命周期案例

使用WebFlux处理WebSocket连接的全生命周期案例

简介：
在Web应用程序开发中，WebSocket是一种用于实现双向通信的协议。Spring WebFlux提供了对WebSocket的支持，使您能够轻松地处理WebSocket连接和消息。本博客将介绍如何使用WebFlux处理WebSocket连接和消息，以及其全部生命周期。

在Spring WebFlux中，您可以使用WebSocketHandler这是webflux集成websocket的全生命周期,包括从连接发送到释放的全周期,其他拓展功能可以自行添加：

package com.example.webfluxdemo.handler;

import lombok.extern.slf4j.Slf4j;
import org.jetbrains.annotations.NotNull;
import org.springframework.stereotype.Component;
import org.springframework.web.reactive.socket.WebSocketHandler;
import org.springframework.web.reactive.socket.WebSocketMessage;
import org.springframework.web.reactive.socket.WebSocketSession;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;


/**
 * @Author: kingdol
 * @Description: a test to websockthandler
 */
@Component
@Slf4j
public class MyWebSocketHandler implements WebSocketHandler {

    @NotNull
    @Override
    public Mono<Void> handle(WebSocketSession session) {

        return session.receive().doOnSubscribe(s -> {
            log.info("发起连接:{}", s);
        }).doOnTerminate(() -> {
            log.info("doOnTerminate");
        }).doOnComplete(() -> {
            log.info("doOnComplete");
        }).doOnCancel(() -> {
            log.info("doOnCancel");
        }).doOnNext(message -> {
            if (message.getType().equals(WebSocketMessage.Type.BINARY)) {
                log.info("收到二进制消息");
                BinaryMessageHandler(session, message);
            } else if (message.getType().equals(WebSocketMessage.Type.TEXT)) {
                String content = message.getPayloadAsText();
                log.info("收到文本消息:{}", content);
                TestMessageHandler(session, message);
            } else if (message.getType().equals(WebSocketMessage.Type.PING)) {
                log.info("收到ping消息");
                PingTypeHandler(session, message);
            } else if (message.getType().equals(WebSocketMessage.Type.PONG)) {
                log.info("收到pong消息");
                PongTypeHandler(session, message);
            }
        }).doOnError(e -> {
            e.printStackTrace();
            log.error("doOnError");
        }).doOnRequest(r -> {
            log.info("doOnRequest");
        }).then();
    }

    private void BinaryMessageHandler(WebSocketSession session, WebSocketMessage message) {
    }

    private void PongTypeHandler(WebSocketSession session, WebSocketMessage message) {
    }

    private void PingTypeHandler(WebSocketSession session, WebSocketMessage message) {
    }

    private void TestMessageHandler(WebSocketSession session, WebSocketMessage message) {
        session.send(Flux.just(session.textMessage(message.getPayloadAsText()))).subscribe();
    }
}

在上面的示例中，MyWebSocketHandler实现了WebSocketHandler接口，并重写了handle方法来处理WebSocket连接和消息。在handle方法中，我们订阅了接收到的消息流，并对每个消息进行处理。在处理消息时，我们将接收到的消息转换为大写形式，并将响应发送回客户端。

要在应用程序中使用该WebSocket处理程序，您需要进行一些配置。以下是一个简单的配置示例：

package com.example.webfluxdemo.config;

import com.example.webfluxdemo.handler.MyWebSocketHandler;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.reactive.handler.SimpleUrlHandlerMapping;
import org.springframework.web.reactive.socket.server.support.WebSocketHandlerAdapter;

import java.util.HashMap;
import java.util.Map;

@Configuration
public class WebSocketConfig {

    @Bean
    public MyWebSocketHandler myWebSocketHandler() {
        return new MyWebSocketHandler();
    }

    @Bean
    public SimpleUrlHandlerMapping webSocketHandlerMapping() {
        Map<String, MyWebSocketHandler> map = new HashMap<>();
        map.put("/websocket", myWebSocketHandler());

        SimpleUrlHandlerMapping handlerMapping = new SimpleUrlHandlerMapping();
        handlerMapping.setUrlMap(map);
        handlerMapping.setOrder(1);
        return handlerMapping;
    }

    @Bean
    public WebSocketHandlerAdapter handlerAdapter() {
        return new WebSocketHandlerAdapter();
    }
}

在上面的配置示例中，我们创建了一个WebSocketConfig类，并定义了myWebSocketHandler、webSocketHandlerMapping和handlerAdapter这三个Bean。myWebSocketHandler是我们之前编写的WebSocket处理程序，webSocketHandlerMapping用于将WebSocket处理程序映射到URL路径，handlerAdapter是用于适配WebSocket处理程序的适配器。

要启动应用程序并使用WebSocket连接，您需要在Spring Boot的启动类上添加@EnableWebFlux注解。
以上就是全生命周期的基本讲解,谢谢观看!