在 C# 中实现发送服务器发送事件（没有 ASP.NET / MVC / ...）

Question

对于一个项目，我需要在 C# 应用程序中实现 SSE (Server Sent Events)。虽然这听起来很容易，但我不知道如何解决这个问题。

由于我是 C# 新手（尽管对一般编程并不陌生），所以我去 Google 游览并试图寻找一些示例代码。根据我目前所见，我可以学习使用 C# 或 consume 服务器发送事件构建 HTTP 服务器。但是我没有发现任何关于发送 SSE 的信息。

我想弄清楚的是：我怎样才能通过传入的请求继续发送更新的数据？ 通常，你收到一个请求，做你的事并回复。完成，连接关闭。但在这种情况下，每次我的应用程序中的事件触发时，我都想“坚持”到响应流并发送新数据。

对我来说，问题在于这种基于事件的方法：它不是基于间隔的轮询和更新。更确切地说，该应用程序就像“嘿，发生了一些事情。我真的应该告诉你！”

TL;DR：我怎样才能保持响应流并发送更新 - 不是基于循环或计时器，而是每次触发某些事件？

另外，在我忘记之前：我知道，那里有图书馆正在这样做。但从我目前所见（以及我所理解的；如果我错了，请纠正我）这些解决方案取决于 ASP.NET / MVC / 你的名字。由于我只是在编写一个“普通”的 C# 应用程序，我认为我不符合这些要求。

Answer 1

至于轻量级服务器，我会使用 OWIN 自托管 WebAPI (https://docs.microsoft.com/en-us/aspnet/web-api/overview/hosting-aspnet-web-api/use-owin-to-self-host-web-api)。

一个简单的服务器发送事件服务器操作基本上是这样的：

public class EventController : ApiController
  {
    public HttpResponseMessage GetEvents(CancellationToken clientDisconnectToken)
    {
      var response = Request.CreateResponse();
      response.Content = new PushStreamContent(async (stream, httpContent, transportContext) =>
      {
        using (var writer = new StreamWriter(stream))
        {
          using (var consumer = new BlockingCollection<string>())
          {
            var eventGeneratorTask = EventGeneratorAsync(consumer, clientDisconnectToken);
            foreach (var @event in consumer.GetConsumingEnumerable(clientDisconnectToken))
            {
              await writer.WriteLineAsync("data: " + @event);
              await writer.WriteLineAsync();
              await writer.FlushAsync();
            }
            await eventGeneratorTask;
          }
        }
      }, "text/event-stream");
      return response;
    }

    private async Task EventGeneratorAsync(BlockingCollection<string> producer, CancellationToken cancellationToken)
    {
      try
      {
        while (!cancellationToken.IsCancellationRequested)
        {
          producer.Add(DateTime.Now.ToString(), cancellationToken);
          await Task.Delay(1000, cancellationToken).ConfigureAwait(false);
        }
      }
      finally
      {
        producer.CompleteAdding();
      }
    }
  }

这里的重要部分是 PushStreamContent，它基本上只是发送 HTTP 标头，然后在可用时保持连接打开以写入数据。

在我的示例中，事件是在一个额外任务中生成的，该任务被赋予一个生产者-消费者集合，如果事件可用于集合，则添加事件（这里是每秒的当前时间）。每当有新事件到达时，都会自动通知 GetConsumingEnumerable。然后以正确的服务器发送事件格式将新事件写入流并刷新。在实践中，您需要每分钟左右发送一些伪 ping 事件，因为长时间保持打开而没有通过它们发送数据的流将被操作系统/框架关闭。

用于测试的示例客户端代码如下：

在异步方法中编写以下代码。

using (var client = new HttpClient())
{
  using (var stream = await client.GetStreamAsync("http://localhost:9000/api/event"))
  {
    using (var reader = new StreamReader(stream))
    {
      while (true)
      {
        Console.WriteLine(reader.ReadLine());
      }
    }
  }
}

Answer 2

这听起来很适合SignalR。注意 SignalR 是 ASP.NET 家族的一部分，但它不需要 ASP.NET 框架 (System.Web) 或 IIS，如 cmets 中所述。

澄清一下，SignalR 是 ASP.NET 的一部分。根据他们的网站：

ASP.NET 是一个用于构建现代 Web 应用程序的开源 Web 框架 和 .NET 服务。 ASP.NET 基于 HTML5、CSS、 和 JavaScript 简单、快速、可扩展至数百万 用户。

SignalR 对 System.Web 或 IIS 没有硬依赖。

您可以自行托管您的 ASP.Net 应用程序（请参阅https://docs.microsoft.com/en-us/aspnet/signalr/overview/deployment/tutorial-signalr-self-host）。如果你使用 .net core，它实际上是默认自托管的，并作为一个普通的控制台应用程序运行。