SpringBoot使用WebSocket与vue进行交互

骑猪看日落 2022-05-10 11:20 266阅读 0赞

# **SpringBoot使用WebSocket与vue进行交互** #

### **SpringBoot配置WebSocket** ###

*  pom文件中添加
    
     
    
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
            <version>1.3.5.RELEASE</version>
        </dependency>
        
 *  WebSocket配置类
    
     
    
        import org.springframework.context.annotation.Bean;
        import org.springframework.context.annotation.Configuration;
        import org.springframework.web.socket.server.standard.ServerEndpointExporter;
        
        @Configuration
        public class WebSocketConfig {
            /**
             * 注入ServerEndpointExporter，
             * 这个bean会自动注册使用了@ServerEndpoint注解声明的Websocket endpoint
             *
             * @return
             */
            @Bean
            public ServerEndpointExporter serverEndpointExporter() {
                return new ServerEndpointExporter();
            }
        }
 *  WebSocket操作类【这里@ServerEndpoint(value = "/kungfupeng/websocket")的作用相当于端口号】
    
     
    
        mport org.springframework.stereotype.Component;
        
        import javax.websocket.*;
        import javax.websocket.server.ServerEndpoint;
        import java.io.IOException;
        import java.util.Arrays;
        import java.util.concurrent.CopyOnWriteArraySet;
        
        @ServerEndpoint(value = "/kungfupeng/websocket")
        @Component
        public class CustomWebSocket {
            /**
             * 静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
             */
            private static int onlineCount = 0;
            /**
             * concurrent包的线程安全Set，用来存放每个客户端对应的CumWebSocket对象。
             */
            private static CopyOnWriteArraySet<CustomWebSocket> webSocketSet = new CopyOnWriteArraySet<CustomWebSocket>();
            /**
             * 与某个客户端的连接会话，需要通过它来给客户端发送数据
             */
            private Session session;
        
            /**
             * 连接建立成功调用的方法
             *
             * @param session
             */
            @OnOpen
            public void onOpen(Session session) {
                this.session = session;
                //加入set中
                webSocketSet.add(this);
                //添加在线人数
                addOnlineCount();
                System.out.println("新连接接入。当前在线人数为：" + getOnlineCount());
            }
        
            /**
             * 连接关闭调用的方法
             */
            @OnClose
            public void onClose() {
                //从set中删除
                webSocketSet.remove(this);
                //在线数减1
                subOnlineCount();
                System.out.println("有连接关闭。当前在线人数为：" + getOnlineCount());
            }
        
            /**
             * 收到客户端消息后调用
             *
             * @param message
             * @param session
             */
            @OnMessage
            public void onMessage(String message, Session session) {
                System.out.println("客户端发送的消息：" + message);
            }
        
            /**
             * 暴露给外部的群发
             *
             * @param message
             * @throws IOException
             */
            public static void sendInfo(String message) throws IOException {
                sendAll(message);
            }
        
            /**
             * 群发
             *
             * @param message
             */
            private static void sendAll(String message) {
                Arrays.asList(webSocketSet.toArray()).forEach(item -> {
                    CustomWebSocket customWebSocket = (CustomWebSocket) item;
                    //群发
                    try {
                        customWebSocket.sendMessage(message);
                    } catch (IOException e) {
                        e.printStackTrace();
                    }
                });
            }
        
            /**
             * 发生错误时调用
             *
             * @param session
             * @param error
             */
            @OnError
            public void onError(Session session, Throwable error) {
                System.out.println("----websocket-------有异常啦");
                error.printStackTrace();
            }
        
            /**
             * 减少在线人数
             */
            private void subOnlineCount() {
                CustomWebSocket.onlineCount--;
            }
        
            /**
             * 添加在线人数
             */
            private void addOnlineCount() {
                CustomWebSocket.onlineCount++;
            }
        
            /**
             * 当前在线人数
             *
             * @return
             */
            public static synchronized int getOnlineCount() {
                return onlineCount;
            }
        
            /**
             * 发送信息
             *
             * @param message
             * @throws IOException
             */
            public void sendMessage(String message) throws IOException {
                //获取session远程基本连接发送文本消息
                this.session.getBasicRemote().sendText(message);
                //this.session.getAsyncRemote().sendText(message);
            }
        }
 *  Main函数中调用发送信息
    
     
    
        CustomWebSocket.sendInfo("Hello,kungfupeng!");

### **Vue文件中与WebSocket交互** ###

*  Script核心
    
     
    
        <script>
          export default {
            data() {
              return {
                msg_data: []
              }
            },
            created() {
              this.initWebSocket()
            },
            destroyed: function () {
              this.websocketclose();
            },
            methods: {
              initWebSocket: function () {
                this.websock = new WebSocket("ws://localhost:8080/kungfupeng/websocket");
                this.websock.onopen = this.websocketonopen;
                this.websock.onerror = this.websocketonerror;
                this.websock.onmessage = this.websocketonmessage;
                this.websock.onclose = this.websocketclose;
              },
              websocketonopen: function () {
                console.log("WebSocket连接成功");
              },
              websocketonerror: function (e) {
                console.log("WebSocket连接发生错误");
              },
              websocketonmessage: function (e) {
                var da = JSON.parse(e.data);
                console.log(da);
                this.msg_data.unshift(da);
              },
              websocketclose: function (e) {
                console.log("connection closed (" + e.code + ")");
              }
            }
          }
        </script>