Spring Boot WebSocket

亦凉 2024-02-19 17:48 50阅读 0赞

#### Spring Boot WebSocket ####

*   *  1.导入依赖
     *  2.配置java端websocket
     *  3.配置一个websocket连接处理行为

### 1.导入依赖 ###

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

### 2.配置java端websocket ###

@Configuration // 配置类
    public class WebSocketConfig{
        
    
    	/**
    	* 要注册ServerEndpointExporter 类实例，开启@ServerEndpoint 注解
    	**/
     	@Bean
        public ServerEndpointExporter serverEndpointExporter() {
        
            return new ServerEndpointExporter();
        }
    }

### 3.配置一个websocket连接处理行为 ###

可以websocket中前端连接到后台理解成 http请求连接，只不过不会断开。  
那么新建一个Controller来设置请求信息:

// 这个类用来处理 /user 连接
    @Controller
    @ServerEndpoint(value = "/user")
    public class UserMsgController {
        
    }

websocket可以分为多个状态，分别是：socket被打开（连接上一个socket时）的状态是**onOpen**，接收到另一端消息的状态是**onMessage**，连接出现异常的状态是**onMessage**，连接关闭的状态是**onClose**，只要在连接中，相互连接的两端都能发送消息通信。

为上述socket配置状态：

@Controller
    @ServerEndpoint(value = "/user")
    public class UserMsgController {
        
    
        /**
         * @OnOpen 标记的方法就是 连接被创建时要执行的方法
         * @param session 每一个连接对应一个session
         */
        @OnOpen
        public void onOpen( Session session) {
        
            System.out.println(" session id 为" + session.getId() + " 已连接...");
        }
    
        /**
         * @Onmessage 用来接收消息，对应的方法必须有一个String 参数，作为接收消息的载体
         * @param msg 消息
         * @param session 连接session信息
         */
        @OnMessage
        public void onMessage( String msg, Session session) {
        
            System.out.println("接收到session id为" + session.getId() + "发送的消息：" + msg);
        }
    
        /**
         * 连接发生异常时调用的方法 该方法参数必须有一个Throwable参数
         * @param session
         * @param t
         */
        @OnError
        public void onError(Session session, Throwable t) {
        
            System.out.println("连接" + session.getId() + "发生异常，异常信息是：" + t.getMessage());
        }
    
        /**
         * 连接关闭时调用的方法
         * @param session
         */
        @OnClose
        public void onClose(Session session) {
        
            System.out.println("连接" + session.getId() + "已关闭");
        }
    
    
    }

在js中调用websocket：

// 创建一个socket连接
    let webSocket = new WebSocket("ws://localhost:8080/user");
    // 为连接定义回调
    // 创建连接的回调
    webSocket.onopen = function(e) {
        
    
    }
    // 接收到消息的回调
    webSocket.onmessage = function(e) {
        
    
    }
    // 发生异常回调
    webSocket.onerror = function(e) {
        
    
    }
    // 关闭连接回调
    webSocket.onclose = function(e) {
        
    
    }
    // 如果要发送消息
    webSocket.send("msg");
    // 关闭socket连接
    webSocket.close();