java springboot websocket使用

最新推荐文章于 2025-07-27 15:37:30 发布

原创最新推荐文章于 2025-07-27 15:37:30 发布 · 672 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#websocket #java #spring boot

本文介绍了一种利用WebSocket实现前后端实时通信的方法，解决了前端展示后台订单状态变更的需求。通过建立WebSocket连接，后端能够在状态发生变化时主动推送更新至前端。

场景

今天遇到了一个问题，需求是前端要实时展示后台订单，当订单状态发生变更的时候，前端也要及时展示。
一开始考虑的方案是前端使用定时器轮训请求后端接口查询数据，后来前端说js的定时器不稳定，于是考虑后端主动推送给前端的方案，于是这里使用socket让前后端建立连接，并主动给前端推送。
参考链接: 这位大佬有梦_咸鱼

代码

package com.sjcx.lng.infrastructure.socket;

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.stereotype.Component;

import javax.websocket.OnClose;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;

/**
 * @author fenglu
 * @date 2022/6/30 20:00
 * @description:
 */
@ServerEndpoint("/socket/screen")
@Component
@Slf4j
public class WebSocketHandler implements InitializingBean {

    private Session session;

    private static CopyOnWriteArraySet<WebSocketHandler> websocket = new CopyOnWriteArraySet<>();

    @OnOpen
    public void onOpen(Session session){
        this.session =session;
        websocket.add(this);
        //如果连接大于多少 则拒绝连接
        log.info("【websocket消息】有新的连接，总数：{}",websocket.size());
    }

    @OnClose
    public void onClose(){
        websocket.remove(this);
        log.info("【websocket消息】连接断开，总数：{}",websocket.size());
    }

    @OnMessage
    public void onMessage(String message){
        log.info("【websocket消息】，收到客户端发来的消息:{}",message);
        try {
            this.session.getBasicRemote().sendText("这里什么都没有，来到一片荒原 T.T");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    public void sendMessage(String message){
        log.info("【websocket消息】广播消息");
        // 可以在状态变更的时候使用redis的消息订阅，让这里的线程一直等待消费redis的消息，通知这里的sendMessage，
        // 让其主动查询并通知浏览器。这是一个问题，需要研究一下
        if (websocket.size() > 0){
            //有连接的情况才发送
            for (WebSocketHandler websocket : websocket) {
                try {
                    websocket.session.getBasicRemote().sendText(message);
                }
                catch (Exception e){
                    e.printStackTrace();
                }
            }
        }
    }

    Runnable runnable = new Runnable() {
        @SneakyThrows(InterruptedException.class)
        @Override
        public void run() {
            //线程不中断的情况下
            while (!Thread.currentThread().isInterrupted()){
                sendMessage("定时发送");
                Thread.sleep(60 * 1000);
            }
        }
    };

    @Override
    public void afterPropertiesSet() {
        final Thread thread = new Thread(runnable);
        thread.start();
    }
}

配置类，要是没有这个的话，前端连不上服务端

package com.sjcx.lng.infrastructure.socket;

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

/**
 * @author fenglu
 * @date 2022/6/30 20:01
 * @description:
 */
@Component
public class WebSocketConfig {

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

}

前端

<!DOCTYPE html>
<html>
    <head>
        <meta charset="UTF-8">
        <title></title>
    </head>
    <body>
        websocket Demo---- user000 <br />
        <input id="text" type="text" /> 
        <button onclick="send()"> Send </button>   
        <button   onclick="closeWebSocket()"> Close </button>
        <div id="message">   </div>
        
    <script type="text/javascript">
     //判断当前浏览器是否支持WebSocket
      if('WebSocket' in window){
          websocket = new WebSocket("ws://localhost:8012/socket/screen");
          console.log("link success")
      }else{
          alert('Not support websocket')
      }
      
      //连接发生错误的回调方法
      websocket.onerror = function(){
          setMessageInnerHTML("error");
      };
       
      //连接成功建立的回调方法
      websocket.onopen = function(event){
          setMessageInnerHTML("open");
      }
       console.log("-----")
      //接收到消息的回调方法
      websocket.onmessage = function(event){
            setMessageInnerHTML(event.data);
      }
       
      //连接关闭的回调方法
      websocket.onclose = function(){
          setMessageInnerHTML("close");
      }
       
      //监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
      window.onbeforeunload = function(){
          websocket.close();
      }
       
      //将消息显示在网页上
      function setMessageInnerHTML(innerHTML){
          document.getElementById('message').innerHTML += innerHTML + '<br/>';
      }
       
      //关闭连接
      function closeWebSocket(){
          websocket.close();
      }
       
      //发送消息
      function send(){
          var message = document.getElementById('text').value;
          websocket.send(message);
      }
    </script>
        
    </body>
</html>