Spring Boot 整合 SSE的高级实践(Server-Sent Events)

 更新时间:2025年04月25日 10:53:00   作者:小马不敲代码  
SSE(Server-Sent Events)是一种基于HTTP协议的单向通信机制,允许服务器向浏览器持续发送实时更新,这篇文章主要介绍了Spring Boot 整合 SSE的高级实践(Server-Sent Events),需要的朋友可以参考下

1、简述

SSE(Server-Sent Events)是一种基于HTTP协议的单向通信机制,允许服务器向浏览器持续发送实时更新。与WebSocket不同,SSE更简单,使用HTTP/1.1协议即可,不需要额外的协议升级。

SSE的特点:

  • 单向通信:服务器推送数据给客户端,客户端无法向服务器发送消息。
  • 简单易用:基于HTTP协议,无需复杂的配置。
  • 浏览器支持:现代浏览器大多内置支持(如Chrome、Edge、Firefox等)。

2、Spring Boot 中的SSE实现

2.1 添加依赖

SSE无需额外的依赖,Spring Boot自带对SSE的支持。创建一个Spring Boot项目即可。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

2.2 实现后端接口

使用MediaType.TEXT_EVENT_STREAM_VALUE作为返回类型即可开启SSE。以下代码是一个简单的实现。

package com.example.sse.controller;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import java.time.LocalTime;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;
import java.util.stream.Stream;
@RestController
public class SseController {
    @GetMapping(value = "/sse/stream", produces = MediaType.TEXT_EVENT_STREAM_VALUE)
    public Stream<String> stream() {
        // 模拟数据流
        return Stream.generate(() -> "当前时间:" + LocalTime.now())
                     .limit(10); // 限制10条消息
    }
}

2.3 配置超时时间(可选)

默认情况下,Spring Boot的响应会超时。可以在application.properties中调整超时时间:

server.servlet.session.timeout=30s
spring.mvc.async.request-timeout=30000

2.4 前端实现

SSE在前端通过EventSource对象实现。以下是一个简单的前端示例:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>SSE Example</title>
</head>
<body>
    <h1>实时消息</h1>
    <div id="messages"></div>
    <script>
        const eventSource = new EventSource('/sse/stream');
        eventSource.onmessage = function(event) {
            const messagesDiv = document.getElementById('messages');
            const newMessage = document.createElement('p');
            newMessage.textContent = event.data;
            messagesDiv.appendChild(newMessage);
        };
        eventSource.onerror = function() {
            console.error('SSE连接出错,正在尝试重连...');
            eventSource.close();
        };
    </script>
</body>
</html>

3、高级实践

使用Spring Scheduler推送数据,在实际场景中,可能需要定时向客户端推送数据。例如,监控系统定时更新。

package com.example.sse.service;
import org.springframework.http.MediaType;
import org.springframework.stereotype.Service;
import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArrayList;
@Service
public class SsePushService {
    private final CopyOnWriteArrayList<SseEmitter> emitters = new CopyOnWriteArrayList<>();
    public SseEmitter subscribe() {
        SseEmitter emitter = new SseEmitter(30_000L);
        emitters.add(emitter);
        emitter.onCompletion(() -> emitters.remove(emitter));
        emitter.onTimeout(() -> emitters.remove(emitter));
        return emitter;
    }
    public void pushMessage(String message) {
        for (SseEmitter emitter : emitters) {
            try {
                emitter.send(message, MediaType.TEXT_PLAIN);
            } catch (IOException e) {
                emitters.remove(emitter);
            }
        }
    }
}

创建一个控制器订阅和推送消息:

package com.example.sse.controller;
import com.example.sse.service.SsePushService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class SsePushController {
    private final SsePushService ssePushService;
    public SsePushController(SsePushService ssePushService) {
        this.ssePushService = ssePushService;
    }
    @GetMapping("/sse/subscribe")
    public SseEmitter subscribe() {
        return ssePushService.subscribe();
    }
    @GetMapping("/sse/push")
    public void pushMessage() {
        ssePushService.pushMessage("当前时间:" + System.currentTimeMillis());
    }
}

注意事项:

  • 浏览器兼容性:SSE不支持IE,但现代浏览器支持良好。
  • 连接断开处理:可通过EventSourceonerror事件重新连接。
  • 性能问题:对大量订阅者时,需考虑使用分布式消息队列优化(如Kafka)。
  • 超时时间:默认30秒超时,需要根据实际需求调整。

4、适用场景

  • 实时通知:如监控系统的告警推送。
  • 实时更新:如股票行情、体育比分。
  • 消息流:如系统日志、任务进度。

到此这篇关于Spring Boot 整合 SSE(Server-Sent Events)的文章就介绍到这了,更多相关Spring Boot 整合 SSE内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java工程使用ffmpeg进行音视频格式转换的实现

    Java工程使用ffmpeg进行音视频格式转换的实现

    FFmpeg是一套可以用来记录、转换数字音频、视频,并能将其转化为流的开源计算机程序,本文主要介绍了Java工程使用ffmpeg进行音视频格式转换的实现
    2024-02-02
  • mybatis如何对大量数据的游标查询

    mybatis如何对大量数据的游标查询

    这篇文章主要介绍了mybatis如何对大量数据的游标查询问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-01-01
  • Java中对象数组的使用方法详解

    Java中对象数组的使用方法详解

    这篇文章主要介绍了Java中对象数组的使用方法,结合实例形式分析了java对象数组的功能、定义、初始化与相关使用技巧,需要的朋友可以参考下
    2019-08-08
  • SpringBoot登录用户权限拦截器

    SpringBoot登录用户权限拦截器

    这篇文章主要介绍了SpringBoot登录用户权限拦截器,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-03-03
  • Java使用poi-tl1.9.1生成Word文档的技巧分享

    Java使用poi-tl1.9.1生成Word文档的技巧分享

    本文将简单介绍poi-tl的相关知识,通过一个实际的案例实践,充分介绍如何利用poi-tl进行目标文档的生成,同时分享几个不同的office版本如何进行图表生成的解决方案,需要的朋友可以参考下
    2023-09-09
  • SpringBoot集成antlr实现词法和语法分析

    SpringBoot集成antlr实现词法和语法分析

    Antlr4 是一款强大的语法生成器工具,可用于读取、处理、执行和翻译结构化的文本或二进制文件,基本上是当前 Java 语言中使用最为广泛的语法生成器工具,本文给大家介绍了SpringBoot集成antlr实现词法和语法分析,需要的朋友可以参考下
    2024-06-06
  • Java轻松实现批量插入或删除Excel行列操作

    Java轻松实现批量插入或删除Excel行列操作

    在职场生活中,对Excel工作表的行和列进行操作是非常普遍的需求,下面小编就来和大家介绍一下如何在Java中完成批量插入、删除行和列的操作吧
    2023-10-10
  • 解决spring data jpa saveAll() 保存过慢问题

    解决spring data jpa saveAll() 保存过慢问题

    这篇文章主要介绍了解决spring data jpa saveAll()保存过慢问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-11-11
  • 详解Java设计模式之单例模式

    详解Java设计模式之单例模式

    这篇文章主要为大家详细介绍了Java设计模式之单例模式的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-03-03
  • SpringBoot集成flink全过程

    SpringBoot集成flink全过程

    文章介绍了Flink作为批处理和流处理结合的统一计算框架,特别是其强大的流处理能力,文章还详细描述了如何在本地和集群环境中搭建Flink,并通过Netcat工具生成一个无界流测试,文章最后提供了启动socket流的步骤和示例代码,希望对读者有所帮助
    2025-01-01

最新评论