如何在 Spring Web 中发送 SSE 心跳(ping)事件

秋晨小哥_3012

秋晨小哥_3012

2026-05-21

691人浏览

原创

如何在 Spring Web 中发送 SSE 心跳(ping)事件

spring web 的 serversentevent 默认不支持纯空行 ping 事件,但可通过构造特殊空评论(comment)的方式生成符合规范的 :\n\n 心跳帧,实现 graphql sse 协议要求的连接保活。

spring web 的 serversentevent 默认不支持纯空行 ping 事件,但可通过构造特殊空评论(comment)的方式生成符合规范的 :\n\n 心跳帧,实现 graphql sse 协议要求的连接保活。

在基于 Server-Sent Events(SSE)构建实时流式 API(如 GraphQL over SSE)时,客户端与服务端需维持长连接,并通过周期性心跳(ping)检测连接活性。根据 GraphQL SSE 规范,心跳必须以纯注释行形式发送::\n\n(即冒号后跟两个换行符),且不能包含 event:、data: 或 id: 等字段——这恰好避开了标准 ServerSentEvent 对非空 data 或显式 type 的约束。

Spring Framework 并未提供直接的 .ping() 方法,但其底层 ServerSentEventHttpMessageWriter 在序列化时遵循 SSE 标准:当仅设置 comment 字段(且值为空字符串)时,会输出 : + \n;若其他字段(data, event, id, retry)均未设置,则自动追加一个 \n,最终形成合规的 :\n\n。

✅ 正确实现方式(Java):

ServerSentEvent<void> pingEvent = ServerSentEvent.builder("")
    .data(null)        // 显式设为 null,避免默认空字符串干扰
    .comment("")       // 关键:空评论触发 ":" + "\n"
    .build();          // 无其他字段 → 自动补第二个 "\n"</void>

✅ Kotlin 写法更简洁(利用泛型推导):

val pingEvent = ServerSentEvent.builder<string>()
    .comment("")
    .build()</string>

⚠️ 注意事项:

  • 不可省略 .builder("") 中的空字符串参数:它是 type 字段的占位符(即使为空),否则编译失败(Java 泛型擦除导致类型推导失效);
  • 禁止设置 data("") 或 data(" "):这将触发 data: \n 行,破坏 ping 格式;
  • 不要依赖 ServerSentEvent.EMPTY:它生成的是空响应体,不输出任何内容,无法触发心跳;
  • 实际使用中,建议配合 Flux.interval() 定期发送(例如每 15 秒一次),并确保 SseEmitter 未关闭:
    Flux.interval(Duration.ofSeconds(15))
        .map(tick -> pingEvent)
        .subscribe(emitter::send);

总结:Spring Web 虽未显式暴露 ping 接口,但通过精准控制 ServerSentEvent 的构造参数(空 type + 空 comment + 全部其他字段留空),即可严格遵循 SSE 规范生成心跳帧,为 GraphQL SSE 等协议提供可靠连接保活能力。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

2025.08.06

2451

22

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

2026.01.26

457

25

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

2026.10.10

40

15

Kratos框架HTTP与gRPC服务开发教程
Kratos框架HTTP与gRPC服务开发教程

本专题围绕Kratos框架双协议服务开发,涵盖HTTP路由与处理器编写、参数获取、gRPC服务实现与客户端调用、metadata上下文传递、encoding编解码注册、统一响应封装、超时控制与流式响应实现方法。

2026.10.10

20

15

Kratos框架Protobuf接口定义与代码生成合集
Kratos框架Protobuf接口定义与代码生成合集

本专题讲解Kratos框架接口定义体系,涵盖proto编写规范、proto add/client/server生成命令、http注解路由、validate校验、OpenAPI文档生成、跨服务proto复用与兼容性设计。

2026.10.10

0

15

C++虚函数怎么定义和调用
C++虚函数怎么定义和调用

C++虚函数是实现运行时多态的重要机制。本专题从virtual关键字的基本用法入手,介绍基类与派生类之间的函数重写、基类指针调用派生类方法,以及动态绑定的执行过程,帮助初学者掌握虚函数的核心语法。

2026.10.10

20

26

C++类与对象的封装方法教程
C++类与对象的封装方法教程

C++封装是面向对象编程的核心特性之一,通过类将数据与操作数据的函数组织在一起,并利用访问权限控制外部访问。本专题介绍类的定义、成员变量、成员函数以及public、private和protected的使用方法,帮助初学者掌握封装的基本原理。

2026.10.10

20

32

C++构造函数定义与调用方法
C++构造函数定义与调用方法

C++构造函数用于初始化类对象,是面向对象编程的重要基础。本专题从构造函数的定义、声明和调用入手,介绍默认构造函数、带参数构造函数、拷贝构造函数及成员初始化列表,帮助初学者掌握对象创建与初始化的基本方法。

2026.10.10

20

16

Kratos框架零基础入门教程
Kratos框架零基础入门教程

本专题整理Kratos框架入门内容,涵盖Go环境准备、kratos CLI安装升级、new命令创建项目、目录结构分层说明、服务启动与双协议端口、依赖下载报错排查,帮助开发者快速跑通第一个Kratos框架微服务应用。

2026.10.10

20

15

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习