Spring 框架中的 SseEmitter 使用原理解析

 更新时间:2026年02月10日 10:52:59   作者:sg_knight  
SseEmitter是Spring MVC提供的一个类,用于实现基于HTTP的服务器单向推送(Server-Sent Events),本文给大家介绍Spring框架中的 SseEmitter使用详解,感兴趣的朋友跟随小编一起看看吧

       在需要实时向前端推送数据时,很多人第一反应是 WebSocket。但如果你的需求是“服务端单向推送”,并不需要客户端向后端发送消息,那么 Spring 提供的 SseEmitter 会更加轻量、更易用,而且天然支持断线重连。本文总结了 SseEmitter 的核心原理、常见用法、注意事项以及生产实践经验。

一、SseEmitter 是什么?

SseEmitter 是 Spring MVC 提供的一个类,用于实现 基于 HTTP 的服务器单向推送(Server-Sent Events)

它的特点包括:

  • 单向推送(服务端 → 客户端)
  • 基于标准 HTTP(不需要新协议)
  • 支持自动重连(浏览器 EventSource 自带)
  • 使用简单比 WebSocket 更轻,更适合消息通知类业务

适用场景:

  • 消息提醒
  • 实时状态更新
  • 任务进度推送
  • 监控数据刷新

二、基础用法示例

1. 创建 SSE 连接接口

@GetMapping("/sse/connect")
public SseEmitter connect() {
    SseEmitter emitter = new SseEmitter(0L); // 0 表示不过期
    // 在连接时发送一条消息
    try {
        emitter.send("连接成功");
    } catch (Exception e) {
        emitter.completeWithError(e);
    }
    return emitter;
}

注意:

  • new SseEmitter(0L) 表示不超时,可减少长连接断开问题。
  • 返回后客户端会进入持续接收状态。

三、服务端主动推送消息

@Autowired
private List<SseEmitter> emitters = new CopyOnWriteArrayList<>();
@GetMapping("/sse/connect")
public SseEmitter connect() {
    SseEmitter emitter = new SseEmitter(0L);
    emitters.add(emitter);
    emitter.onCompletion(() -> emitters.remove(emitter));
    emitter.onTimeout(() -> emitters.remove(emitter));
    return emitter;
}
@PostMapping("/sse/send")
public void sendMessage(@RequestParam String msg) {
    for (SseEmitter emitter : emitters) {
        try {
            emitter.send(msg);
        } catch (Exception e) {
            emitter.complete();
        }
    }
}

关键点:

  • 使用 CopyOnWriteArrayList 保存所有连接
  • 断开/异常时及时清理 emitter
  • 推送时遍历所有 emitter

四、前端(浏览器)接收实现

const evtSource = new EventSource("/sse/connect");
evtSource.onmessage = function (event) {
    console.log("收到消息:", event.data);
};

浏览器自带特性:断线自动重连,不需要你自己实现。

五、常见问题与解决方案

1.前端收不到消息?(最常见)

原因可能是:

  • 没有使用 UTF-8 文本格式
  • 推送内容太大或太快
  • 连接被代理/网关断开

解决:

emitter.send(SseEmitter.event().data("内容").id("1").name("msg"));

2.Nginx 或网关 1 分钟断开

这是行业常见问题,需要配置:

proxy_read_timeout 3600;
proxy_send_timeout 3600;

3.Spring 默认超时导致断开

务必使用:

new SseEmitter(0L);

4.消息推送异常导致连接中断

一定要在异常时清理 emitter:

catch (Exception e) {
    emitter.completeWithError(e);
}

六、生产实践建议

  • 使用 心跳包 防止代理断开(比如每 20 秒发送一次空事件)
  • 使用 CopyOnWriteArrayList 或 ConcurrentHashMap 存储用户连接
  • 对每个发送操作包一层 try/catch,避免单个连接阻塞所有推送
  • 数据频繁更新建议加上消息合并策略,避免推太快导致阻塞

总结

SseEmitter 是一个轻量但功能强大的实时推送工具,特别适合实时通知类业务。相比 WebSocket,它更简单,不需要复杂协议和框架即可实现稳定的实时消息推送。

如果你的业务属于“服务端单向推送”,SseEmitter 往往是最优选择。

到此这篇关于Spring 框架中的 SseEmitter 使用原理解析的文章就介绍到这了,更多相关Spring SseEmitter 使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • maven依赖传递和依赖冲突原理

    maven依赖传递和依赖冲突原理

    这篇文章主要介绍了maven依赖传递和依赖冲突原理详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-05-05
  • IDEA中的Kafka管理神器详解

    IDEA中的Kafka管理神器详解

    这款基于IDEA插件实现的Kafka管理工具,能够在本地IDE环境中直接运行,简化了设置流程,为开发者提供了更加紧密集成、高效且直观的Kafka操作体验
    2025-01-01
  • 详解在Spring-Boot中实现通用Auth认证的几种方式

    详解在Spring-Boot中实现通用Auth认证的几种方式

    这篇文章主要介绍了详解在Spring-Boot中实现通用Auth认证的几种方式,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-07-07
  • SpringCloud中的服务接口(api)

    SpringCloud中的服务接口(api)

    这篇文章主要介绍了SpringCloud中的服务接口(api),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-04-04
  • spring boot+spring cache实现两级缓存(redis+caffeine)

    spring boot+spring cache实现两级缓存(redis+caffeine)

    这篇文章主要介绍了spring boot+spring cache实现两级缓存(redis+caffeine),小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-02-02
  • 微信小程序登录状态java后台解密

    微信小程序登录状态java后台解密

    这篇文章主要为大家详细介绍了微信小程序登录状态java后台解密,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-12-12
  • Java版学生管理系统

    Java版学生管理系统

    这篇文章主要为大家详细介绍了Java版学生管理系统,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-06-06
  • 分布式系统中的降级熔断设计问题面试

    分布式系统中的降级熔断设计问题面试

    这篇文章主要为大家介绍了分布式系统中的降级熔断设计问题面试解答,有需要的朋友可以借鉴参考下,希望能有所帮助,祝大家多多进步,早日升职加薪
    2022-03-03
  • Java Object toString方法原理解析

    Java Object toString方法原理解析

    这篇文章主要介绍了Java Object toString方法原理解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-03-03
  • Spring Schedule Task动态改写Cron配置方式

    Spring Schedule Task动态改写Cron配置方式

    这篇文章主要介绍了Spring Schedule Task动态改写Cron配置方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-11-11

最新评论