Spring Boot 3.4.3 基于 Spring WebFlux 实现 SSE 功能(代码示例)

2025-04-01 15:50

本文主要是介绍Spring Boot 3.4.3 基于 Spring WebFlux 实现 SSE 功能(代码示例),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

《SpringBoot3.4.3基于SpringWebFlux实现SSE功能(代码示例)》SpringBoot3.4.3结合SpringWebFlux实现SSE功能,为实时数据推送提供...

在现代 Web 应用开发中,实时数据推送已成为许多业务场景的核心需求,例如实时通知、股票价格更新或在线聊天等。传统的轮询方式效率低下,而 SSE(Server-Sent Events,服务器推送事件)作为 html5 提供的一种轻量级技术,能够通过单向长连接实现服务器到客户端的实时数据推送。Spring Boot 3.4.3 结合 Spring WebFlux,为开发者提供了响应式编程能力,使得实现 SSE 功能更加简单高效。本文将详细介绍如何在 Spring Boot 3.4.3 中基于 Spring WebFlux 实现 SSE 功能,并提供完整的代码示例,助你在企业级应用中快速落地实时推送需求。

1. SSE 简介

1.1 什么是 SSE?

SSE(Server-Sent Events)是一种基于 HTTP 协议的服务器推送技术,允许服务器主动向客户端发送数据。客户端通过建立长连接接收服务器推送的事件流,适用于需要实时更新的场景。与 WebSocket 相比,SSE 是单向通信(仅服务器到客户端),实现更简单,且浏览器原生支持。

1.2 SSE 的优点

  • 轻量级:基于 HTTP,无需额外协议支持。
  • 简单性:实现成本低,适合单向推送场景。
  • 自动重连:客户端断开后可自动尝试重连。
  • 兼容性html5 标准,主流浏览器均支持。

1.3 适用场景

  • 实时通知(如消息提醒)。
  • 数据监控(如服务器状态更新)。
  • 单向事件流(如日志推送)。

2. Spring WebFlux 简介

Spring WebFlux 是 Spring 5 引入的响应式 Web 框架,与传统的 Spring MVC 不同,它基于 Reactor 项目,支持异步非阻塞的编程模型。Spring Boot 3.4.3 默认集成了 Spring WebFlux,使得开发者可以轻松构建高并发、事件驱动的应用。结合 SSE,WebFlux 的 Flux 数据流非常适合处理实时推送需求。

3. 项目实战

以下是基于 Spring Boot 3.4.3 和 Spring WebFlux 实现 SSE 功能的完整步骤。

3.1 添加 Maven 依赖

pom.XML 中添加 Spring WebFlux 的依赖:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/x编程sd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.4.3</version>
    </parent>
    <artifactId>springboot-sse</artifactId>
    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webflux</artifactId>
        </dependency>
    </dependencies>
</project>

说明:

  • spring-boot-starter-webflux 提供了 WebFlux 的核心功能和 Reactor 依赖。
  • Spring Boot 3.4.3 使用 JDK 17,确保编译器版本匹配。

3.2 创建 SSE 控制器

创建一个控制器,用于推送事件流:

package cn.joyous.sse.controller;
import org.springframework.http.MediaType;
import org.springframework.http.codec.ServerSentEvent;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bijavascriptnd.annotation.RestController;
import reactor.core.publisher.Flux;
import Java.time.Duration;
import java.util.concurrent.atomic.AtomicInteger;
/**
 */
@RestController
public class SSEController {
    // 定义一个计数器,用于模拟数据变化
    private final AtomicInteger counter = new AtomicInteger(0);
    @GetMapping(path = "/sse", produces = MediaType.TEXT_EVENT_STREAM_VALUE)
    public Flux<ServerSentEvent<Integer>> streamEvents() {
        return Flux.interval(Duration.ofSeconds(1))
                .map(seq -> ServerSentEvent.<Integer>builder()
                        .id(Striwww.chinasem.cnng.valueOf(seq))
                        .event("message")
                        .data(counter.incrementAndGet())
                        .build());
    }
}

代码说明:

  • @GetMapping(produces = MediaType.TEXT_EVENT_STREAM_VALUE):指定返回 SSE 事件流。
  • Flux.interval(Duration.ofSeconds(1)):每秒生成一个事件。
  • ServerSentEvent.builder():构造 SSE 事件,包含 id(事件标识)、event(事件类型)和 data(推送数据)。

3.3 前端页面示例

创建一个简单的 HTML 页面,用于接收 SSE 数据:

<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta charset="UTF-8">
    <title>SSE Demo</title>
</head>
<body>
    <h1>SSE 数据推送</h1>
    <div id="result"></div>
    <script>
        const eventSource = new EventSource("http://localhost:8080/sse");
        eventSource.onmessage = function(event) {
            document.getElementById("result").innerText += "收到数据: " + event.data + "\n";
        };
        eventSource.onerror = function() {
            console.log("SSE 连接失败");
            eventSource.close();
        };
    </script>
</body>
</html>

保存为 sse.html,放置在 src/main/resources/static 目录下。

3.4 启动与测试

  • 启动 Spring Boot 应用。
  • 在浏览器中访问 http://localhost:8080/sse.html,你将看到页面每秒更新一次计数器数据。
  • 或者直接访问 http://localhost:8080/sse,查看原始事件流:
id: 0
event: message
data: 1
id: 1
event: message
data: 2

4. 进阶功能(可选)

自定义事件类型
修改控制器支持多种事件:

@GetMapping(path = "/sse", produces = MediaTpythonype.TEXT_EVENT_STREAM_VALUE)
public Flux<ServerSentEvent<String>> streamEvents() {
    return Flux.interval(Duration.ofSeconds(1))
            .map(seq -> ServerSentEvent.<String>builder()
                    .id(String.valueOf(seq))
                    .event(seq % 2 == 0 ? "even" : "odd")
                    .data("Count: " + counter.incrementAndGet())
                    .build());
}

动态推送特定用户
使用 Map 存储用户连接:

private final Map<String, Sinks.Many<String>> userSinks = new ConcurrentHashMap<>();
@GetMapping("/sse/{userId}")
public Flux<ServerSentEvent<String>> userStream(@PathVariable String userId) {
    Sinks.Many<String> sink = userSinks.computeIfAbsent(userId, k -> Sinks.many().multicast().onBackpressureBuffer());
    return sink.asFlux().map(data -> ServerSentEvent.builder().data(data).build());
}

异常处理
添加错误重连逻辑:

return Flux.interval(Duration.ofSeconds(1))
        .map(seq -> ServerSentEvent.<Integer>builder().data(counter.incrementAndGet()).build())
        .onErrorResume(e -> Flux.just(ServerSentEvent.builder().data("Error: " + e.getMessage()).build()));

5. 总结

Spring Boot 3.4.3 结合 Spring WebFlux 实现 SSE 功能,为实时数据推送提供了优雅的解决方案。通过本文的步骤,你可以快速搭建一个基于事件驱动的后端服务,满足实时通知或监控等需求。相比 WebSocket,SSE 更轻量且易于集成,适合单向推送场景。

到此这篇关于Spring Boot 3.4.3 基于 Spring WebFlux 实现 SSE 功能的文章就介绍到这了,更多相关Spring Boot   Spring WebFlux SSE内容请搜索China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持China编程(www.chinasem.cn)!

这篇关于Spring Boot 3.4.3 基于 Spring WebFlux 实现 SSE 功能(代码示例)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1154045

相关文章

springboot集成easypoi导出word换行处理过程

《springboot集成easypoi导出word换行处理过程》SpringBoot集成Easypoi导出Word时,换行符n失效显示为空格,解决方法包括生成段落或替换模板中n为回车,同时需确... 目录项目场景问题描述解决方案第一种:生成段落的方式第二种:替换模板的情况,换行符替换成回车总结项目场景s

SpringBoot集成redisson实现延时队列教程

《SpringBoot集成redisson实现延时队列教程》文章介绍了使用Redisson实现延迟队列的完整步骤,包括依赖导入、Redis配置、工具类封装、业务枚举定义、执行器实现、Bean创建、消费... 目录1、先给项目导入Redisson依赖2、配置redis3、创建 RedissonConfig 配

SpringBoot中@Value注入静态变量方式

《SpringBoot中@Value注入静态变量方式》SpringBoot中静态变量无法直接用@Value注入,需通过setter方法,@Value(${})从属性文件获取值,@Value(#{})用... 目录项目场景解决方案注解说明1、@Value("${}")使用示例2、@Value("#{}"php

SpringBoot分段处理List集合多线程批量插入数据方式

《SpringBoot分段处理List集合多线程批量插入数据方式》文章介绍如何处理大数据量List批量插入数据库的优化方案:通过拆分List并分配独立线程处理,结合Spring线程池与异步方法提升效率... 目录项目场景解决方案1.实体类2.Mapper3.spring容器注入线程池bejsan对象4.创建

线上Java OOM问题定位与解决方案超详细解析

《线上JavaOOM问题定位与解决方案超详细解析》OOM是JVM抛出的错误,表示内存分配失败,:本文主要介绍线上JavaOOM问题定位与解决方案的相关资料,文中通过代码介绍的非常详细,需要的朋... 目录一、OOM问题核心认知1.1 OOM定义与技术定位1.2 OOM常见类型及技术特征二、OOM问题定位工具

Python的Darts库实现时间序列预测

《Python的Darts库实现时间序列预测》Darts一个集统计、机器学习与深度学习模型于一体的Python时间序列预测库,本文主要介绍了Python的Darts库实现时间序列预测,感兴趣的可以了解... 目录目录一、什么是 Darts?二、安装与基本配置安装 Darts导入基础模块三、时间序列数据结构与

基于 Cursor 开发 Spring Boot 项目详细攻略

《基于Cursor开发SpringBoot项目详细攻略》Cursor是集成GPT4、Claude3.5等LLM的VSCode类AI编程工具,支持SpringBoot项目开发全流程,涵盖环境配... 目录cursor是什么?基于 Cursor 开发 Spring Boot 项目完整指南1. 环境准备2. 创建

Python使用FastAPI实现大文件分片上传与断点续传功能

《Python使用FastAPI实现大文件分片上传与断点续传功能》大文件直传常遇到超时、网络抖动失败、失败后只能重传的问题,分片上传+断点续传可以把大文件拆成若干小块逐个上传,并在中断后从已完成分片继... 目录一、接口设计二、服务端实现(FastAPI)2.1 运行环境2.2 目录结构建议2.3 serv

C#实现千万数据秒级导入的代码

《C#实现千万数据秒级导入的代码》在实际开发中excel导入很常见,现代社会中很容易遇到大数据处理业务,所以本文我就给大家分享一下千万数据秒级导入怎么实现,文中有详细的代码示例供大家参考,需要的朋友可... 目录前言一、数据存储二、处理逻辑优化前代码处理逻辑优化后的代码总结前言在实际开发中excel导入很

Spring Security简介、使用与最佳实践

《SpringSecurity简介、使用与最佳实践》SpringSecurity是一个能够为基于Spring的企业应用系统提供声明式的安全访问控制解决方案的安全框架,本文给大家介绍SpringSec... 目录一、如何理解 Spring Security?—— 核心思想二、如何在 Java 项目中使用?——