SpringBoot系列之搭建WebSocket应用

news2024/10/23 2:39:30

SpringBoot系列之@ServerEndpoint方式开发WebSocket应用。在实时的数据推送方面，经常会使用WebSocket或者MQTT来实现，WebSocket是一种不错的方案，只需要建立连接，服务端和客户端就可以进行双向的数据通信。很多网站的客户聊天，也经常使用WebSocket技术来实现。

WebSocket简介

WebSocket是一种建立在TCP协议上的一种网络协议，与Http协议类似，端口都是80或者443，协议标识符是ws、如果是加密安全的就是wss，这个和http/https有点类似。WebSocket 连接以 HTTP 请求/响应握手开始，连接成功后，客户端可以向服务端发送消息，反之亦可，WebSocket协议支持二进制数据和文本字符串的传输。因为客户端和服务端之间只有一条TCP通信连接，以后所有的请求都使用这条连接，所以Websocket也是属于长连接。下面给出WebSocket通讯示意图：

在这里插入图片描述

WebSocket官网给出的HTTP和WebSocket的对比图：https://websocket.org/guides/road-to-websockets

在这里插入图片描述

实验环境准备

  • JDK 1.8
  • SpringBoot 3.3.0
  • Maven 3.3.9
  • 开发工具
    • IntelliJ IDEA
    • smartGit

新建WebSocket项目

在idea里新建一个module，选择Spring Initializr项目，默认选择Spring官网的https://start.spring.io
在这里插入图片描述
选择需要的依赖，这里可以选择Springboot集成的WebSocket starter
在这里插入图片描述
生成项目后，检查一下对应Maven配置文件中是否有加上spring-boot-starter-websocket

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

如果不是Springboot项目，加入spring-websocket即可

 <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-websocket</artifactId>
      <version>5.2.1.RELEASE</version>
      <scope>compile</scope>
  </dependency>

创建ServerEndpoint

创建一个Websocket的ServerEndpoint类，这个类是为了创建一个WebSocket服务端，这个类使用线程安全的CopyOnWriteArrayList集合来存储所有的WebSocket对象，再自定义一个socketClientCode，目的是为了客户端只和对应的服务端通信，客户端建立连接会进入onOpen方法，发送消息会调用onMessage方法

package com.example.springboot.websocket.message;

import cn.hutool.core.util.StrUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArrayList;


@ServerEndpoint("/ws/webSocketServer")
@Component
@Slf4j
public class WebSocket {

    private static final String PREFIX = "socketClient=";

    private String socketClientCode;

    private static CopyOnWriteArrayList<WebSocket> webSocketSet = new CopyOnWriteArrayList<>();

    private Session session ;

    @OnOpen
    public void onOpen(Session session) {
        this.session = session;
        webSocketSet.add(this);
        log.info("open a webSocket {}, online num: {}",getSocketClientCode(), getOnlineNum());
    }

    @OnClose
    public void onClose() {
        webSocketSet.remove(this);
        log.error("close a webSocket {}, online num:{}", getSocketClientCode(), getOnlineNum());
        printOnlineClientCode();
    }

    @OnError
    public void onError(Session session, Throwable error) {
        webSocketSet.remove(this);
        log.error("webSocket error {}, {}, online num:{}", error, getSocketClientCode(), getOnlineNum());
        printOnlineClientCode();
    }

    @OnMessage
    public void onMessage(String message, Session session) {
        log.info("receive message from client:{}", message);
        // 业务实现
        if (message.startsWith(PREFIX)) {
            String socketClientCode = message.substring(PREFIX.length());
            this.setSocketClientCode(socketClientCode);
            sendMessage(message);
            printOnlineClientCode();
        } else {
            sendMessage(message);
        }
    }

    /**
     * 发送消息
     *
     * @Date 2024/06/19 16:36
     * @Param [message]
     * @return void
     */
    public void sendMessage(String message) {
        if (!this.session.isOpen()) {
            log.warn("webSocket is close");
            return;
        }
        try {
            this.session.getBasicRemote().sendText(message);
        } catch (IOException e) {
            log.error("sendMessage exception:{}", e);
        }
    }

    /**
     * 给客户端发送消息
     *
     * @Date 2024/06/19 16:37
     * @Param [message, socketClientCode]
     * @return void
     */
    public void sendMessageToClient(String message, String socketClientCode) {
        log.info("send message to client, message:{}, clientCode:{}", message, socketClientCode);

        printOnlineClientCode();

        webSocketSet.stream().forEach(ws -> {
            if (StrUtil.isNotBlank(socketClientCode) && StrUtil.isNotBlank(ws.getSocketClientCode()) && ws.getSocketClientCode().equals(socketClientCode)) {
                ws.sendMessage(message);
            }
        });
    }

    /**
     * 群发消息
     *
     * @Date 2024/06/19 16:37
     * @Param [message]
     * @return void
     */
    public void fanoutMessage(String message) {
        webSocketSet.forEach(ws -> {
            ws.sendMessage(message);
        });
    }

    private static synchronized int getOnlineNum() {
        return webSocketSet.size();
    }

    private void printOnlineClientCode() {
        webSocketSet.stream().forEach(ws -> {
            log.info("webSocket online:{}", ws.getSocketClientCode());
        });
    }

    public String getSocketClientCode() {
        return socketClientCode;
    }

    public void setSocketClientCode(String socketClientCode) {
        this.socketClientCode = socketClientCode;
    }
}

加上ServerEndpointExporter

在Springboot项目中为了能扫描到所有的ServerEndpoint，需要注入一个ServerEndpointExporter，这个类能扫描项目里所有的ServerEndpoint类，不加的话，客户端会一直连不上服务端

package com.example.springboot.websocket.configuration;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

@Configuration
public class WebSocketConfiguration {

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

}

启动SpringBoot项目，一个WebSocket服务端就建立好了。网上找一个websocket测试网站，https://www.wetools.com/websocket，测试一下服务是否正常，如图：

在这里插入图片描述

前端WebSocket客户端

写一个WebSocket调用的客户端，启动服务器，换一下WebSocket的地址，ws://127.0.0.1:8080/ws/webSocketServer，如果是https的，就换成wss://127.0.0.1:8080/ws/webSocketServer

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>webSocket</title>
    <style type="text/css">
    </style>
</head>
<body>
<h1>WebSocket Demo</h1>
<input type="button" onclick="websocket.send('666666')" value="点我发消息"/>
</body>
<script type="application/javascript">
    var websocket = {
        send: function (str) {
        }
    };
    window.onload = function () {
        if (!'WebSocket' in window) return;
        webSocketInit();
    };
    function webSocketInit() {
        websocket = new WebSocket("ws://127.0.0.1:8080/ws/webSocketServer");
        //建立连接
        websocket.onopen = function () {
            websocket.send("socketClient=666");
            console.log("成功连接到服务器");
        };
        //接收到消息
        websocket.onmessage = function (event) {
            console.log(event.data);
        };
        //连接发生错误
        websocket.onerror = function () {
            alert("WebSocket连接发生错误");
        };
        //连接关闭
        websocket.onclose = function () {
            alert("WebSocket连接关闭");
        };
        //监听窗口关闭
        window.onbeforeunload = function () {
            websocket.close()
        };
    }
</script>
</html>

走一个，在浏览器按F12，看看日志

在这里插入图片描述

后端的日志打印：

在这里插入图片描述

服务端给客户端发送消息

给客户端发送消息，为了只给对应的客户端发送消息，这里加上一个校验，只给注册的客户端发送

/**
     * 给客户端发送消息
     *
     * @Date 2024/06/19 16:37
     * @Param [message, socketClientCode]
     * @return void
     */
public void sendMessageToClient(String message, String socketClientCode) {
    log.info("send message to client, message:{}, clientCode:{}", message, socketClientCode);

    printOnlineClientCode();

    webSocketSet.stream().forEach(ws -> {
        if (StrUtil.isNotBlank(socketClientCode) && StrUtil.isNotBlank(ws.getSocketClientCode()) && ws.getSocketClientCode().equals(socketClientCode)) {
            ws.sendMessage(message);
        }
    });
}

写一个API接口：

package com.example.springboot.websocket.rest;

import cn.hutool.json.JSONUtil;
import com.example.springboot.websocket.dto.WebSocketDto;
import com.example.springboot.websocket.message.WebSocket;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.web.bind.annotation.*;

import javax.annotation.Resource;

@RestController
@RequestMapping("/api")
@Slf4j
public class WebSocketApiController {

    @Resource
    @Qualifier("webSocket")
    private WebSocket webSocket;

    @PostMapping
    @RequestMapping("/sendMessage")
    public ResultBean<Boolean> sendMessage(@RequestBody WebSocketDto sendDto) {
        log.info("webSocket发送消息给客户端:{}", JSONUtil.toJsonStr(sendDto));
        try {
            webSocket.sendMessageToClient(sendDto.getMessage(), sendDto.getSocketClient());
            return ResultBean.ok(true);
        } catch (Exception e) {
            log.error("发送WebSocket消息异常:{}", e);
            return ResultBean.badRequest("发送WebSocket消息异常", false);
        }
    }

}

在这里插入图片描述

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1844333.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

【02】区块链技术应用

【02】区块链技术应用

区块链在金融、能源、医疗、贸易、支付结算、证券等众多领域有着广泛的应用&#xff0c;但是金融依旧是区块链最大且最为重要的应用领域。 1. 区块链技术在金融领域的应用 1.2 概况 自2019年以来&#xff0c;国家互联网信息办公室已发布八批境内区块链信息服务案例清单&#…
阅读更多...
6月20日（周四）A股行情总结：A股险守3000点，恒生科技指数跌1.6%

6月20日（周四）A股行情总结：A股险守3000点，恒生科技指数跌1.6%

A股三大股指走弱&#xff0c;科创板逆势上扬&#xff0c;半导体板块走强&#xff0c;多股20CM涨停。中芯国际港股涨超1%。恒生科技指数跌超1%。离岸人民币对美元汇率小幅走低&#xff0c;20日盘中最低跌至7.2874&#xff0c;创下2023年11月中旬以来的新低&#xff0c;随后收复部…
阅读更多...
用Selenium自动化Web应用测试！

用Selenium自动化Web应用测试！

在开发和维护Web应用时&#xff0c;测试是确保应用正常运行的关键环节。手动测试不仅费时费力&#xff0c;而且容易出错。而通过使用Selenium&#xff0c;程序员可以轻松模拟用户交互、验证页面元素&#xff0c;从而自动化测试过程&#xff0c;提升测试效率和准确性。 解决的问…
阅读更多...
[leetcode hot 150]第十一题，盛水最多的容器

[leetcode hot 150]第十一题，盛水最多的容器

题目&#xff1a; 给定一个长度为 n 的整数数组 height 。有 n 条垂线&#xff0c;第 i 条线的两个端点是 (i, 0) 和 (i, height[i]) 。 找出其中的两条线&#xff0c;使得它们与 x 轴共同构成的容器可以容纳最多的水。 返回容器可以储存的最大水量。 说明&#xff1a;你不能倾…
阅读更多...
抖音a_bogus,mstoken全参数爬虫逆向补环境2024-06-15最新版

抖音a_bogus,mstoken全参数爬虫逆向补环境2024-06-15最新版

抖音a_bogus,mstoken全参数爬虫逆向补环境2024-06-15最新版 接口及参数 打开网页版抖音&#xff0c;右键视频进入详情页。F12打开控制台筛选detail&#xff0c;然后刷新网页&#xff0c;找到请求。可以发现我们本次的参数目标a_bogus。a_bogus有时长度为168有时为172&#xf…
阅读更多...
数据模型——饮食记录

数据模型——饮食记录

数据模型——饮食记录 本次实验完成饮食记录的数据模型&#xff0c;如下图所示 该饮食记录模型与上次的记录项数据模式定义处理方式相同&#xff0c;我们首先分析其数据结构&#xff0c;我们发现首先有早餐、午餐、晚餐等记录类型数据模型&#xff0c;其包括了id、类型名称、类…
阅读更多...
处理文本内容的命令和正则表达式

处理文本内容的命令和正则表达式

处理文本内容的命令 正则表达式匹配的是文本内容&#xff0c;linux的文本三剑客 都是针对文本内容 文本三剑客&#xff1a; grep 过滤文本内容 sed 针对文本内容进行增删改查 awk 按行取列 文本三剑客都是按行进行匹配。 grep grep的作用就是使用正则表达式来匹配文本内…
阅读更多...
档案数字化建设要点

档案数字化建设要点

目前&#xff0c;档案信息数字化的现状是档案标准化、规范化滞后和应用软件多乱&#xff0c;这些都严重影响了系统整体水平的提高。档案信息自动化的内涵包括档案工作的各个方面和各个环节&#xff0c;其中首要的是档案业务要规范&#xff0c;档案标准要建立健全和真正实施。档…
阅读更多...
【Python高级编程】Pickle实现AI算法训练的权重数据的保存

【Python高级编程】Pickle实现AI算法训练的权重数据的保存

任务描述 代码实现 import pickle import time import os import numpy as np# 模拟耗时的权重计算过程 def calculate_weights():print("开始计算权重...")time.sleep(5) # 模拟耗时操作&#xff0c;暂停5秒以模拟计算过程weights np.random.rand(10, 10) # 随机…
阅读更多...
RealityCheck™电机监测和预测性维护模型

RealityCheck™电机监测和预测性维护模型

RealityCheck™电机 一个附加的软件工具箱&#xff0c;可实现条件监测和预测性维护功能&#xff0c;而无需依赖额外的传感器。相反&#xff0c;它使用来自电机控制过程的电子信息作为振动和其他传感器的代理。凭借其先进的信号处理和机器学习(ML)模型&#xff0c;RealityCheck …
阅读更多...
[AIGC] 使用Google的Guava库中的Lists工具类：常见用法详解

[AIGC] 使用Google的Guava库中的Lists工具类：常见用法详解

在Java程序设计中&#xff0c;集合是我们最常用的数据结构之一。为了方便我们操作集合&#xff0c;Google的Guava库提供了一个名为Lists的工具类&#xff0c;它封装了许多用于操作List对象的实用方法。在本文中&#xff0c;我们将详细介绍其常见的用法&#xff0c;以帮助您更好…
阅读更多...
S级猫主食冻干测评出来了：希喂、K9、朗诺实测分享

S级猫主食冻干测评出来了：希喂、K9、朗诺实测分享

对于许多宠物主人来说&#xff0c;一到挑选主食冻干就头疼。尽管主食冻干为猫咪带来的益处远超过普通猫粮&#xff0c;但其价格也相对较高。因此&#xff0c;许多宠物主人担心高价购买的主食冻干营养价值并不高。实际上&#xff0c;除了营养&#xff0c;安全性和配方也是选购时…
阅读更多...
【课程系列04】某客时间AI大模型应用开发实战营

【课程系列04】某客时间AI大模型应用开发实战营

网盘链接 https://pan.baidu.com/s/1blR1eIMDIIp6AbxU4YaK9w 课程收获 "AI大模型应用开发实战营"是一个为期八周的在线课程&#xff0c;旨在教授学员如何开发和应用AI大模型。课程内容从基础理论到实际应用&#xff0c;逐步深入&#xff0c;覆盖了以下要点&#x…
阅读更多...
推荐一个大佬们都在用的IDE主题-Dracula Theme

推荐一个大佬们都在用的IDE主题-Dracula Theme

Dracula主题 对于颜色的主题&#xff0c;每个人的喜欢都有所区别&#xff0c;我喜欢Dracula主题&#xff0c;基本IDE编辑器能配置的都会配置这个主题颜色。然后偶然有一天我发现这个网站&#xff1a;https://draculatheme.com/。才发现Dracula不再仅仅只是个主题了&#xff0c…
阅读更多...
有了它，再也不用为客户管理而烦恼

有了它，再也不用为客户管理而烦恼

在竞争激烈的市场环境中&#xff0c;有效的客户关系管理&#xff08;CRM&#xff09;系统是企业获取商机、提高成单效率的关键。搭贝CRM管理系统是基于市场业务需求量身定制的&#xff0c;通过记录客户360度画像和跟进信息&#xff0c;实现客户管理的精细化和高效流转。 &#…
阅读更多...
Linux:文件描述符

Linux:文件描述符

文件描述符实际上就是一个小整数 0 & 1 & 2 Linux进程默认情况下会有3个缺省打开的文件描述符&#xff0c;分别是标准输入0&#xff0c; 标准输出1&#xff0c; 标准错误2. 0,1,2对应的物理设备一般是&#xff1a;键盘&#xff0c;显示器&#xff0c;显示器 所以输入输…
阅读更多...
为电脑小白推荐的5款实用工具软件

为电脑小白推荐的5款实用工具软件

​ 电脑上的各类软件有很多&#xff0c;除了那些常见的大众化软件&#xff0c;还有很多不为人知的小众软件&#xff0c;专注于实用功能&#xff0c;简洁干净、功能强悍。 1.磁盘空间分析——TreeSize Free ​ TreeSize Free是一款免费的磁盘空间分析工具&#xff0c;能够扫描…
阅读更多...
深度学习模型训练中 学习率参数 设置大小问题及设置合适值

深度学习模型训练中 学习率参数 设置大小问题及设置合适值

&#x1f4aa; 专业从事且热爱图像处理&#xff0c;图像处理专栏更新如下&#x1f447;&#xff1a; &#x1f4dd;《图像去噪》 &#x1f4dd;《超分辨率重建》 &#x1f4dd;《语义分割》 &#x1f4dd;《风格迁移》 &#x1f4dd;《目标检测》 &#x1f4dd;《暗光增强》 &a…
阅读更多...
对30年国债利率破2.5%的复盘反思

对30年国债利率破2.5%的复盘反思

短期看&#xff0c;以月为维度&#xff0c;长端和超长端利率依然具有较强的向下突破的惯性&#xff1b;中期看&#xff0c;以季为维度&#xff0c;长端依然面临向下赔率不足的约束&#xff0c;但调整需要多重利空共振的契机。 短期看多&#xff0c;逢高配置”的四点逻辑 逻辑一…
阅读更多...
SpringBoot：SpringBoot集成Druid监控慢SQL

SpringBoot：SpringBoot集成Druid监控慢SQL

一、前言 数据库连接池是一个至关重要的组成部分&#xff0c;一个优秀的数据库连接池可以显著提高应用程序的性能和可伸缩性。常见的连接池&#xff1a;Druid、HikariCP、C3P0、DBCP等等&#xff0c;不过目前大部分都是使用Druid或者SpringBoot默认的HikariCP&#xff01; 本文…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023