美文网首页
spring boot websocket

spring boot websocket

作者: 技术小白熊 | 来源:发表于2018-10-20 21:32 被阅读52次

    1、对websocket的认识

      实时性、双工通信、走websocket(ws)协议不是HTTP、“拉和推”的概念,股票、石墨文档多方在线协作、智能家居、赛况更新
    

    2、什么是websocket

        WebSocket协议是基于TCP的一种新的网络协议。它实现了浏览器与服务器全双工(full-duplex)通信——允许服务器主动发送信息给客户端。
    
    websocket.png

    3、为什么需要websocket

       我们已经有了 HTTP 协议,为什么还需要另一个协议?它能带来什么好处?
    
    • 答案很简单,因为 HTTP 协议有一个缺陷:通信只能由客户端发起,HTTP 协议做不到服务器主动向客户端推送信息。
      举例来说,我们想要查询当前的排队情况,只能是页面轮询向服务器发出请求,服务器返回查询结果。轮询的效率低,非常浪费资源(因为必须不停连接,或者 HTTP 连接始终打开)。因此WebSocket 就是这样发明的。

    4、SpringBoot2对WebSocket的支持很赞

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

    5、WebSocketConfig

    package com.springboot.websocket.config;
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.socket.server.standard.ServerEndpointExporter;
    
    /**
     * 开启WebSocket支持
     *
     * @author Moqi
     */
    @Configuration
    public class WebSocketConfig {
    
        @Bean
        public ServerEndpointExporter serverEndpointExporter() {
            return new ServerEndpointExporter();
        }
    
    }
    

    6、WebSocketServer

    package com.springboot.websocket.config;
    
    import java.io.IOException;
    import java.util.concurrent.CopyOnWriteArraySet;
    
    import javax.websocket.OnClose;
    import javax.websocket.OnError;
    import javax.websocket.OnMessage;
    import javax.websocket.OnOpen;
    import javax.websocket.Session;
    import javax.websocket.server.PathParam;
    import javax.websocket.server.ServerEndpoint;
    
    import org.springframework.stereotype.Component;
    
    
    @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--;
        }
    }
    

    7、WebSocketController

    package com.springboot.websocket.controller;
    
    import com.springboot.websocket.config.WebSocketServer;
    import org.springframework.web.bind.annotation.*;
    
    import java.io.IOException;
    
    @RestController
    public class WebSocketController {
    
        //推送数据接口    @RequestMapping("/socket/push")
        public String pushMsg(String message) {
            try {
                WebSocketServer.sendInfo(message);
            } catch (IOException e) {
                e.printStackTrace();
            }
            return "success";
        }
    }
    

    8、index.html

    <!DOCTYPE html>
    <html lang="en">
    <head>
        <meta charset="UTF-8">
        <title>WebSocket</title>
    </head>
    <body>
    <h2>WebSocket</h2>
    <script>
        var socket;
        if (typeof(WebSocket) == "undefined") {
            console.log("您的浏览器不支持WebSocket");
        } else {
            console.log("您的浏览器支持WebSocket");
            //实现化WebSocket对象,指定要连接的服务器地址与端口建立连接
            socket = new WebSocket("ws://localhost:8080/websocket");
    
            //打开事件
            socket.onopen = function () {
                console.log("Socket已打开");
                socket.send("这是来自客户端的消息:" + new Date());
            };
    
            //获得消息事件
            socket.onmessage = function (msg) {
                console.log(msg);
                alert(msg);
            };
    
            //关闭事件
            socket.onclose = function () {
                console.log("Socket已关闭");
            };
    
            //发生了错误事件
            socket.onerror = function () {
                alert("Socket发生了错误");
            }
        }
    </script>
    
    </body>
    </html>
    
    截图.png

    相关文章

      网友评论

          本文标题:spring boot websocket

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