.NET 中优雅处理 Server-Sent Events 请求取消：避免 OperationCanceledException 的全面指南
引言
随着实时 Web 应用的普及，Server-Sent Events (SSE) 凭借其轻量、基于 HTTP 的优势，成为服务端向客户端推送实时数据的常用方案。.NET 6 引入的 TypedResults.ServerSentEvents 工厂方法极大地简化了 SSE 端点的构建，开发者只需提供一个异步可枚举的 ServerSentEvent 序列，框架便自动处理响应头、编码和事件格式。
然而，在实际生产环境中，一个棘手的问题随之而来：当客户端断开连接时，框架会抛出 OperationCanceledException（或 IOException），异常会一路冒泡至 ASP.NET Core 的请求管道，被记录为错误，并导致响应流非正常终止。这不仅污染了应用日志，还可能触发不必要的告警，甚至影响性能。
本文将深入剖析该问题的根源，并给出三种行之有效的解决方案，帮助你在使用 TypedResults.ServerSentEvents 时彻底避免异常抛出，实现优雅的客户端断开处理。
问题复现
一个典型的 SSE 端点代码如下：
app.MapGet("/sse", () =>
{async IAsyncEnumerable<ServerSentEvent> GetEvents(){while (true){yield return new ServerSentEvent { Data = $"Time: {DateTime.Now:T}" };await Task.Delay(1000);}}return TypedResults.ServerSentEvents(GetEvents());
});
当客户端连接后主动断开（如关闭浏览器、刷新页面），await Task.Delay(1000) 会因 CancellationToken 被取消而抛出 OperationCanceledException。即便你异步迭代器中捕获了异常，框架在执行 ServerSentEventsResult.ExecuteAsync 写入响应流时，同样可能因管道中断而抛出异常。这些异常最终会逃逸到 Kestrel 层，被记录为类似如下的日志：
Microsoft.AspNetCore.Server.Kestrel: Warning: Connection processing of an HTTP/1.x connection was stopped abnormally.
System.OperationCanceledException: The operation was canceled.
问题的核心在于：框架本身不负责捕获并处理取消相关的异常，而是将其交由开发者控制。
解决方案总览
要彻底避免异常抛出，思路只有一个：在异常到达框架之前主动捕获并处理。根据具体场景，可以选择以下方案：
| 方案 | 适用场景 | 优点 | 缺点 |
|---|---|---|---|
| 手动执行 + 异常捕获 | 需要完全控制 SSE 发送过程 | 清晰、无额外抽象 | 端点需返回 Task 而非 IResult |
| 自定义 IResult 封装 | 多处使用，追求复用性 | 保持 IResult 返回风格，复用性好 |
增加少量抽象 |
| 日志过滤 | 仅想减少日志噪音 | 配置简单 | 无法阻止异常抛出，仅抑制日志 |
以下详细介绍前两种核心方案。
方案一：手动执行 ExecuteAsync 并捕获取消异常（推荐）
这是最直接、最灵活的方法。我们不在端点中直接返回 TypedResults.ServerSentEvents(...)，而是手动创建结果对象并调用其 ExecuteAsync 方法，并将整个调用包裹在 try-catch 中。
实现步骤
-
定义带取消令牌的异步迭代器
使用[EnumeratorCancellation]特性将CancellationToken注入迭代器，并在循环内部捕获取消异常，确保迭代器能够正常结束。 -
创建
ServerSentEventsResult对象
通过TypedResults.ServerSentEvents创建结果实例。 -
手动执行并捕获异常
调用ExecuteAsync并捕获OperationCanceledException，在此处静默结束或执行清理逻辑。
完整代码示例
app.MapGet("/sse", async (HttpContext context) =>
{// 1. 事件源，内部处理取消async IAsyncEnumerable<ServerSentEvent> GetEvents([EnumeratorCancellation] CancellationToken cancellationToken){try{while (!cancellationToken.IsCancellationRequested){yield return new ServerSentEvent { Data = $"Time: {DateTime.Now:T}" };await Task.Delay(1000, cancellationToken);}}catch (OperationCanceledException){// 取消时正常结束迭代，不再抛出异常}}// 2. 创建 SSE 结果var sseResult = TypedResults.ServerSentEvents(GetEvents(context.RequestAborted));// 3. 手动执行，捕获外层写入异常try{await sseResult.ExecuteAsync(context);}catch (OperationCanceledException){// 客户端断开连接，静默结束// 可在此添加日志或清理工作}
});
关键点解析：
- 双重捕获：内层捕获迭代器内的取消异常（如
Task.Delay触发），外层捕获ExecuteAsync写入流时的异常。两者缺一不可。 EnumeratorCancellation：允许将HttpContext.RequestAborted传递给迭代器，实现及时停止事件生成。- 端点签名：必须返回
Task（或Task派生类型），不能返回IResult，否则无法手动调用ExecuteAsync。
此方案将控制权完全交给开发者，既保留了 TypedResults.ServerSentEvents 的所有格式化功能，又实现了零异常逃逸。
方案二：自定义 IResult 封装（追求复用）
如果你的应用中多处需要 SSE 端点，且希望保持 return 语句的简洁，可以将上述逻辑封装成一个自定义 IResult 实现，并通过扩展方法提供类似 TypedResults 的调用体验。
自定义 SafeServerSentEventsResult
public class SafeServerSentEventsResult : IResult
{private readonly IAsyncEnumerable<ServerSentEvent> _events;public SafeServerSentEventsResult(IAsyncEnumerable<ServerSentEvent> events){_events = events;}public async Task ExecuteAsync(HttpContext httpContext){var result = TypedResults.ServerSentEvents(_events);try{await result.ExecuteAsync(httpContext);}catch (OperationCanceledException){// 静默结束，不抛出异常}}
}public static class SafeResults
{public static SafeServerSentEventsResult ServerSentEvents(IAsyncEnumerable<ServerSentEvent> events)=> new(events);
}
使用方式
app.MapGet("/sse", async (CancellationToken cancellationToken) =>
{async IAsyncEnumerable<ServerSentEvent> GetEvents(){try{while (!cancellationToken.IsCancellationRequested){yield return new ServerSentEvent { Data = $"Time: {DateTime.Now:T}" };await Task.Delay(1000, cancellationToken);}}catch (OperationCanceledException) { }}return SafeResults.ServerSentEvents(GetEvents());
});
这样，你的端点依然可以返回 IResult，而异常处理被完美封装在自定义结果中，实现了关注点分离。
辅助手段：配置日志过滤
需要明确的是：配置日志过滤并不能阻止异常抛出，它只能让这些异常不被记录到日志中，异常依然会传播并可能影响后续中间件（如异常处理中间件）。因此它不应作为主要解决方案，仅可作为额外措施，用于减少日志噪音。
builder.Logging.AddFilter("Microsoft.AspNetCore.Server.Kestrel", LogLevel.Warning);
// 或更精准地过滤特定异常类别
builder.Logging.AddFilter("Microsoft.AspNetCore.Http.Connections", LogLevel.Warning);
总结与最佳实践
| 要点 | 推荐做法 |
|---|---|
| 取消异常处理 | 必须主动捕获，不能依赖框架或日志过滤 |
| 代码结构 | 优先选择方案一，简单直接；若多处使用可考虑方案二封装 |
| 异步迭代器 | 始终使用 [EnumeratorCancellation] CancellationToken 并捕获取消异常 |
| 性能 | 异常捕获有微小开销，但相对于 SSE 长连接可以忽略 |
| 兼容性 | 适用于 .NET 6 / 7 / 8 / 9 及更高版本 |
Server-Sent Events 是强大的实时通信工具，TypedResults.ServerSentEvents 更是将其易用性提升到新高度。通过本文介绍的异常处理模式，你可以在生产环境中放心使用 SSE，而不再担心客户端断开会引发异常风暴。
希望这篇指南能帮助你构建更健壮、更安静的 SSE 服务。如有任何疑问或更佳实践，欢迎在评论区交流讨论。