SpringBoot实现WebSocket服务并让客户端实时接收

更新时间：2024年10月30日 08:36:48 作者：m0_74825409

使用SpringBoot和WebSocket可创建实时消息推送服务,首先添加WebSocket依赖至pom.xml,配置WebSocket端点和逻辑处理器,通过WebSocketHandler处理消息,使用AnnouncementController模拟消息推送,支持HTML和微信小程序客户端接收消息,感兴趣的可以了解一下

1. 引入依赖

首先，在 pom.xml 中添加 WebSocket 的依赖：

<dependencies>
    <!-- WebSocket 依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-websocket</artifactId>
    </dependency>
</dependencies>

2. WebSocket 配置

创建一个配置类 WebSocketConfig.java，用于配置 WebSocket 的端点和处理逻辑。

import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        // 注册 WebSocket 处理器和端点
        registry.addHandler(new WebSocketHandler(), "/websocket")
                .setAllowedOrigins("*");  // 允许跨域
    }
}

3. WebSocket 处理器

创建 WebSocketHandler.java，处理 WebSocket 的连接、消息接收、消息广播等操作。

import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;

import java.util.HashSet;
import java.util.Set;

public class WebSocketHandler extends TextWebSocketHandler {

    // 用于保存所有连接的 WebSocket 会话
    private static final Set<WebSocketSession> sessions = new HashSet<>();

    // 当有客户端连接时调用
    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        sessions.add(session);
        session.sendMessage(new TextMessage("欢迎连接 WebSocket 服务器！"));
    }

    // 当有消息从客户端发送过来时调用
    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        System.out.println("收到客户端消息: " + message.getPayload());
    }

    // 当连接关闭时调用
    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        sessions.remove(session);
    }

    // 广播消息给所有连接的客户端
    public static void broadcast(String message) throws Exception {
        for (WebSocketSession session : sessions) {
            if (session.isOpen()) {
                session.sendMessage(new TextMessage(message));
            }
        }
    }
}

4. 模拟公告推送

创建一个控制器 AnnouncementController.java，模拟公告的发布功能。发布公告时，会调用 WebSocket 处理器的 broadcast 方法，将消息推送给所有已连接的客户端。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class AnnouncementController {

    @GetMapping("/announce")
    public String sendAnnouncement() {
        try {
            // 模拟公告内容
            String announcement = "新公告发布于: " + System.currentTimeMillis();
            WebSocketHandler.broadcast(announcement);
            return "公告已发布: " + announcement;
        } catch (Exception e) {
            e.printStackTrace();
            return "发布失败";
        }
    }
}

5. 运行步骤

1. 启动 Spring Boot 应用

启动 Spring Boot 项目后，WebSocket 服务器将会在 /websocket 端点上监听。

2. 小程序或网页客户端

客户端可以是小程序或者网页。这里提供一个简单的 HTML 客户端来测试 WebSocket 连接。

HTML 客户端代码（用于测试 WebSocket 连接）：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>WebSocket Demo</title>
</head>
<body>
    <h1>WebSocket Demo</h1>
    <div id="messages"></div>
    <script>
        // 连接 WebSocket 服务器
        var socket = new WebSocket("ws://localhost:8080/websocket");

        socket.onopen = function() {
            console.log("连接成功！");
        };

        socket.onmessage = function(event) {
            console.log("收到消息:", event.data);
            document.getElementById("messages").innerHTML += "<p>" + event.data + "</p>";
        };

        socket.onclose = function() {
            console.log("连接关闭！");
        };
    </script>
</body>
</html>

3. 发布公告

使用浏览器访问 http://localhost:8080/announce，每次访问该地址时，服务器会推送一条公告消息给所有连接的 WebSocket 客户端。

6. 小程序端实现

你也可以在微信小程序中使用类似的方式，通过 WebSocket 接收服务器推送的公告。

Page({
  data: {
    messages: []  // 保存接收到的公告消息
  },
  
  onLoad: function() {
    // 连接 WebSocket 服务器
    wx.connectSocket({
      url: 'ws://localhost:8080/websocket', // 注意修改为你的服务器地址
      success: (res) => {
        console.log('WebSocket 连接成功！');
      },
      fail: (err) => {
        console.error('WebSocket 连接失败', err);
      }
    });

    // 监听 WebSocket 消息
    wx.onSocketMessage((res) => {
      console.log('收到服务器消息:', res.data);
      this.setData({
        messages: [...this.data.messages, res.data]  // 将新消息添加到列表中
      });
    });

    // 监听 WebSocket 连接关闭
    wx.onSocketClose((res) => {
      console.log('WebSocket 已关闭', res);
    });
  }
});

7. 总结

通过 Spring Boot 的 WebSocket 支持，可以在服务器端推送实时公告。
客户端可以是 HTML 页面，也可以是微信小程序，使用 WebSocket 接口接收公告消息。

到此这篇关于SpringBoot实现WebSocket服务并让客户端实时接收的文章就介绍到这了,更多相关SpringBoot WebSocket实时接收内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

java编程之单元测试(Junit)实例分析(附实例源码)
这篇文章主要介绍了java编程之单元测试(Junit),结合实例形式较为详细的分析总结了Java单元测试的原理、步骤及相关注意事项,并附带了完整代码供读者下载参考,需要的朋友可以参考下
2015-11-11
Java详解实现ATM机模拟系统
这篇文章主要为大家详细介绍了如何利用Java语言实现控制台版本的ATM银行管理系统，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-06-06
Java实现人机猜拳游戏
这篇文章主要为大家详细介绍了Java实现人机猜拳游戏，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2020-07-07
详解Spring Boot微服务如何集成fescar解决分布式事务问题
这篇文章主要介绍了详解Spring Boot微服务如何集成fescar解决分布式事务问题，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2019-01-01
java编程约瑟夫问题实例分析
这篇文章主要介绍了java编程约瑟夫问题实例分析，具有一定借鉴价值，需要的朋友可以参考下。
2017-12-12
利用Java8 Optional如何避免空指针异常详解
Optional可以让你的代码具有可读性，且会避免出现空指针异常。下面这篇文章主要给大家介绍了关于利用Java8 Optional如何避免空指针异常的相关资料，文中通过示例代码介绍的非常详细，需要的朋友可以参考下。
2018-01-01
MybatisX无法自动生成entity实体类的解决方法
本文主要介绍了MybatisX无法自动生成entity实体类的解决方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-06-06
SpringBoot整合freemarker的讲解
今天小编就为大家分享一篇关于SpringBoot整合freemarker的讲解，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
2019-01-01
Springboot-yaml配置和自动配置原理分析
这篇文章主要介绍了Springboot-yaml配置和自动配置原理分析,自动配置原理是配置文件配置debug: true可以在控制台打印自动配置报告.可以打印所有的启动的自动配置和没有启动的自动配置类，需要的朋友可以参考下
2021-06-06
java存储以及java对象创建的流程(详解)
下面小编就为大家带来一篇java存储以及java对象创建的流程(详解)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-05-05