WebScoket实现

什么是webscoket?

WebSockets 是一种在 Web浏览器和服务器之间实现双向通信的协议。它允许服务器主动向客户端推送数据，而不需要客户端发起请求。相较于传统的基于请求-响应模式的通信（如
HTTP），WebSockets 提供了更高效、更实时的数据传输能力，适用于实时聊天、实时数据更新等场景。WebSockets 基于 TCP 协议，通过建立长连接，可以保持持续的通信通道，使得双方能够实时地进行数据交换。

如何搭建简单的webscoket程序
1.导入依赖

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

2.配置 ServerEndpointExporter Bean

它会自动扫描并注册所有带有 @ServerEndpoint 注解的类，使得这些 WebSocket 端点能够被容器初始化和管理

@Configuration public class WebSocketConfig {
    @Bean
    public ServerEndpointExporter serverEndpointExporter(){
        return new ServerEndpointExporter();
    } }

3.配置过滤器

主要解决ws连接无法携带token在请求头里面,从而导致权限问题,使用Sec-WebSocket-Protocol能将jwt放入,但是使用的同时一定要返回Sec-WebSocket-Protocol否则会报错

@Component
@WebFilter(filterName = "WebsocketFilter", urlPatterns = "/ws/**")
public class WebSocketFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletResponse response = (HttpServletResponse) servletResponse;
        String token = ((HttpServletRequest) servletRequest).getHeader(WebSocketConstans.WEBSOCKET_PROTOCOL);
        // 解决 Sent non-empty 'Sec-WebSocket-Protocol' header but no response was received
        response.setHeader(WebSocketConstans.WEBSOCKET_PROTOCOL,token);
        filterChain.doFilter(servletRequest, servletResponse);
    }
    @Override
    public void destroy() {}
}

4.配置webscoket服务器端口

@ServerEndpoint 是一个注解，用于将一个普通的 Java 类转换为 WebSocket 服务器端点（endpoint）。被
@ServerEndpoint 注解修饰的类可以处理客户端与服务器之间的 WebSocket 连接，并接收和发送消息

//value是连接路径
@ServerEndpoint(value = "/websocket")
@Component
@Slf4j
public class WebSocketServer {
    private static final AtomicInteger onlineCount = new AtomicInteger(0);

    private static Map<String, Session> map = new ConcurrentHashMap<>();

    private String username;


//当连接成功时运行
    @OnOpen
    public void onOpen(EndpointConfig endpointConfig, Session session) {
                 log.info(连接成功)
                   //代码逻辑
    }

//当连接关闭时执行
    @OnClose
    public void onClose(Session session) {
            //代码逻辑
        int count = onlineCount.decrementAndGet();
        log.info("有一连接关闭！当前在线人数为:{}", count);
    }

//当客户端向webscoket发送消息时执行
    @OnMessage
    public void onMessage(String message, Session session) {
                //代码逻辑
    }
//当发生异常时执行
    @OnError
    public void onError(Session session, Throwable throwable) {
        log.info("出现异常");
        throwable.printStackTrace();
    }
}

5.使用postman进行连接,即可连接成功