0

0

C# Server-Sent Events (SSE)实现方法 C# ASP.NET Core如何实现SSE

幻夢星雲

幻夢星雲

发布时间:2026-02-07 08:52:47

|

457人浏览过

|

来源于php中文网

原创

ASP.NET Core 6+ 中最简单返回 SSE 流的方式是手动写入 HttpResponse.Body 并设置响应头:StatusCode=200、ContentType="text/event-stream"、Cache-Control="no-cache"、Connection="keep-alive",每次写入 data: 消息后调用 FlushAsync,且所有 await 必须传入 HttpContext.RequestAborted 以防止资源泄漏。

c# server-sent events (sse)实现方法 c# asp.net core如何实现sse

ASP.NET Core 6+ 中用 IActionResult 返回 SSE 流最简单

不需要引入第三方库,.NET 6 起内置了对 Server-Sent Events 的基础支持。核心是返回一个持续写入的 FileStreamResult 或更推荐的 StreamingFileResult 变体——但实际最稳妥的是直接用 HttpResponse 写入原始流,并手动设置响应头。

关键点:必须禁用响应缓冲、设置正确的 MIME 类型和缓存策略,否则浏览器收不到实时事件。

  • Response.StatusCode = 200
  • Response.ContentType = "text/event-stream"
  • Response.Headers.Add("Cache-Control", "no-cache")
  • Response.Headers.Add("Connection", "keep-alive")
  • 调用 Response.Body.FlushAsync() 每次写完一行后(尤其在开发环境 IIS Express 下容易卡住)

HttpResponse 手动写入 SSE 格式数据

SSE 协议本身极轻量:每条消息由若干字段行(data:id:event:retry:)组成,空行分隔。浏览器只认 data: 开头的行,且会自动拼接多行 data: 成一个完整字符串。

示例片段(在 Controller Action 中):

Response.StatusCode = 200;
Response.ContentType = "text/event-stream";
Response.Headers.Add("Cache-Control", "no-cache");
Response.Headers.Add("Connection", "keep-alive");

var writer = new StreamWriter(Response.Body, Encoding.UTF8) { AutoFlush = true };
while (!HttpContext.RequestAborted.IsCancellationRequested)
{
    await writer.WriteLineAsync($"data: {{\"time\":\"{DateTime.Now:O}\"}}");
    await writer.WriteLineAsync("");
    await Task.Delay(1000, HttpContext.RequestAborted);
}

注意:AutoFlush = true 很重要;若不用 StreamWriter,直接用 Response.Body.WriteAsync,记得每次写完调 FlushAsync

避免 JsonSerializerSystem.Text.Json 自动换行导致格式错误

如果用 JsonSerializer.Serialize 输出对象再写入流,它默认不换行,但你仍需手动加 data: 前缀和末尾空行。更麻烦的是,若 JSON 含换行符(如字符串里有 \n),SSE 会把它当成消息分隔,导致解析失败。

剪小映
剪小映

记录美好智能成片,AI智能视频剪辑

下载
  • 不要直接 WriteAsync(JsonSerializer.Serialize(obj))
  • 应先序列化为单行 JSON:JsonSerializerOptions options = new() { WriteIndented = false };
  • 然后拼接:await writer.WriteLineAsync($"data: {json}");
  • 严格确保每条消息以 data: 开始、以空行结束

客户端断连时如何安全清理后台任务

ASP.NET Core 不会自动取消已启动的异步循环。若用户关闭页面或网络中断,HttpContext.RequestAborted 是唯一可靠信号,但必须在所有 await 点都传入它。

常见陷阱:

  • 忘记在 Task.Delay(1000) 里传 HttpContext.RequestAborted → 任务继续跑,资源泄漏
  • while (true) 但没检查 IsCancellationRequested → 无法退出
  • 在循环中启动新 Task.Run 且未绑定 CancellationToken → 彻底失控

真正可靠的模式是:整个循环逻辑在一个 async 方法里,每个 await 都带 token,外层用 try/finallyusing 清理资源(比如取消 Timer、释放数据库连接等)。

真实项目里,SSE 很少裸写循环;多数会结合 IAsyncEnumerable + ChannelReaderIObservable 做解耦,但底层响应流的写法和头设置逻辑完全一致。最容易被忽略的,其实是 FlushAsync 的调用时机和 RequestAborted 的全程穿透 —— 这两点一漏,就变成“看似能发,实则收不到”或者“服务端悄悄堆积数百个僵尸任务”。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

430

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

541

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

313

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

79

2025.09.10

while的用法
while的用法

while的用法是“while 条件: 代码块”,条件是一个表达式,当条件为真时,执行代码块,然后再次判断条件是否为真,如果为真则继续执行代码块,直到条件为假为止。本专题为大家提供while相关的文章、下载、课程内容,供大家免费下载体验。

98

2023.09.25

登录token无效
登录token无效

登录token无效解决方法:1、检查token的有效期限,如果token已经过期,需要重新获取一个新的token;2、检查token的签名,如果签名不正确,需要重新获取一个新的token;3、检查密钥的正确性,如果密钥不正确,需要重新获取一个新的token;4、使用HTTPS协议传输token,建议使用HTTPS协议进行传输 ;5、使用双因素认证,双因素认证可以提高账户的安全性。

6321

2023.09.14

登录token无效怎么办
登录token无效怎么办

登录token无效的解决办法有检查Token是否过期、检查Token是否正确、检查Token是否被篡改、检查Token是否与用户匹配、清除缓存或Cookie、检查网络连接和服务器状态、重新登录或请求新的Token、联系技术支持或开发人员等。本专题为大家提供token相关的文章、下载、课程内容,供大家免费下载体验。

829

2023.09.14

token怎么获取
token怎么获取

获取token值的方法:1、小程序调用“wx.login()”获取 临时登录凭证code,并回传到开发者服务器;2、开发者服务器以code换取,用户唯一标识openid和会话密钥“session_key”。想了解更详细的内容,可以阅读本专题下面的文章。

1077

2023.12.21

Golang处理数据库错误教程合集
Golang处理数据库错误教程合集

本专题整合了Golang数据库错误处理方法、技巧、管理策略相关内容,阅读专题下面的文章了解更多详细内容。

2

2026.02.06

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.9万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号