webSocket

最新推荐文章于 2022-08-29 11:56:21 发布

草原人毅哥

最新推荐文章于 2022-08-29 11:56:21 发布

阅读量183

点赞数

分类专栏： java 文章标签： webSocket 长连接

本文链接：https://blog.csdn.net/weixin_42160856/article/details/96901773

版权

java 专栏收录该内容

3 篇文章 0 订阅

订阅专栏

WebScoket

什么是webSocket
是一种在单个TCP连接上进行全双工通信的协议。即浏览器和服务器之间建立一个不受限的双向通信的通道
优点
较少的控制开销，更强的实时性，保持连接状态，更好的二进制支持，可以支持扩展，更好的压缩效果

示例

<!-- 本人使用版本 2.1.5 -->
		<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
        </dependency>

添加config

@Configuration
//此类在启动类包结构内
public class WebSocketConfig {
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

添加WebSocketServer

@ServerEndpoint("/websocket/{sid}")
@Component
public class WebSocketServer {

    static Log log= LogFactory.getLog(WebSocketServer.class);
    //记录当前在线连接数
    private static int onlineCount = 0;
    //存放每个客户端对应的MyWebSocket对象。
    private static CopyOnWriteArraySet<WebSocketServer> webSocketSet 
            = new CopyOnWriteArraySet<WebSocketServer>();
    //给客户端发送数据
    private Session session;
    //接收sid
    private String sid="";
    
    /**
     * 连接建立成功调用的方法
     */
    @OnOpen
    public void onOpen(Session session,@PathParam("sid") String sid) {
        this.session = session;
        webSocketSet.add(this);
        addOnlineCount(); //在线数加1
        log.info("有新窗口开始监听:"+sid+",当前在线人数为" + getOnlineCount());
        this.sid=sid;
        try {
            sendMessage("连接成功");
        } catch (IOException e) {
            log.error("websocket IO异常");
        }
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose() {
        webSocketSet.remove(this);
        subOnlineCount();//在线数减1
        log.info("有一连接关闭！当前在线人数为" + getOnlineCount());
    }

    /**
     * 收到客户端消息后调用的方法
     * @param message 客户端发送过来的消息
     */
    @OnMessage
    public void onMessage(String message, Session session) {
        log.info("收到来自窗口"+sid+"的信息:"+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) {
        log.error("发生错误");
        error.printStackTrace();
    }
    /**
     * 实现服务器主动推送
     */
    public void sendMessage(String message) throws IOException {
        this.session.getBasicRemote().sendText(message);
    }

    /**
     * 群发自定义消息，用于后台主动发送消息用
     */
    public static void sendInfo(String message,@PathParam("sid") String sid) throws IOException {
        log.info("推送消息到窗口"+sid+"，推送内容:"+message);
        for (WebSocketServer item : webSocketSet) {
            try {
                //这里可以设定只推送给这个sid的，为null则全部推送
                if(sid==null) {
                    item.sendMessage(message);
                }else if(item.sid.equals(sid)){
                    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--;
    }
}

通过接口发送消息

@Controller
public class PushController {
	//需要sid为null(为null时给所有发送,指定sid则给指定的发送),换一种传参方式即可
    @RequestMapping("/push/{sid}/{msg}")
    @ResponseBody
    public String send(@PathVariable String sid,@PathVariable String msg) throws IOException {
        WebSocketServer.sendInfo(msg, sid);
        return "消息发送成功";
    }
}

index.html

<!DOCTYPE HTML>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>WebSocket</title>
</head>
<body>
开始测试<br/>
<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;

    //判断当前浏览器是否支持WebSocket
    if ('WebSocket' in window) {
    //sid相当于webSocket的名字吧，个人理解
        websocket = new WebSocket("ws://localhost:19000/websocket/sid");
    } else {
        alert('Not support websocket')
    }

    //连接发生错误的回调方法
    websocket.onerror = function () {
        setMessageInnerHTML("error");
    };

    //连接成功建立的回调方法
    websocket.onopen = function (event) {
        setMessageInnerHTML(event.data);
    }

    //接收到消息的回调方法
    websocket.onmessage = function (event) {
        setMessageInnerHTML(event.data);
    }

    //连接关闭的回调方法
    websocket.onclose = function () {
        setMessageInnerHTML("close Web Socket");
    }

    //监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
    window.onbeforeunload = function () {
        websocket.close();
    }

    //将消息显示在网页上
    function setMessageInnerHTML(innerHTML) {
        if(undefined != innerHTML){
            document.getElementById('message').innerHTML += innerHTML + '<br/>';
        }
    }

    //关闭连接
    function closeWebSocket() {
        websocket.close();
    }

    //发送消息
    function send() {
        var message = document.getElementById('text').value;
        websocket.send(message);
    }

</script>
</html>

访问测试

访问：http://127.0.0.1:19000/index.html
发送消息
访问后台接口发送消息
打开另一个窗口访问：http://127.0.0.1:19000/push/sid/发送的消息
此sid跟 websocket = new WebSocket(“ws://localhost:19000/websocket/sid”)中的sit

发送完，查看index窗口，显示发送消息

草原人毅哥

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
webSocket

WebScoket什么是webSocket是一种在单个TCP连接上进行全双工通信的协议。即浏览器和服务器之间建立一个不受限的双向通信的通道优点较少的控制开销，更强的实时性，保持连接状态，更好的二进制支持，可以支持扩展，更好的压缩效果...
复制链接

扫一扫