首页
/ ASP.NET Core 10 中的 Server-Sent Events 支持解析

ASP.NET Core 10 中的 Server-Sent Events 支持解析

2025-05-18 19:28:26作者:尤辰城Agatha

Server-Sent Events (SSE) 是一种允许服务器向客户端推送更新的技术,它在需要实时单向数据流的场景中非常有用。ASP.NET Core 10 Preview 3 版本为 Minimal APIs 引入了对 SSE 的原生支持,这为开发者提供了更简洁高效的方式来构建实时应用。

什么是 Server-Sent Events

Server-Sent Events 是基于 HTTP 的轻量级协议,它允许服务器通过持久连接向客户端推送数据。与 WebSocket 不同,SSE 是单向的(仅服务器到客户端),但实现更简单,自动处理重连机制,并且可以直接使用 HTTP 协议而不需要额外升级。

典型的 SSE 应用场景包括:

  • 实时通知系统
  • 股票行情推送
  • 新闻订阅
  • 进度更新反馈

ASP.NET Core 10 中的 SSE 实现

在 ASP.NET Core 10 中,Minimal APIs 通过新的结果类型简化了 SSE 的实现。开发者现在可以使用专门的 SseResult 类型来创建 SSE 端点,而不需要手动处理底层响应流。

基本用法示例

app.MapGet("/sse", async () => 
{
    async IAsyncEnumerable<string> GetEvents()
    {
        while (true)
        {
            yield return $"当前时间: {DateTime.Now}";
            await Task.Delay(1000);
        }
    }
    
    return new SseResult(GetEvents());
});

这个简单的示例每秒向客户端发送一次当前时间。SseResult 包装了一个异步可枚举对象,自动处理了 SSE 协议要求的格式化和流传输。

高级特性

事件类型和重试控制

SSE 协议支持定义事件类型和重试间隔:

app.MapGet("/advanced-sse", async () =>
{
    async IAsyncEnumerable<SseEvent> GetEvents()
    {
        var retryMs = 1000;
        while (true)
        {
            yield return new SseEvent(
                data: $"服务器时间: {DateTime.Now}",
                type: "timeUpdate",
                retry: retryMs);
            
            await Task.Delay(5000);
            retryMs += 1000; // 每次重试间隔增加1秒
        }
    }
    
    return new SseResult(GetEvents());
});

错误处理和连接管理

SSE 连接会自动处理客户端断开和重连。服务器端可以通过捕获异常来监控连接状态:

app.MapGet("/monitored-sse", async (HttpContext context) =>
{
    try
    {
        async IAsyncEnumerable<string> GetEvents()
        {
            while (!context.RequestAborted.IsCancellationRequested)
            {
                yield return $"心跳: {DateTime.Now}";
                await Task.Delay(1000);
            }
        }
        
        return new SseResult(GetEvents());
    }
    catch (Exception ex)
    {
        logger.LogError(ex, "SSE连接异常");
        return Results.StatusCode(500);
    }
});

性能考量

使用 SSE 时应注意以下几点:

  1. 每个 SSE 连接都会保持一个开放的 HTTP 连接,服务器资源消耗会随客户端数量线性增长
  2. 对于高并发场景,考虑使用连接池或负载均衡
  3. 消息频率不宜过高,避免网络拥塞
  4. 适当设置客户端重试策略,减轻服务器压力

与传统实现的对比

在 ASP.NET Core 10 之前,实现 SSE 需要手动处理响应流:

app.MapGet("/legacy-sse", async (HttpContext context) =>
{
    context.Response.ContentType = "text/event-stream";
    
    try
    {
        while (true)
        {
            await context.Response.WriteAsync($"data: {DateTime.Now}\n\n");
            await context.Response.Body.FlushAsync();
            await Task.Delay(1000);
        }
    }
    catch (Exception)
    {
        // 处理断开连接
    }
});

新的 SseResult 方式不仅代码更简洁,而且自动处理了协议细节,如正确的事件流格式、连接管理和错误处理。

适用场景建议

SSE 最适合以下场景:

  • 需要服务器向客户端推送更新
  • 数据更新频率适中(每秒几次到每分钟几次)
  • 不需要客户端向服务器发送大量数据
  • 需要兼容性较好的实时解决方案(SSE 在所有现代浏览器中都支持)

对于需要双向通信或高频更新的场景,WebSocket 可能是更好的选择。

总结

ASP.NET Core 10 对 Server-Sent Events 的原生支持显著简化了实时功能的开发。新的 SseResult 类型让开发者能够专注于业务逻辑而不是协议细节,同时提供了足够的灵活性来处理各种实时数据推送场景。这一改进使得 ASP.NET Core 在构建现代实时 Web 应用方面更加全面和强大。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
118
1.88 K
kernelkernel
deepin linux kernel
C
22
6
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
341
1.24 K
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
191
271
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
912
546
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
377
388
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
143
188
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
68
58
harmony-utilsharmony-utils
harmony-utils 一款功能丰富且极易上手的HarmonyOS工具库,借助众多实用工具类,致力于助力开发者迅速构建鸿蒙应用。其封装的工具涵盖了APP、设备、屏幕、授权、通知、线程间通信、弹框、吐司、生物认证、用户首选项、拍照、相册、扫码、文件、日志,异常捕获、字符、字符串、数字、集合、日期、随机、base64、加密、解密、JSON等一系列的功能和操作,能够满足各种不同的开发需求。
ArkTS
81
2