WebSocket笔记

你的名字 2024-03-17 22:43 64阅读 0赞

#### 1. websocket介绍 ####

WebSocket 是基于 TCP 的一种新的**网络协议**。它实现了浏览器与服务器全双工通信——浏览器和服务器只需要完成一次握手，两者之间就可以创建**持久性**的连接， 并进行**双向**数据传输。

> **HTTP协议和WebSocket协议对比：**
> 
>  *  HTTP是**短连接**
>  *  WebSocket是**长连接**
>  *  HTTP通信是**单向**的，基于请求响应模式
>  *  WebSocket支持**双向**通信
>  *  HTTP和WebSocket底层都是TCP连接

![在这里插入图片描述][01440051ac1e4687ac1e3c1e6d540528.png]

> **WebSocket缺点：**
> 
>  *  服务器长期维护长连接需要一定的成本
>  *  各个浏览器支持程度不一
>  *  WebSocket 是长连接，受网络限制比较大，需要处理好重连

*  应用场景：  
    1). 视频弹幕 2). 网页聊天 3). 股票基金报价实时更新 等等…

#### 2. 简单入门案例 ####

\*\*需求：\*\*实现浏览器与服务器全双工通信。浏览器既可以向服务器发送消息，服务器也可主动向浏览器推送消息。

1.  导入maven坐标

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

1.  客户端-编码前端代码  
    可放在Resource目录下的page目录

<!DOCTYPE HTML>
    <html>
    <head>
        <meta charset="UTF-8">
        <title>WebSocket Demo</title>
    </head>
    <body>
        <input id="text" type="text" />
        <button onclick="send()">发送消息</button>
        <button onclick="closeWebSocket()">关闭连接</button>
        <div id="message">
        </div>
    </body>
    <script type="text/javascript">
        var websocket = null;
        var clientId = Math.random().toString(36).substr(2);
    
        //判断当前浏览器是否支持WebSocket
        if('WebSocket' in window){
          
            //连接WebSocket节点
            websocket = new WebSocket("ws://localhost:8080/ws/"+clientId);
        }
        else{
          
            alert('Not support websocket')
        }
    
        //连接发生错误的回调方法
        websocket.onerror = function(){
          
            setMessageInnerHTML("error");
        };
    
        //连接成功建立的回调方法
        websocket.onopen = function(){
          
            setMessageInnerHTML("连接成功");
        }
    
        //接收到消息的回调方法
        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 send(){
          
            var message = document.getElementById('text').value;
            websocket.send(message);
        }
    	
    	//关闭连接
        function closeWebSocket() {
          
            websocket.close();
        }
    </script>
    </html>

1.  服务端-定义配置类，注册WebSocket的服务端组件

package com.zsx.config;
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.socket.server.standard.ServerEndpointExporter;
    
    /**
     * WebSocket配置类，用于注册WebSocket的Bean
     */	
    @Configuration
    public class WebSocketConfiguration {
        
    
        @Bean
        public ServerEndpointExporter serverEndpointExporter() {
        
            return new ServerEndpointExporter();
        }
    
    }

1.  服务端-定义WebSocket服务端组件

package com.zsx.websocket;
    
    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.PathParam;
    import javax.websocket.server.ServerEndpoint;
    import java.io.IOException;
    import java.util.Collection;
    import java.util.HashMap;
    import java.util.Map;
    
    /**
     * WebSocket服务
     */
    @Component
    @ServerEndpoint("/ws/{sid}")
    public class WebSocketServer {
        
    
        //存放会话对象
        private static  Map<String, Session> sessionMap = new HashMap<>();
    
        /**
         * 连接建立成功调用的方法
         */
        @OnOpen
        public void onOpen(@PathParam("sid") String sid, Session session){
        
            System.out.println("客户端：" + sid + "建立连接");
            sessionMap.put(sid, session);
        }
    
    
        /**
         * 收到客户端消息后调用的方法
         *
         * @param message 客户端发送过来的消息
         */
        @OnMessage
        public void onMessage(@PathParam("sid") String sid, String message){
        
            System.out.println("接收到客户端：" + sid + "发送的消息：" + message);
        }
    
        /**
         * 连接关闭调用的方法
         *
         * @param sid
         */
        @OnClose
        public void opClose(@PathParam("sid") String sid){
        
            System.out.println("客户端：" + sid + "关闭连接");
            sessionMap.remove(sid);
        }
    
        /**
         * 群发
         *
         * @param message
         */
        public void sendToAllClient(String message){
        
            Collection<Session> sessions = sessionMap.values();
            for (Session session : sessions) {
        
                try {
        
                    //服务器向客户端发送消息
                    session.getBasicRemote().sendText(message);
                } catch (IOException e) {
        
                    e.printStackTrace();
                }
            }
        }
    
    }

1.  定义定时任务类，定时向客户端推送数据（模拟服务器主动向客户端发消息）

package com.sky.task;
    
    import com.sky.websocket.WebSocketServer;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.scheduling.annotation.Scheduled;
    import org.springframework.stereotype.Component;
    import java.time.LocalDateTime;
    import java.time.format.DateTimeFormatter;
    
    @Component
    public class WebSocketTask {
        
        @Autowired
        private WebSocketServer webSocketServer;
    
        /**
         * 通过WebSocket每隔5秒向客户端发送消息
         */
        @Scheduled(cron = "0/5 * * * * ?")
        public void sendMessageToClient() {
        
            webSocketServer.sendToAllClient("这是来自服务端的消息：" + DateTimeFormatter.ofPattern("HH:mm:ss").format(LocalDateTime.now()));
        }
    }

1.  资源文件映射-这个主要是为了能直接在浏览器打开上面的websocket.html网页（http://localhost:8081/page/websocket.html）

package com.zsx.config;
    
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
    import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
    
    @Slf4j
    @Configuration
    public class WebMvcConfig extends WebMvcConfigurationSupport {
        
    
        /**
         * 设置静态资源映射
         * @param registry
         */
        @Override
        protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        
            log.info("开始进行静态资源映射..");
            registry.addResourceHandler("/page/**").addResourceLocations("classpath:/page/");
        }
    
    }

启动类

package com.zsx;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.scheduling.annotation.EnableScheduling;
    
    @SpringBootApplication
    @EnableScheduling
    public class WebSocketDemoApplication {
        
    
        public static void main(String[] args) {
        
            SpringApplication.run(WebSocketDemoApplication.class, args);
            System.out.println("项目启动...");
        }
    }

1.  效果测试  
    1）启动服务，打开websocket.html页面  
    ![在这里插入图片描述][c25158eb516c47a4ab7cffebf52ca471.png]  
    2）服务端接收到消息  
    ![在这里插入图片描述][df0ed396265b41fb958d60851d0e468f.png]

> 进一步了解的案例可参考 [https://gitee.com/zhou-shaoxiong/Spring-websocket/blob/master/pom.xml][https_gitee.com_zhou-shaoxiong_Spring-websocket_blob_master_pom.xml]

[01440051ac1e4687ac1e3c1e6d540528.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/272875f6ee4c468ab6848c7193bc78a8.png
[c25158eb516c47a4ab7cffebf52ca471.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/426161cdd5314af49791acdf501d3ade.png
[df0ed396265b41fb958d60851d0e468f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/5c16ef91a8114f9d8df4637729251f90.png
[https_gitee.com_zhou-shaoxiong_Spring-websocket_blob_master_pom.xml]: https://gitee.com/zhou-shaoxiong/Spring-websocket/blob/master/pom.xml