Springboot 集成 WebSocket

已于 2023-10-18 15:55:18 修改
阅读量632 收藏 1
点赞数 1
分类专栏： SpringBoot 文章标签： spring boot websocket 后端
于 2023-10-16 18:13:11 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_34253002/article/details/133807170
版权

WebSocket是一种在单个TCP连接上进行全双工通信的协议。WebSocket使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。在WebSocket API中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。

1.添加依赖包

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

2.添加WebSocket配置

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

@Configuration
public class WebSocketConfig {

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

}

3.编写web服务端

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CopyOnWriteArraySet;

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

    /**
     * 客户端的连接会话，需要通过它来给客户端发送数据
     */
    private Session session;

    /**
     * 客户端id
     */
    private String clientId;

    /**
     * 用来存放每个客户端对应的MyWebSocket对象
     */
    private static CopyOnWriteArraySet<WebSocketServer> webSockets = new CopyOnWriteArraySet<>();

    /**
     * 用来存在线连接用户信息
     */
    private static ConcurrentHashMap<String, Session> sessionPool = new ConcurrentHashMap<String, Session>();

    /**
     * 链接成功调用的方法
     */
    @OnOpen
    public void onOpen(Session session, @PathParam(value = "clientId") String clientId) {
        try {
            this.session = session;
            this.clientId = clientId;
            webSockets.add(this);
            sessionPool.put(clientId, session);
            log.info("【websocket消息】有新的连接 clientId:{}，总数为:{}", clientId, webSockets.size());
        } catch (Exception e) {
            log.info("【websocket消息】有新的连接构建失败 clientId:{}，总数为:{}，error:", clientId, webSockets.size(), e);
        }
    }

    /**
     * 链接关闭调用的方法
     */
    @OnClose
    public void onClose() {
        try {
            webSockets.remove(this);
            sessionPool.remove(this.clientId);
            log.info("【websocket消息】连接断开 clientId:{}，总数为:{}", this.clientId, webSockets.size());
        } catch (Exception e) {
            log.info("【websocket消息】连接断开失败 clientId:{}，总数为:{}，error:", clientId, webSockets.size(), e);
        }
    }

    /**
     * 收到客户端消息后调用的方法
     */
    @OnMessage
    public void onMessage(String message) {
        log.info("【websocket消息】收到客户端消息:{}", message);
    }

    /**
     * 发送错误时的处理
     *
     * @param session
     * @param error
     */
    @OnError
    public void onError(Session session, Throwable error) {
        log.error("【websocket消息】发生错误，原因:", error);
    }

    /**
     * 此为广播消息
     */
    public void sendBroadcastMessage(String message) {
        log.info("【websocket消息】广播消息:{}", message);
        for (WebSocketServer webSocket : webSockets) {
            try {
                if (webSocket.session.isOpen()) {
                    webSocket.session.getAsyncRemote().sendText(message);
                }
            } catch (Exception e) {
                log.error("【websocket消息】广播消息异常，消息:{}，error:", message, e);
            }
        }
    }

    /**
     * 此为单点消息
     */
    public void sendSinglePointMessage(String targetId, String message) {
        Session session = sessionPool.get(targetId);
        if (session != null && session.isOpen()) {
            try {
                session.getAsyncRemote().sendText(message);
                log.info("【websocket消息】单点消息，targetId:{}，消息:{}", targetId, message);
            } catch (Exception e) {
                log.error("【websocket消息】单点消息异常，targetId:{}，消息:{}，error:", targetId, message, e);
            }
        }
    }

}

4.html测试页面

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>Websocket客户端</title>
</head>
<script src="https://cdn.bootcss.com/jquery/3.3.1/jquery.js"></script>
<script>
    var socket;

    function openSocket() {
        const socketUrl = "ws://localhost:8081/websocket/" + $("#clientId").val();
        console.log(socketUrl);
        if (socket != null) {
            socket.close();
            socket = null;
        }
        socket = new WebSocket(socketUrl);
        // 开启WebSocket连接
        socket.onopen = function () {
            console.log("websocket已开启");
        };
        // 获得消息事件
        socket.onmessage = function (msg) {
            console.log(msg.data);
        };
        // 关闭事件
        socket.onclose = function () {
            console.log("websocket已关闭");
        };
        // 发生了错误事件
        socket.onerror = function () {
            console.log("websocket发生了错误");
        }
    }

    function sendMessage() {
        socket.send('{"targetId":"' + $("#targetId").val() + '","contentText":"' + $("#contentText").val() + '"}');
        console.log('{"targetId":"' + $("#targetId").val() + '","contentText":"' + $("#contentText").val() + '"}');
    }
</script>
<body>

<div>
    客户端身份标识ID
    <input id="clientId" type="text" value="10">
    <button style="color: cornflowerblue"><a onclick="openSocket()">开启WebSocket连接</a></button>
</div>
<br><br>
<div>
    客户端向服务器发送的内容
    <input id="targetId" type="text" value="20">
    <input id="contentText" type="text" value="hello WebSocket">
    <button style="color: cornflowerblue"><a onclick="sendMessage()">发送消息</a></button>
</div>


</body>
</html>

5.模拟服务端发送消息

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CopyOnWriteArraySet;

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

    /**
     * 客户端的连接会话，需要通过它来给客户端发送数据
     */
    private Session session;

    /**
     * 客户端id
     */
    private String clientId;

    /**
     * 用来存放每个客户端对应的MyWebSocket对象
     */
    private static CopyOnWriteArraySet<WebSocketServer> webSockets = new CopyOnWriteArraySet<>();

    /**
     * 用来存在线连接用户信息
     */
    private static ConcurrentHashMap<String, Session> sessionPool = new ConcurrentHashMap<String, Session>();

    /**
     * 链接成功调用的方法
     */
    @OnOpen
    public void onOpen(Session session, @PathParam(value = "clientId") String clientId) {
        try {
            this.session = session;
            this.clientId = clientId;
            webSockets.add(this);
            sessionPool.put(clientId, session);
            log.info("【websocket消息】有新的连接 clientId:{}，总数为:{}", clientId, webSockets.size());
        } catch (Exception e) {
            log.info("【websocket消息】有新的连接构建失败 clientId:{}，总数为:{}，error:", clientId, webSockets.size(), e);
        }
    }

    /**
     * 链接关闭调用的方法
     */
    @OnClose
    public void onClose() {
        try {
            webSockets.remove(this);
            sessionPool.remove(this.clientId);
            log.info("【websocket消息】连接断开 clientId:{}，总数为:{}", this.clientId, webSockets.size());
        } catch (Exception e) {
            log.info("【websocket消息】连接断开失败 clientId:{}，总数为:{}，error:", clientId, webSockets.size(), e);
        }
    }

    /**
     * 收到客户端消息后调用的方法
     */
    @OnMessage
    public void onMessage(String message) {
        log.info("【websocket消息】收到客户端消息:{}", message);
    }

    /**
     * 发送错误时的处理
     *
     * @param session
     * @param error
     */
    @OnError
    public void onError(Session session, Throwable error) {
        log.error("【websocket消息】发生错误，原因:", error);
    }

    /**
     * 此为广播消息
     */
    public void sendBroadcastMessage(String message) {
        log.info("【websocket消息】广播消息:{}", message);
        for (WebSocketServer webSocket : webSockets) {
            try {
                if (webSocket.session.isOpen()) {
                    webSocket.session.getAsyncRemote().sendText(message);
                }
            } catch (Exception e) {
                log.error("【websocket消息】广播消息异常，消息:{}，error:", message, e);
            }
        }
    }

    /**
     * 此为单点消息
     */
    public void sendSinglePointMessage(String targetId, String message) {
        Session session = sessionPool.get(targetId);
        if (session != null && session.isOpen()) {
            try {
                session.getAsyncRemote().sendText(message);
                log.info("【websocket消息】单点消息，targetId:{}，消息:{}", targetId, message);
            } catch (Exception e) {
                log.error("【websocket消息】单点消息异常，targetId:{}，消息:{}，error:", targetId, message, e);
            }
        }
    }

}

发送广播消息：http://localhost:8081/api//websocket/sendBroadcastMessage?message=hello

发送点对点消息：http://localhost:8081/api//websocket/sendSinglePointMessage?message=hello&targetId=10

Ocean@上源码
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringBoot集成WebSocket长连接实际应用详解
08-19
SpringBoot集成WebSocket长连接实际应用详解 本文主要介绍了SpringBoot集成WebSocket长连接实际应用详解，通过示例代码详细介绍了WebSocket的应用场景和实现方式，对大家的学习或者工作具有一定的参考学习价值。 ...
SpringBoot集成WebSocket实现前后端消息互传的方法
08-25
SpringBoot集成WebSocket实现前后端消息互传的方法 SpringBoot集成WebSocket实现前后端消息互传的方法是当前互联网技术中的一种常见的实现方式。WebSocket是一种基于TCP的网络协议，能够实现浏览器与服务器的全双工...
Springboot集成websocket
囚徒之困
05-23 1194
Springboot集成websocket
springboot集成websocket
大爱仙尊
10-21 2万+
​ 这里我们使用springboot搭建一个轻量级的websocket服务，同时提供4个入参。使用websocket服务可以轻松和微信小程序、支付宝小程序、网页就行双向通讯，非常实用方便。wss地址这里是我们自己搭建的中转服务websocket地址。参数说明。
SpringBoot集成websocket
usa_washington的博客
03-05 1337
websocket
SpringBoot 集成WebSocket详解
热门推荐
Charge8的博客
05-30 3万+
SpringBoot 集成WebSocket详解
SpringBoot 集成 WebSocket
m0_64261982的博客
04-21 1651
SpringBoot 整合 websocket、websocket 的通信应用
springboot 集成websocket
大哥一声吼
05-29 8133
springboot 和websocket 集成
Springboot集成WebSocket
weixin_57205390的博客
03-06 543
简介：WebSocket是一种在单个TCP连接上进行全双工通信的协议。WebSocket通信协议于2011年被IETF定为标准RFC 6455，并由RFC7936补充规范。WebSocket API也被W3C定为标准。WebSocket使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。在WebSocket API中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。说明：本篇主要介绍在SpringBoot框架下，WebSocket基于注解使
SpringBoot集成WebSocket
qq_37705525的博客
05-18 865
SpringBoot集成WebSocket
springboot 集成webSocket
just_learing的博客
07-20 4799
springboot 集成webSocket
SpringBoot 集成WebSocket
m0_67907445的博客
08-29 1220
在海量并发及客户端与服务器交互负载流量大的情况下，极大的节省了网络带宽资源的消耗，有明显的性能优势，且客户端发送和接受消息是在同一个持久连接上发起，实现了“真·长链接”，实时性优势明显。* 要注意，如果项目使用外置的servlet容器，而不是直接使用springboot内置容器的话，就不要注入ServerEndpointExporter，因为它将由容器自己提供和管理。长轮询的间隔期一般很长，例如 30s、60s，并且服务端 hold 住连接不会消耗太多服务端资源。降低轮询的间隔，延迟降低，压力增加；
springboot集成websocket的简单例子
03-02
一个springboot集成websocket的简单例子，好多网上资源无法用，特上传
springboot集成WebSocket源码
05-14
springboot集成WebSocket，实现小程序聊天功能，对用户进行群发消息以及单个用户发送消息户
springboot集成websocket实现简单聊天
03-29
springboot集成websocket实现即时通信，你发的消息将直接显示在另一台pc机的浏览器上
基于Spring Boot的智能分析平台
m0_61364659的博客
06-13 813
区别于传统的的BI，用户只需要导入最原始的数据集，输入想要进行分析的目标，就能利用AI自动给生成可视化界面和分析结论。
Spring Security+Spring Boot实现登录认证以及权限认证
最新发布
weixin_53908842的博客
06-17 951
认证流程：AuthenticationManager为这个系统所支持的所有认证协议，统一提供authenticate方法，比如支持用户名密码登录，也支持短信登录，第三方授权登录，不论哪种方式登录，最终都交由这个方法执行，其实现类ProviderManager则高度封装了认证过程，使得不同认证协议进入不同的认证实现类，然后都返回Authentication对象。
Spring Boot集成tablesaw插件快速入门
吴名氏的博客
06-13 769
Spring Boot集成tablesaw插件快速入门Demo
探索Spring Boot的自动配置机制
weixin_42279822的博客
06-13 629
如果需要自定义DataSourceBean，可以在应用程序中定义自己的DataSource@BeanSpring Boot会优先使用开发者定义的DataSource，而不会使用默认的自动配置。Spring Boot的自动配置机制通过Starter依赖、条件注解和自动配置类等技术，极大地简化了Spring应用的开发过程，使得开发者能够专注于业务逻辑而不是繁琐的配置。开发者可以通过自定义配置或禁用自动配置来灵活调整应用程序的行为，从而满足特定需求。
springboot集成 websocket
05-27
SpringBoot集成WebSocket可以使用Spring框架提供的WebSocket API来实现。在SpringBoot中，使用WebSocket需要进行以下几个步骤： 1. 添加依赖：在pom.xml文件中添加spring-boot-starter-websocket依赖。 2. 创建...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值