WebSocket使用

木四水266

已于 2024-06-26 23:31:51 修改

阅读量892

点赞数 23

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

于 2024-06-26 16:52:06 首次发布

本文链接：https://blog.csdn.net/qq_63145239/article/details/139992601

版权

WebSocket使用

文章目录

WebSocket使用
前言
一、WebSocket
二、使用步骤

前言

想要实现浏览器和服务器相互发消息，使用WebSocket

一、WebSocket

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

HTTP协议和WebSocket协议对比：

HTTP是短连接
WebSocket是长连接
HTTP通信是单向的，基于请求响应模式
WebSocket支持双向通信
HTTP和WebSocket底层都是TCP连接

WebSocket应用场景：

需要实时更新的场景
视频聊天

二、使用步骤

1). 页面等作为WebSocket客户端

2). 后端导入WebSocket的maven坐标

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-websocket</artifactId>
	# 版本是Springboot start控制的
</dependency>

3). 配置 WebSocket 端点，用于和客户端通信
创建一个类，并使用 @ServerEndpoint 注解来标识这是一个 WebSocket 端点

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

}

4). 创建配置类WebSocketConfiguration，配置 ServerEndpointExporter，注册WebSocket的服务端组件

在配置类中添加 @Bean 注解的方法来创建 ServerEndpointExporter 对象

ServerEndpointExporter的主要作用是自动注册使用@ServerEndpoint注解声明的 WebSocket 端点。在 Spring Boot 中，通过将ServerEndpointExporter配置为一个 Bean，Spring 会扫描项目中使用@ServerEndpoint注解声明的类，并将其注册为 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
 */
@Configuration
public class WebSocketConfiguration {

    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }

}

5).配置 WebSocket 相关属性
在 Spring Boot 中，可以通过配置文件（如application.properties或application.yml）来配置 WebSocket 的相关属性。以下是一些常见的配置属性：

server.port：指定 WebSocket 服务器的端口号。
spring.websocket.path：指定 WebSocket 的路径。
spring.websocket.message-size-limit：设置消息的大小限制。

具体的配置属性可能因项目需求和使用的 WebSocket 库而有所不同。你可以根据实际情况进行相应的配置。

5). 前端连接
在前端使用 WebSocket API 来连接到后端定义的端点。
前端WebSocket一些APi

<!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){
        document.getElementById('message').innerHTML += innerHTML + '<br/>';
    }

    //发送消息
    function send(){
        var message = document.getElementById('text').value;
        websocket.send(message);
    }
	
	//关闭连接
    function closeWebSocket() {
        websocket.close();
    }
</script>
</html>