Springboot集成WebSocket

最新推荐文章于 2024-05-24 09:39:31 发布
最新推荐文章于 2024-05-24 09:39:31 发布
阅读量549 收藏 1
点赞数 2
分类专栏： spring 文章标签： java 开发语言 spring boot websocket
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_57205390/article/details/129358895
版权

简介：

WebSocket是一种在单个TCP连接上进行全双工通信的协议。WebSocket通信协议于2011年被IETF定为标准RFC 6455，并由RFC7936补充规范。WebSocket API也被W3C定为标准。WebSocket使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。在WebSocket API中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。

说明：

本篇主要介绍在SpringBoot框架下，WebSocket基于注解使用的3种场景：

1、自己给自己发消息

2、自己给所有客户端发送消息(不包括自己)

3、自己给另一个客户端发送消息

代码示例：

代码结构如下：

pom文件中的依赖：

　　　　 <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <!-- websocket -->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
        </dependency>
        <dependency>
            <!-- fastjson -->
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.47</version>
        </dependency>

application.yml文件：

server:
  port: 18092

WebSocket配置文件：

@Configuration
public class WebSocketConfig {

    /**
     * 注入一个ServerEndpointExporter,该Bean会自动注册使用@ServerEndpoint注解申明的websocket endpoint
     */
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }

}

在resources创建一个static文件夹，然后新建一个index.html页面：

<!DOCTYPE HTML>
<html>
<head>
<title>My WebSocket</title>
</head>

<body>
    <input id="text" type="text" />
    <button οnclick="send()">Send</button>
    <button οnclick="closeWebSocket()">Close</button>
    <div id="message"></div>
</body>

<script type="text/javascript">
    var websocket = null;

    //判断当前浏览器是否支持WebSocket, 主要此处要更换为自己的地址
    if ('WebSocket' in window) {
        websocket = new WebSocket("ws://localhost:18092/test/one");
    } else {
        alert('Not support websocket')
    }

    //连接发生错误的回调方法
    websocket.onerror = function() {
        setMessageInnerHTML("error");
    };

    //连接成功建立的回调方法
    websocket.onopen = function(event) {
        //setMessageInnerHTML("open");
    }

    //接收到消息的回调方法
    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 closeWebSocket() {
        websocket.close();
    }

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

对应上面的3中场景，分别给出代码：

1、自己给自己发消息

创建一个OneWebSocket类，用来服务端与客户端进行交互：

/**
 * 前后端交互的类实现消息的接收推送(自己发送给自己)
 * 
 * @ServerEndpoint(value = "/test/one") 前端通过此URI和后端交互，建立连接
 */
@Slf4j
@ServerEndpoint(value = "/test/one")
@Component
public class OneWebSocket {

    /** 记录当前在线连接数 */
    private static AtomicInteger onlineCount = new AtomicInteger(0);

    /**
     * 连接建立成功调用的方法
     */
    @OnOpen
    public void onOpen(Session session) {
        onlineCount.incrementAndGet(); // 在线数加1
        log.info("有新连接加入：{}，当前在线人数为：{}", session.getId(), onlineCount.get());
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose(Session session) {
        onlineCount.decrementAndGet(); // 在线数减1
        log.info("有一连接关闭：{}，当前在线人数为：{}", session.getId(), onlineCount.get());
    }

    /**
     * 收到客户端消息后调用的方法
     *
     * @param message
     *            客户端发送过来的消息
     */
    @OnMessage
    public void onMessage(String message, Session session) {
        log.info("服务端收到客户端[{}]的消息:{}", session.getId(), message);
        this.sendMessage("Hello, " + message, session);
    }

    @OnError
    public void onError(Session session, Throwable error) {
        log.error("发生错误");
        error.printStackTrace();
    }

    /**
     * 服务端发送消息给客户端
     */
    private void sendMessage(String message, Session toSession) {
        try {
            log.info("服务端给客户端[{}]发送消息{}", toSession.getId(), message);
            toSession.getBasicRemote().sendText(message);
        } catch (Exception e) {
            log.error("服务端发送消息给客户端失败：{}", e);
        }
    }

其中@ServerEndpoint注解是服务端与客户端交互的关键，其值(/test/one)得与index页面中的请求路径对应。

启动服务，在浏览器请求http://localhost:18092/index.html，如下所示：

请求一发出，立马就会建立服务端与客户端的连接。服务端打印日志如下：

在文本框中输入内容：“你好”，然后点击Send按钮，浏览器效果：

 服务端日志：

（备注：服务端关闭或者浏览器关闭的效果，都会导致连接断开，这里不演示）

2、自己给所有客户端发送消息(不包括自己)

创建一个OneToManyWebSocket类，用来服务端与客户端进行交互：

/**
 * 
 * 前后端交互的类实现消息的接收推送(自己发送给所有人(不包括自己))
 * 
 * @ServerEndpoint(value = "/test/oneToMany") 前端通过此URI 和后端交互，建立连接
 */
@Slf4j
@ServerEndpoint(value = "/test/oneToMany")
@Component
public class OneToManyWebSocket {

    /** 记录当前在线连接数 */
    private static AtomicInteger onlineCount = new AtomicInteger(0);

    /** 存放所有在线的客户端 */
    private static Map<String, Session> clients = new ConcurrentHashMap<>();

    /**
     * 连接建立成功调用的方法
     */
    @OnOpen
    public void onOpen(Session session) {
        onlineCount.incrementAndGet(); // 在线数加1
        clients.put(session.getId(), session);
        log.info("有新连接加入：{}，当前在线人数为：{}", session.getId(), onlineCount.get());
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose(Session session) {
        onlineCount.decrementAndGet(); // 在线数减1
        clients.remove(session.getId());
        log.info("有一连接关闭：{}，当前在线人数为：{}", session.getId(), onlineCount.get());
    }

    /**
     * 收到客户端消息后调用的方法
     *
     * @param message
     *            客户端发送过来的消息
     */
    @OnMessage
    public void onMessage(String message, Session session) {
        log.info("服务端收到客户端[{}]的消息:{}", session.getId(), message);
        this.sendMessage(message, session);
    }

    @OnError
    public void onError(Session session, Throwable error) {
        log.error("发生错误");
        error.printStackTrace();
    }

    /**
     * 群发消息
     * 
     * @param message
     *            消息内容
     */
    private void sendMessage(String message, Session fromSession) {
        for (Map.Entry<String, Session> sessionEntry : clients.entrySet()) {
            Session toSession = sessionEntry.getValue();
            // 排除掉自己
            if (!fromSession.getId().equals(toSession.getId())) {
                log.info("服务端给客户端[{}]发送消息{}", toSession.getId(), message);
                toSession.getAsyncRemote().sendText(message);
            }
        }
    }
}

将index.html页面的路径改为/test/oneToMany。重启服务，在浏览器开多个页面。服务端日志如下：

 在浏览器第一个页面中输入内容：“你好”，会发现其它页面都收到了消息“你好”。服务端日志如下：

3、自己给另一个客户端发送消息

创建一个OneToOneWebSocket类，用来服务端与客户端进行交互：

/**
 * 前后端交互的类实现消息的接收推送(自己发送给另一个人)
 * 
 * @ServerEndpoint(value = "/test/oneToOne") 前端通过此URI 和后端交互，建立连接
 */
@Slf4j
@ServerEndpoint(value = "/test/oneToOne")
@Component
public class OneToOneWebSocket {

    /** 记录当前在线连接数 */
    private static AtomicInteger onlineCount = new AtomicInteger(0);

    /** 存放所有在线的客户端 */
    private static Map<String, Session> clients = new ConcurrentHashMap<>();

    /**
     * 连接建立成功调用的方法
     */
    @OnOpen
    public void onOpen(Session session) {
        onlineCount.incrementAndGet(); // 在线数加1
        clients.put(session.getId(), session);
        log.info("有新连接加入：{}，当前在线人数为：{}", session.getId(), onlineCount.get());
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose(Session session) {
        onlineCount.decrementAndGet(); // 在线数减1
        clients.remove(session.getId());
        log.info("有一连接关闭：{}，当前在线人数为：{}", session.getId(), onlineCount.get());
    }

    /**
     * 收到客户端消息后调用的方法
     *
     * @param message
     *            客户端发送过来的消息
     */
    @OnMessage
    public void onMessage(String message, Session session) {
        log.info("服务端收到客户端[{}]的消息[{}]", session.getId(), message);
        try {
            MyMessage myMessage = JSON.parseObject(message, MyMessage.class);
            if (myMessage != null) {
                Session toSession = clients.get(myMessage.getUserId());
                if (toSession != null) {
                    this.sendMessage(myMessage.getMessage(), toSession);
                }
            }
        } catch (Exception e) {
            log.error("解析失败：{}", e);
        }
    }

    @OnError
    public void onError(Session session, Throwable error) {
        log.error("发生错误");
        error.printStackTrace();
    }

    /**
     * 服务端发送消息给客户端
     */
    private void sendMessage(String message, Session toSession) {
        try {
            log.info("服务端给客户端[{}]发送消息[{}]", toSession.getId(), message);
            toSession.getBasicRemote().sendText(message);
        } catch (Exception e) {
            log.error("服务端发送消息给客户端失败：{}", e);
        }
    }

}

将index.html页面的路径改为/test/oneToOne。重启服务，在浏览器打开两个页面。

由于服务端是解析的Json字符串，这里为了简单起见，直接在浏览器输入json字符串：{"message":"你好", "userId":1}。另一个页面收到了消息：

 服务端日志：

林鸟鸟
关注
  • 2
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
springboot 集成webSocket
just_learing的博客
07-20 4814
springboot 集成webSocket
springboot 集成websocket
大哥一声吼
05-29 8147
springboot 和websocket 集成
Spring Boot中集成WebSocket
一名全栈开发工程师
05-24 1222
WebSocket是一种在单个TCP连接上进行全双工通信的协议。WebSocket使客户端和服务器之间的数据交换变得更加简单和快速，适用于需要实时更新的应用场景,，本文介绍使用spring boot 与websocket集成的方式和方法。
SpringBoot 集成WebSocket
m0_67907445的博客
08-29 1329
在海量并发及客户端与服务器交互负载流量大的情况下，极大的节省了网络带宽资源的消耗，有明显的性能优势，且客户端发送和接受消息是在同一个持久连接上发起，实现了“真·长链接”，实时性优势明显。* 要注意，如果项目使用外置的servlet容器，而不是直接使用springboot内置容器的话，就不要注入ServerEndpointExporter，因为它将由容器自己提供和管理。长轮询的间隔期一般很长，例如 30s、60s，并且服务端 hold 住连接不会消耗太多服务端资源。降低轮询的间隔，延迟降低，压力增加；
【Spring Boot】WebSocket 的 6 种集成方式
黑白法师的博客
06-21 4767
由于前段时间我实现了一个库【Spring Cloud】一个配置注解实现 WebSocket 集群方案以至于我对的各种集成方式做了一些研究目前我所了解到的就是下面这些了（就一个破ws都有这么多花里胡哨的集成方式了？）今天主要介绍一下前3种方式，毕竟现在的主流框架还是而后3种其实和并不强行绑定，基于就可以支持，不过我也会对后3种做个简单的介绍，大家先混个眼熟就行了那么接下来我们就来讲讲前3种方式 在中的服务端和客户端配置（客户端配置也超重要的有木有，平时用不到，用到了却基本找不到文档，这也太绝望了）......
Spring Boot集成websocket
AnNanDu的博客
02-08 1429
像目前的直播、弹幕、小游戏等方面都用到了websocet进行长链接，相对于http的一次请求一次响应websocket只需要进行一次握手即长久性的建立链接进行消息互通。 为什么一些场景要用websocet呢？ http的请求每次都会进行校验而请求头占用了资源的绝大部分，参数内容相对较少，而像直播弹幕这种实时性和大数据量的交互在http请求上肯定会使用轮询的方式，而每次的轮询请求都会进行校验浪费资源和网络代宽。 使用websocket有两种方式：1是使用sockjs，2是...
SpringBoot集成WebSocket长连接实际应用详解
08-19
SpringBoot集成WebSocket长连接实际应用详解 本文主要介绍了SpringBoot集成WebSocket长连接实际应用详解，通过示例代码详细介绍了WebSocket的应用场景和实现方式，对大家的学习或者工作具有一定的参考学习价值。 ...
SpringBoot集成WebSocket实现前后端消息互传的方法
08-25
SpringBoot集成WebSocket实现前后端消息互传的方法 SpringBoot集成WebSocket实现前后端消息互传的方法是当前互联网技术中的一种常见的实现方式。WebSocket是一种基于TCP的网络协议，能够实现浏览器与服务器的全双工...
springboot集成websocket的简单例子
03-02
首先，为了集成WebSocket，我们需要引入相关的依赖。在Spring Boot项目中，我们通常通过添加`spring-boot-starter-websocket`依赖来启用WebSocket功能。在`pom.xml`或`build.gradle`文件中添加如下依赖： ```xml <!...
springboot集成WebSocket源码
05-14
在本文中，我们将深入探讨如何使用Spring Boot集成WebSocket来实现小程序的聊天功能，以及如何向用户群发和单独发送消息。Spring Boot是一个流行的Java开发框架，它简化了配置和项目设置，而WebSocket则是一种双向...
springboot集成websocket实现简单聊天
03-29
在本项目中，我们将探讨如何利用Spring Boot集成WebSocket，以实现一个简单的聊天应用。 首先，我们需要在Spring Boot项目中引入WebSocket的相关依赖。Spring Boot本身并不直接支持WebSocket，但可以通过Spring ...
Spring Boot 集成 WebSocket（原生注解与Spring封装）
热门推荐
欲变世界，先变其身
09-24 2万+
本文将介绍Spring Boot 集成 WebSocket的两种主要方式：原生注解与Spring封装。
SpringBoot集成WebSocket实战一
静幽水
12-17 4003
SpringBoot集成WebSocket实战一1.什么是WebSocket2.为什么要使用WebSocket3.SpringBoot整合WebSocket4. 服务器主动推送数据给前端 1.什么是WebSocket 什么是websocket,百度百科的解释是：＂websocket是一种在单个TCP连接上进行全双工通讯的协议，websocket使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据，在websocket中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的
springboot集成websocket
qq_43772259的博客
06-13 150
2.注入ServerEndpointExporter。5.SocketEntity封装的一个消息对象。3.JWT工具类，原来签名，解密用户数据。4.创建WebSocket服务端。
一文了解WebSocket及Springboot集成WebSocket
龙飞的博客
01-29 4397
🍊WebSocket与HTTP协议不同，它使用了独立的端口，并且在建立连接后，不需要在每次数据传输时重新建立连接。与 HTTP 通信不同的是，WebSocket 通信是基于TCP的，所以它是一个持久连接。如下图所示，发起一个websocket链接之后，请求和响应的参数里会有一些websocket相关的参数，该报文中有一个upgrade首部，它的作用是告诉服务端需要将通信协议切换到websocket。🍊WebSocket协议是一种全双工协议，它允许服务器主动发送信息给客户端，而不是等待客户端的请求。
Spring Boot 集成 WebSocket
06-05 159
WebSocket 协议是基于 TCP 的一种新的网络协议，它实现了浏览器与服务器全双工（full-duplex）通信—允许服务器主动发送信息给客户端，这样就可以实现从客户端发送消息到服务器，而服务器又可以转发消息到客户端，这样就能够实现客户端之间的交互。对于 WebSocket 的开发，Spring 也提供了良好的支持，目前很多浏览器已经实现了 WebSocket 协议，但是依旧存在着很多浏览器没有实现该协议，为了兼容那些没有实现该协议的浏览器，往往还需要通过 STOMP 协议来完成这些兼容。
SpringBoot集成WebSocket的两种方式
haiyangyiba的专栏
06-10 1363
SpringBoot两种方式集成的WebSocket，我分别对它们进行了实践，所以我称这两种方式为JDK内置版和Spring封装版。
SpringBoot集成WebSocket【复制即用】
SmallCat0912的博客
12-20 742
SpringBoot集成WebSocket，复制即用。WebSocket是一种在单个TCP连接上进行全双工通信的协议WebSocket允许服务端主动向客户端推送数据。ws://浏览器和服务器只需要完成一次握手，两者之间就可以创建持久性的连接，并进行双向数据传输。本文主要实现了在SpringBoot框架中集成WebSocket通讯。
Spring Boot集成WebSocket以及基本使用
积跬步，至千里。
06-25 3169
WebSocket是一种在Web浏览器和Web服务器之间建立实时双向通信的技术，它可以使客户端和服务器之间进行实时交互。
springboot集成 websocket
最新发布
05-27
SpringBoot集成WebSocket可以使用Spring框架提供的WebSocket API来实现。在SpringBoot中，使用WebSocket需要进行以下几个步骤： 1. 添加依赖：在pom.xml文件中添加spring-boot-starter-websocket依赖。 2. 创建WebSocket配置类：创建一个WebSocket配置类，用于配置WebSocket相关的参数，如注册EndPoint、消息编解码器、拦截器等。 3. 创建EndPoint：创建一个WebSocket的EndPoint类，用于处理WebSocket连接、消息发送、关闭等操作。可以通过实现Spring提供的WebSocketHandler接口或者继承TextWebSocketHandler来实现。 4. 添加拦截器：可以添加自定义的拦截器，用于处理WebSocket连接建立、消息发送等事件。 5. 配置WebSocket消息代理：使用Spring提供的消息代理，可以实现WebSocket消息的广播和点对点传递。 以下是一个简单的SpringBoot集成WebSocket的示例代码： 1. 添加依赖 ``` <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> ``` 2. 创建WebSocket配置类 ``` @Configuration @EnableWebSocket public class WebSocketConfig implements WebSocketConfigurer { @Override public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) { registry.addHandler(myHandler(), "/myHandler") .addInterceptors(new WebSocketInterceptor()); } @Bean public WebSocketHandler myHandler() { return new MyHandler(); } } ``` 3. 创建EndPoint ``` public class MyHandler extends TextWebSocketHandler { @Override public void afterConnectionEstablished(WebSocketSession session) throws Exception { // 处理连接建立事件 } @Override protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception { // 处理消息事件 } @Override public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception { // 处理连接关闭事件 } } ``` 4. 添加拦截器 ``` public class WebSocketInterceptor extends HandshakeInterceptor { @Override public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String, Object> attributes) throws Exception { // 处理连接建立前事件 return true; } @Override public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception ex) { // 处理连接建立后事件 } } ``` 5. 配置WebSocket消息代理 ``` @Configuration @EnableWebSocketMessageBroker public class WebSocketMessageBrokerConfig implements WebSocketMessageBrokerConfigurer { @Override public void configureMessageBroker(MessageBrokerRegistry registry) { registry.enableSimpleBroker("/topic"); registry.setApplicationDestinationPrefixes("/app"); } @Override public void registerStompEndpoints(StompEndpointRegistry registry) { registry.addEndpoint("/myEndpoint") .setAllowedOrigins("*") .withSockJS(); } } ```
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值