WebSocket的用法——服务器主动给客户端推送数据

2024-06-12 服务器 0

介绍

定义

WebSocket 是基于 TCP 的一种新的网络协议。它实现了浏览器与服务器全双工通信——浏览器和服务器只需要完成一次握手，两者之间就可以创建持久性的连接，并进行双向数据传输。
（注：http1.1开始使用长连接，1.0默认使用短连接）

HTTP协议和WebSocket协议对比

HTTP和WebSocket底层都是TCP连接

HTTP是短连接；HTTP通信是单向的，基于请求响应模式（方向:一定是客户端浏览器主动发请求，服务器才能接受请求并响应）

WebSocket是长连接（长连接不要刷新就能get到数据）；WebSocket支持双向通信（注：首先是客户端浏览器发起请求，也就是握手，以便之后客户端浏览器能主动给服务器发送数据，服务器也能主动给客户端浏览器推送数据）

WebSocket的应用场景

视频弹幕;网页聊天;体育实况更新;股票基金报价实时更新（注：并不需要页面发请求来获取数据，而是服务器主动给客户端推送数据）

步骤

直接使用websocket.html页面作为WebSocket客户端

（每刷新页面，就是new一个新的WebSocket，即握手成功，这个连接就建立好了）

<!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;	//随机id    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>

导入WebSocket的maven坐标

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

导入WebSocket服务端组件WebSocketServer，用于和客户端通信（重要）

（类似SpringMVC的Controller：用于响应客户端浏览器发出的http请求）

package com.sky.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.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(Session session, @PathParam("sid") String sid) {        System.out.println("客户端：" + sid + "建立连接");        sessionMap.put(sid, session);    }    /**     * 收到客户端消息后调用的方法     *     * @param message 客户端发送过来的消息     */    @OnMessage    public void onMessage(String message, @PathParam("sid") String sid) {        System.out.println("收到来自客户端：" + sid + "的信息:" + message);    }    /**     * 连接关闭调用的方法     *     * @param sid     */    @OnClose    public void onClose(@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 (Exception e) {                e.printStackTrace();            }        }    }}

导入配置类WebSocketConfiguration，注册WebSocket的服务端组件

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

导入定时任务类WebSocketTask，定时向客户端推送数据

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;@Componentpublic 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()));    }}