WebSocket的介绍和入门案例

雪碧聊技术

于 2024-09-29 16:50:29 发布

阅读量238

点赞数 9

文章标签： websocket 网络协议网络

本文链接：https://blog.csdn.net/qq_63981644/article/details/142636451

版权

1、WebSocket的介绍？

①定义

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

②WebSocket与Http的对比

③WebSocket协议的应用场景

视频弹幕

网页聊天（WebSocket协议最经典的应用）

体育实况更新

股票基金报价实时更新

2、WebSocket协议的入门案例：

需要的资源（下面步骤中，都会提供）：

操作步骤：

①直接使用websocket.html页面作为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;
    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){
        //-:向id名为"message"的div中，写入数据
        document.getElementById('message').innerHTML += innerHTML + '<br/>';
    }

    //-:发送消息
    function send(){
        //-:将id名为test的input输入框的内容，发送出去
        var message = document.getElementById('text').value;
        websocket.send(message);
    }
	
	//-:关闭WebSocket连接
    function closeWebSocket() {
        websocket.close();
    }
</script>
</html>

②导入WebSocket的maven坐标

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

③导入WebSocket服务端组件WebSocketServer，用于和客户端通信（最关键的一步）

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  //-:表明该类需要交给Spring容器管理
@ServerEndpoint("/ws/{sid}") //-:和@controller注解很像，也是根据路径匹配
//-:因为客户端有多个，因此需要给服务器传过来一个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  //-:这就类似于controller方法
    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) {
        //-:拿出sessionMap中的所有的值（每个值都代表服务器和客户端的一个会话）
        Collection<Session> sessions = sessionMap.values();
        //-:遍历每一个会话
        for (Session session : sessions) {
            try {
                //-:服务器向客户端发送消息
                session.getBasicRemote().sendText(message);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }

}

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

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

}

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

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

以上就做好了WebSocket入门案例的准备工作。

⑥下面使用一下这个案例的功能：