ASPNET Core 服务器发送事件/响应刷新

Question

虽然没有官方文档，但有谁知道如何使用 ASP.NET Core 实现 SSE？

我怀疑一种实现可能会使用自定义中间件，但也许可以在控制器操作中做到这一点？

Answer 1

客户端 - wwwroot/index.html

在页面加载时，为 http://www.somehost.ca/sse 网址创建一个 EventSource。然后将其事件写入控制台。

<body>
    <script type="text/javascript">

        var source = new EventSource('sse');

        source.onmessage = function (event) {
            console.log('onmessage: ' + event.data);
        };

        source.onopen = function(event) {
            console.log('onopen');
        };

        source.onerror = function(event) {
            console.log('onerror');
        }

    </script>
</body>

服务器端替代方案 #1 - 使用中间件

中间件处理sse 路径。它将Content-Type 标头设置为text/event-stream，这是服务器套接字事件所需的。它写入响应流，而不关闭连接。它通过在写入之间延迟五秒钟来模仿工作。

app.Use(async (context, next) =>
{
    if (context.Request.Path.ToString().Equals("/sse"))
    {
        var response = context.Response;
        response.Headers.Add("Content-Type", "text/event-stream");

        for(var i = 0; true; ++i)
        {
            // WriteAsync requires `using Microsoft.AspNetCore.Http`
            await response
                .WriteAsync($"data: Middleware {i} at {DateTime.Now}\r\r");

            await response.Body.FlushAsync();
            await Task.Delay(5 * 1000);
        }
    }

    await next.Invoke();
});

服务器端替代方案 #2 - 使用控制器

控制器的作用与中间件完全相同。

[Route("/api/sse")]
public class ServerSentEventController : Controller
{
    [HttpGet]
    public async Task Get()
    {
        var response = Response;
        response.Headers.Add("Content-Type", "text/event-stream");

        for(var i = 0; true; ++i)
        {
            await response
                .WriteAsync($"data: Controller {i} at {DateTime.Now}\r\r");

            response.Body.Flush();
            await Task.Delay(5 * 1000);
        }
    }
}

Firefox 中的客户端控制台输出

这是 Firefox 控制台窗口中的结果。每五秒钟就有一条新消息到达。

onopen
onmessage: Message 0 at 4/15/2016 3:39:04 PM
onmessage: Message 1 at 4/15/2016 3:39:09 PM
onmessage: Message 2 at 4/15/2016 3:39:14 PM
onmessage: Message 3 at 4/15/2016 3:39:19 PM
onmessage: Message 4 at 4/15/2016 3:39:24 PM

参考文献：

• The above sample on GitHub
• The HTML Living Standard, section 9.2 Server-sent events
• Http Push Technology on Wikipedia
• Chunked transfer encoding

Answer 2

服务器发送的事件可以完全在控制器动作中实现。

这是基于 Shaun Luttin 的回答，但它更像是一个真实世界的示例，它将无限期地保持打开连接，并发送消息到 EventSource 以响应正在创建的消息。

using Example.Models;
using Example.Repositories;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Newtonsoft.Json;
using Newtonsoft.Json.Serialization;
using System;
using System.Threading;
using System.Threading.Tasks;

namespace Example.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class SseMessagesController : ControllerBase
    {
        private readonly IMessageRepository messageRepository;
        private readonly JsonSerializerSettings jsonSettings;

        public SseMessagesController(IMessageRepository messageRepository)
        {
            this.messageRepository = messageRepository;
            this.jsonSettings = new JsonSerializerSettings();
            jsonSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();
        }

        [HttpGet]
        public async Task GetMessages(CancellationToken cancellationToken)
        {
            Response.StatusCode = 200;
            Response.Headers.Add("Content-Type", "text/event-stream");

            EventHandler<MessageCreatedArgs> onMessageCreated = async (sender, eventArgs) =>
            {
                try
                {
                    var message = eventArgs.Message;
                    var messageJson = JsonConvert.SerializeObject(message, jsonSettings);
                    await Response.WriteAsync($"data:{messageJson}\n\n");
                    await Response.Body.FlushAsync();
                }
                catch (Exception)
                {
                    // TODO: log error
                }
            };
            messageRepository.MessageCreated += onMessageCreated;

            while (!cancellationToken.IsCancellationRequested) {
                await Task.Delay(1000);
            }

            messageRepository.MessageCreated -= onMessageCreated;
        }
    }
}

每当EventSource 连接到/api/ssemessages 时，我们都会向消息存储库上的MessageCreated 事件添加一个事件委托。然后我们每隔1秒检查一下EventSource是否已经关闭，这会导致请求被取消。一旦请求被取消，我们就会移除事件委托。

事件委托从事件参数中获取Message对象，将其序列化为 JSON（使用驼峰式大小写与 ASP.NET Core 在返回对象结果时的默认行为一致），将 JSON 写入主体，然后刷新正文的流以将数据推送到EventSource。

有关创建事件委托的更多信息，请参阅 this article 和 this update for .NET Core。

另外，如果你在 Nginx 后面托管这个，你会想要阅读 this SO answer 和 this ServerFault answer。