WebSocket

作者: A_x_A | 来源:发表于2019-04-18 09:22 被阅读0次

    WebSocket是一种在单个TCP连接上进行全双工通信的协议。WebSocket通信协议于2011年被IETF定为标准RFC 6455,并由RFC7936补充规范。WebSocket API也被W3C定为标准。
    WebSocket使得客户端和服务器之间的数据交换变得更加简单,允许服务端主动向客户端推送数据。在WebSocket API中,浏览器和服务器只需要完成一次握手,两者之间就直接可以创建持久性的连接,并进行双向数据传输

    优点

    • 较少的控制开销。在连接创建后,服务器和客户端之间交换数据时,用于协议控制的数据包头部相对较小。在不包含扩展的情况下,对于服务器到客户端的内容,此头部大小只有2至10字节(和数据包长度有关);对于客户端到服务器的内容,此头部还需要加上额外的4字节的掩码。相对于HTTP请求每次都要携带完整的头部,此项开销显著减少了。

    • 更强的实时性。由于协议是全双工的,所以服务器可以随时主动给客户端下发数据。相对于HTTP请求需要等待客户端发起请求服务端才能响应,延迟明显更少;即使是和Comet等类似的长轮询比较,其也能在短时间内更多次地传递数据。

    • 保持连接状态。与HTTP不同的是,Websocket需要先创建连接,这就使得其成为一种有状态的协议,之后通信时可以省略部分状态信息。而HTTP请求可能需要在每个请求都携带状态信息(如身份认证等)。

    • 更好的二进制支持。Websocket定义了二进制帧,相对HTTP,可以更轻松地处理二进制内容。

    • 可以支持扩展。Websocket定义了扩展,用户可以扩展协议、实现部分自定义的子协议。如部分浏览器支持压缩等。

    • 更好的压缩效果。相对于HTTP压缩,Websocket在适当的扩展支持下,可以沿用之前内容的上下文,在传递类似的数据时,可以显著地提高压缩率。[1]

    握手协议

    WebSocket 是独立的、创建在 TCP 上的协议。
    Websocket 通过 HTTP/1.1 协议的101状态码进行握手。
    为了创建Websocket连接,需要通过浏览器发出请求,之后服务器进行回应,这个过程通常称为“握手”(handshaking)。

    基于 WebSocket 的聊天实践

    • 1、新建模块websocket
    • 2、添加依赖
     <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            <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>
            </dependency>
    
            <dependency>
                <groupId>com.spring4all</groupId>
                <artifactId>swagger-spring-boot-starter</artifactId>
                <version>1.8.0.RELEASE</version>
            </dependency>
    
    • 2、编写配置类(WebSocketConfig)
    package com.springstudy.websocket.config;
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.socket.server.standard.ServerEndpointExporter;
    /**
     * WebSocket的配置类
     * 开启了WebSocket支持
     */
    
    @Configuration
    public class WebSocketConfig {
        @Bean
    
        public ServerEndpointExporter serverEndpointExporter() {
            return new ServerEndpointExporter();
        }
    }
    
    
    • 4、编写客户端向服务器建立WebSocket连接的Server类(WebSocketServer)
    package com.springstudy.websocket.server;
    
    import org.springframework.stereotype.Component;
    
    import javax.websocket.*;
    import javax.websocket.server.ServerEndpoint;
    import java.io.IOException;
    import java.util.concurrent.CopyOnWriteArraySet;
    
    //客户端向服务器端建立WebSocket连接的url
    @ServerEndpoint("/websocket")
    @Component
    public class WebSocketServer {
    
        //静态变量,用来记录当前在线连接数,可选
        private static int onlineCount = 0;
    
        //concurrent包的线程安全Set,用来存放每个客户端对应的MyWebSocket对象,必须
        private static CopyOnWriteArraySet<WebSocketServer> webSocketSet
                = new CopyOnWriteArraySet<WebSocketServer>();
    
        //与某个客户端的连接会话,需要通过它来给客户端发送数据,必须
        private Session session;
    
    
        /**
         * 连接建立成功调用的方法
         */
        @OnOpen
        public void onOpen(Session session) {
            this.session = session;
            webSocketSet.add(this);     //将客户端加入set中
            addOnlineCount();           //在线数加1
            System.out.println("有新窗口开始监听,当前在线人数为"
                    + getOnlineCount());
            try {
                sendMessage("连接成功");
            } catch (IOException e) {
                System.out.println("WebSocket IO异常");
            }
        }
    
        /**
         * 连接关闭调用的方法
         */
        @OnClose
        public void onClose() {
            webSocketSet.remove(this);  //从set中删除
            subOnlineCount();           //在线数减1
            System.out.println("有连接关闭!当前在线人数为" + getOnlineCount());
        }
    
        /**
         * 收到客户端消息后调用的方法
         *
         * @param message 客户端发送过来的消息
         */
        @OnMessage
        public void onMessage(String message, Session session) {
            System.out.println("收到客户端的信息:" + message);
            //群发消息
            for (WebSocketServer item : webSocketSet) {
                try {
                    item.sendMessage(message);
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    
        /**
         * @param session
         * @param error
         */
        @OnError
        public void onError(Session session, Throwable error) {
            System.out.println("发生错误");
            error.printStackTrace();
        }
    
        /**
         * 实现服务器主动推送
         */
        public void sendMessage(String message) throws IOException {
            this.session.getBasicRemote().sendText(message);
        }
    
    
        /**
         * 群发自定义消息
         */
        public static void sendInfo(String message) throws IOException {
            System.out.println("推送消息内容:" + message);
            for (WebSocketServer item : webSocketSet) {
                try {
                    item.sendMessage(message);
                } catch (IOException e) {
                    continue;
                }
            }
        }
    
        public static synchronized int getOnlineCount() {
            return onlineCount;
        }
    
        public static synchronized void addOnlineCount() {
            WebSocketServer.onlineCount++;
        }
    
        public static synchronized void subOnlineCount() {
            WebSocketServer.onlineCount--;
        }
    }
    
    • 5、(WebSocketController)
    package com.springstudy.websocket.controller;
    
    
    import com.springstudy.websocket.server.WebSocketServer;
    import org.springframework.web.bind.annotation.GetMapping;
    
    import org.springframework.web.bind.annotation.RestController;
    
    import java.io.IOException;
    
    @RestController
    public class WebSocketController {
    
        //推送数据接口
        @GetMapping("/socket/push")
        public String pushMsg(String message) {
            try {
    
                WebSocketServer.sendInfo(message);
            } catch (IOException e) {
                e.printStackTrace();
            }
            return "success";
        }
    }
    
    • 6、前端
    <!DOCTYPE html>
    <html>
        <head>
            <meta charset="utf-8" />
            <title>websocket示例</title>
            <script src="https://cdn.jsdelivr.net/npm/vue/dist/vue.js"></script>
        </head>
    <style type="text/css">
        
    </style>
        
        <body>
            <div id="app">
                <div class="top">
                    消息显示
                </div>
                
                <!-- <h3>消息显示</h3> -->
                <ul>
                    <li v-for="(message, index) in messages" :key="index">
                        {{message}}
                    </li>
                </ul>
                <hr>
                <h3>发送消息 </h3>
                <input type="text" v-model="sendMsg" />
                <button type="button" @click="send();showNotification()" >发送</button>
                
            </div>
            
            
            <script type="text/javascript">
                var socket;
                var app = new Vue({
                    el: '#app',
                    data: {
                        messages: [],
                        sendMsg: ''
                    },
                    created: function() {
                        var _this = this;
                        //创建WebSocket对象,指定要连接的服务器地址和端口,建立连接
                        socket = new WebSocket("ws://192.168.43.39:8080/websocket");
                            
                        //打开连接
                        socket.onopen = function() {
                            console.log("Socket已打开");
    
                        };
                        //获得服务端推送的消息
                        socket.onmessage = function(msg) {
                            console.log(msg.data);
                            _this.messages.push(msg.data);
                            console.log(_this.messages);
                        };
                        //关闭连接
                        socket.onclose = function() {
                            console.log("Socket已关闭");
                        };
                        //发送错误
                        socket.onerror = function() {
                            alert("Socket发生了错误");
                        }
                    },
                    watch: {
                        // 如果 `messages` 发生改变,这个函数就会运行
                        messages: function(newMsg, oldMsg) {
                            var n = new Notification('Title',{
                                body :newMsg[newMsg.length - 1]
                            });
    
                        },
                    },
                    methods: {
                        send: function() {
                            socket.send(this.sendMsg);
                        },
                        /* showNotification:function() {
                            window.Notification.permission = "granted";                     
                            if (window.Notification) {
                                if (window.Notification.permission == "granted") {
                                    var notification = new Notification('您有一条新消息通知!', {
                                        body: this.sendMsg,
                                        icon: "图标路径,若不指定默认为favicon"
                                    });
                                    setTimeout(function() {
                                        notification.close();
                                    }, 5000);
                                } else {
                                    window.Notification.requestPermission();
                                }
                            } else alert('你的浏览器不支持此消息提示功能,请使用chrome内核的浏览器!');
                        } */
                    }
                })
            </script>
        </body>
    </html>
    
    
    • 运行结果
      后端启动服务器,前端运行,点击发送可以实现基本WebSocket功能:


      WebSocket前端.png
      WebSocket后台.png

    相关文章

      网友评论

          本文标题:WebSocket

          本文链接:https://www.haomeiwen.com/subject/jznawqtx.html