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实时接收内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

使用ResponseEntity作为的返回值的应用
这篇文章主要介绍了使用ResponseEntity作为的返回值的应用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2024-07-07
Java日志组件间关系详解
在本文里我们给大家整理了关于Java日志组件间关系相关基础知识，需要的朋友们跟着学习下。
2019-02-02
Springboot微服务打包Docker镜像流程解析
这篇文章主要介绍了Springboot微服务打包Docker镜像流程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-08-08
Java中字符串根据宽度(像素)换行的问题
这篇文章主要介绍了Java中字符串根据宽度(像素)换行的问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-09-09
JAVA collection集合之扑克牌游戏实例
本篇文章主要介绍了JAVA collection集合之扑克牌游戏实例，使用了collection集合开发小游戏，有需要的可以了解一下。
2016-11-11
Spring Cloud使用Feign进行远程调用的操作指南
本文介绍了Feign作为声明式HTTP客户端在SpringCloud中的使用,从简介、对比RestTemplate的问题、使用步骤,到日志配置、性能优化和实际应用进行了详细讲解,包括如何通过Feign简化接口调用,以及解决启动时找不到FeignClient的问题,需要的朋友可以参考下
2025-02-02
在idea中将java项目中的单个类打包成jar包操作
这篇文章主要介绍了在idea中将java项目中的单个类打包成jar包操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-08-08
详解Java内存管理中的JVM垃圾回收
这篇文章给大家分享了关于Java内存管理中的JVM垃圾回收的相关知识点内容，有兴趣的朋友们可以学习参考下。
2018-08-08
IDEA POJO开发神器之Groovy的使用详解
这篇文章主要介绍了IDEA POJO开发神器之Groovy的使用，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-07-07
Java中自旋锁与CAS机制的深层关系与区别
CAS算法即比较并替换,是一种实现并发编程时常用到的算法,Java并发包中的很多类都使用了CAS算法,这篇文章主要介绍了Java中自旋锁与CAS机制深层关系与区别的相关资料,需要的朋友可以参考下
2025-11-11