springboot中websocket简单实现_开发_开发者

websocket简单实现

websocket是html5下一种新的协议，本质上websocket是一个基于tcp的协议。它实现了浏览器与服务器之间的双向通信，能更好的节省服务器资源和宽带并实现实时的通信。
websocket的几个优点?
1、使用的资源少，因为它的头更小。
2、实时性更强：服务端可以通过连接主动向客户端推送消息。
3、有状态：开启连接之后可以不用每次都携带状态信息。

下面介绍spring集成的websocket的使用方法。

引入依赖包

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

实现WebSocketHandler 接口重写相关方法。

主要有以下几个方法：
afterConnectionEstablished：连接成功后调用。
handleMessage：处理发送来的消息。
handleTransportError： WS 连接出错时调用。
aftepythonrConnectionClosed：连接关闭后调用。
supportsPartialMessages：是否支持分片消息。

import cn.hutool.core.collection.CollUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.web.socket.*;

import Java.io.IOException;
import java.util.concurrent.CopyOnWriteArrayList;

/**
 * 测试websocket
 *
 * @author yjj
 * @version 1.0
 * @since 2022 -12-28 14:55:29
 */
@Slf4j
@Component
public class TestWebsocket implements WebSocketHandler {

    protected static final CopyOnWriteArrayList<WebSocketSession> WEB_SOCKET_SESSIONS = new CopyOnWriteArrayList<>();

    /**
     * 建立连接后操作
     *编程
     * @param session       连接session信息
     * @throws Exception    exception
     */
    @Override
    public void afterConnectionE编程客栈stablished(WebSocketSession session) throws Exception {
        WEB_SOCKET_SESSIONS.add(session);
        sendMessage("连接成功~~~~~~,sessionId=" + session.getId());
    }

    /**
     * 接收到消息后的处理
     *
     * @param session       连接session信息
     * @param message       信息
     * @throws Exception    exception
     */
    @Override
    public void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception {
        sendMessage("接收到的消息为=【"+ message +"】,sessionId=【"+ session.getId() +"】,回复消息=【你好呀！】");
    }

    /**
     * ws连接出错时调用
     *
     * @param session       session连接信息
     * @param exception     exception
     * @throws Exception    exception
     */
    @Override
    public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
        if(session.isOpen()){
            sendMessage("ws连接出错，即将关闭此session,sessionId=【"+ session.getId() +"】");
            session.close();
        }
        WEB_SOCKET_SESSIONS.remove(session);
    }

    /**
     * 连接关闭后调用
     *
     * @param session           session连接信息
     * @param closeStatus       关闭状态
     * @throws Exception        exception
     */
    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
        if(session.isOpen()){
            sendMessage("ws连接即将关闭此session,sessionId=【"+ session.getId() +"】");
            session.close();
        }
        pythonWEB_SOCKET_SESSIONS.remove(session);
    }

    /**
     * 是否支持分片消息
     */
    @Override
    public boolean supportsPartialMessages() {
        return false;
    }

    /**
     * 发送消息
     * @param message          消息
     * @throws IOException     ioException
     */
    public void sendMessage(String message) throws IOException {
        if(CollUtil.isNotEmpty(WEB_SOCKET_SESSIONS)){
            for (WebSocketSession webSocketSession : WEB_SOCKET_SESSIONS) {
                webSocketSession.sendMessage(new TextMessage(message));
            }
        }
    }
}

监听某个URL，websocket配置

import org.springframework开发者_Python教程.context.annotation.Configuration;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;

import javax.annotation.Resource;
/**
 * websocket配置
 *
 * @author yjj
 * @version 1.0
 * @since 2022 -12-28 15:10:11
 */
@EnableWebSocket
@Configuration
public class WebSocketConfig implements WebSocketConfigurer {

    @Resource
    private TestWebsocket testWebsocket;

    /**
     * Register {@link WebSocketHandler WebSocketHandlers} including Sockjs fallback options if desired.
     *
     * @param registry
     */
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(testWebsocket, "/test").setAllowedOrigins("*");
    }
}

测试

使用websocket工具进行连接后效果图如下:

springboot中websocket简单实现