在 ASP.NET Core 中使用流式处理 SignalRUse streaming in ASP.NET Core SignalR

本文内容

作者： Brennan Conroy

ASP.NET Core SignalR 支持从客户端传输到服务器以及从服务器传输到客户端。这适用于数据片段随着时间的推移而发生的情况。流式传输时，每个片段一旦变为可用，就会发送到客户端或服务器，而不是等待所有数据都可用。

ASP.NET Core SignalR 支持服务器方法的流返回值。这适用于数据片段随着时间的推移而发生的情况。将返回值流式传输到客户端时，每个片段会在其可用时立即发送到客户端，而不是等待所有数据都可用。

查看或下载示例代码（如何下载）

设置用于流式传输的集线器Set up a hub for streaming

当集线器方法返回 IAsyncEnumerable<T>、ChannelReader<T>、Task<IAsyncEnumerable<T>>或 Task<ChannelReader<T>>时，它会自动变为流式处理中心方法。

当集线器方法返回 ChannelReader<T> 或 Task<ChannelReader<T>>时，该方法会自动变为流式处理中心方法。

服务器到客户端流式处理Server-to-client streaming

除了 ChannelReader<T>之外，流式处理中心方法还可以返回 IAsyncEnumerable<T>。返回 IAsyncEnumerable<T> 的最简单方法是将集线器方法设为异步迭代器方法，如下例所示。中心异步迭代器方法可以接受当客户端从流中取消订阅时触发的 CancellationToken 参数。异步迭代器方法避免了与通道常见的问题，例如，不能尽早返回 ChannelReader 或退出方法，无需完成 ChannelWriter<T>。

备注

以下示例需要C# 8.0 或更高版本。

  1. public class AsyncEnumerableHub : Hub
  2. {
  3.     public async IAsyncEnumerable<int> Counter(
  4.         int count,
  5.         int delay,
  6.         [EnumeratorCancellation]
  7.         CancellationToken cancellationToken)
  8.     {
  9.         for (var i = 0; i < count; i++)
  10.         {
  11.             // Check the cancellation token regularly so that the server will stop
  12.             // producing items if the client disconnects.
  13.             cancellationToken.ThrowIfCancellationRequested();
  15.             yield return i;
  17.             // Use the cancellationToken in other APIs that accept cancellation
  18.             // tokens so the cancellation can flow down to them.
  19.             await Task.Delay(delay, cancellationToken);
  20.         }
  21.     }
  22. }

下面的示例演示了使用通道将数据流式传输到客户端的基础知识。每当将对象写入 ChannelWriter<T>时，都会立即将对象发送到客户端。最后，ChannelWriter 完成，告诉客户端流已关闭。

备注

在后台线程上写入 ChannelWriter<T>，并尽快返回 ChannelReader。其他中心调用会被阻止，直到返回 ChannelReader。

try … catch中的环绕逻辑。完成 catch 和 catch 之外的 Channel，确保中心方法调用正确完成。

  1. public ChannelReader<int> Counter(
  2.     int count,
  3.     int delay,
  4.     CancellationToken cancellationToken)
  5. {
  6.     var channel = Channel.CreateUnbounded<int>();
  8.     // We don't want to await WriteItemsAsync, otherwise we'd end up waiting 
  9.     // for all the items to be written before returning the channel back to
  10.     // the client.
  11.     _ = WriteItemsAsync(channel.Writer, count, delay, cancellationToken);
  13.     return channel.Reader;
  14. }
  16. private async Task WriteItemsAsync(
  17.     ChannelWriter<int> writer,
  18.     int count,
  19.     int delay,
  20.     CancellationToken cancellationToken)
  21. {
  22.     Exception localException = null;
  23.     try
  24.     {
  25.         for (var i = 0; i < count; i++)
  26.         {
  27.             await writer.WriteAsync(i, cancellationToken);
  29.             // Use the cancellationToken in other APIs that accept cancellation
  30.             // tokens so the cancellation can flow down to them.
  31.             await Task.Delay(delay, cancellationToken);
  32.         }
  33.     }
  34.     catch (Exception ex)
  35.     {
  36.         localException = ex;
  37.     }
  39.     writer.Complete(localException);
  40. }
  1. public class StreamHub : Hub
  2. {
  3.     public ChannelReader<int> Counter(
  4.         int count,
  5.         int delay,
  6.         CancellationToken cancellationToken)
  7.     {
  8.         var channel = Channel.CreateUnbounded<int>();
  10.         // We don't want to await WriteItemsAsync, otherwise we'd end up waiting
  11.         // for all the items to be written before returning the channel back to
  12.         // the client.
  13.         _ = WriteItemsAsync(channel.Writer, count, delay, cancellationToken);
  15.         return channel.Reader;
  16.     }
  18.     private async Task WriteItemsAsync(
  19.         ChannelWriter<int> writer,
  20.         int count,
  21.         int delay,
  22.         CancellationToken cancellationToken)
  23.     {
  24.         try
  25.         {
  26.             for (var i = 0; i < count; i++)
  27.             {
  28.                 // Check the cancellation token regularly so that the server will stop
  29.                 // producing items if the client disconnects.
  30.                 cancellationToken.ThrowIfCancellationRequested();
  31.                 await writer.WriteAsync(i);
  33.                 // Use the cancellationToken in other APIs that accept cancellation
  34.                 // tokens so the cancellation can flow down to them.
  35.                 await Task.Delay(delay, cancellationToken);
  36.             }
  37.         }
  38.         catch (Exception ex)
  39.         {
  40.             writer.TryComplete(ex);
  41.         }
  43.         writer.TryComplete();
  44.     }
  45. }
  1. public class StreamHub : Hub
  2. {
  3.     public ChannelReader<int> Counter(int count, int delay)
  4.     {
  5.         var channel = Channel.CreateUnbounded<int>();
  7.         // We don't want to await WriteItemsAsync, otherwise we'd end up waiting 
  8.         // for all the items to be written before returning the channel back to
  9.         // the client.
  10.         _ = WriteItemsAsync(channel.Writer, count, delay);
  12.         return channel.Reader;
  13.     }
  15.     private async Task WriteItemsAsync(
  16.         ChannelWriter<int> writer,
  17.         int count,
  18.         int delay)
  19.     {
  20.         try
  21.         {
  22.             for (var i = 0; i < count; i++)
  23.             {
  24.                 await writer.WriteAsync(i);
  25.                 await Task.Delay(delay);
  26.             }
  27.         }
  28.         catch (Exception ex)
  29.         {
  30.             writer.TryComplete(ex);
  31.         }
  33.         writer.TryComplete();
  34.     }
  35. }

服务器到客户端流式处理中心方法可以接受当客户端从流中取消订阅时触发的 CancellationToken 参数。如果客户端在流末尾之前断开连接，请使用此标记停止服务器操作并释放任何资源。

客户端到服务器的流式处理Client-to-server streaming

当某个集线器方法接受 ChannelReader<T> 或 IAsyncEnumerable<T>类型的一个或多个对象时，它会自动成为客户端到服务器的流式处理中心方法。下面的示例演示了读取从客户端发送的流式处理数据的基础知识。每当客户端写入 ChannelWriter<T>时，数据都会写入中心方法读取的服务器上的 ChannelReader 中。

  1. public async Task UploadStream(ChannelReader<string> stream)
  2. {
  3.     while (await stream.WaitToReadAsync())
  4.     {
  5.         while (stream.TryRead(out var item))
  6.         {
  7.             // do something with the stream item
  8.             Console.WriteLine(item);
  9.         }
  10.     }
  11. }

下面是方法的 IAsyncEnumerable<T> 版本。

备注

以下示例需要C# 8.0 或更高版本。

  1. public async Task UploadStream(IAsyncEnumerable<string> stream)
  2. {
  3.     await foreach (var item in stream)
  4.     {
  5.         Console.WriteLine(item);
  6.     }
  7. }

.NET 客户端.NET client

服务器到客户端流式处理Server-to-client streaming

HubConnection 上的 StreamAsync 和 StreamAsChannelAsync 方法用于调用服务器到客户端的流式处理方法。将中心方法中定义的集线器方法名称和参数传递到 StreamAsync 或 StreamAsChannelAsync。StreamAsync<T> 和 StreamAsChannelAsync<T> 上的泛型参数指定流方法返回的对象的类型。IAsyncEnumerable<T> 或 ChannelReader<T> 类型的对象从流调用返回，并表示客户端上的流。

返回 IAsyncEnumerable<int>的 StreamAsync 示例：

  1. // Call "Cancel" on this CancellationTokenSource to send a cancellation message to
  2. // the server, which will trigger the corresponding token in the hub method.
  3. var cancellationTokenSource = new CancellationTokenSource();
  4. var stream = await hubConnection.StreamAsync<int>(
  5.     "Counter", 10, 500, cancellationTokenSource.Token);
  7. await foreach (var count in stream)
  8. {
  9.     Console.WriteLine($"{count}");
  10. }
  12. Console.WriteLine("Streaming completed");

一个返回 ChannelReader<int>的相应 StreamAsChannelAsync 示例：

  1. // Call "Cancel" on this CancellationTokenSource to send a cancellation message to
  2. // the server, which will trigger the corresponding token in the hub method.
  3. var cancellationTokenSource = new CancellationTokenSource();
  4. var channel = await hubConnection.StreamAsChannelAsync<int>(
  5.     "Counter", 10, 500, cancellationTokenSource.Token);
  7. // Wait asynchronously for data to become available
  8. while (await channel.WaitToReadAsync())
  9. {
  10.     // Read all currently available data synchronously, before waiting for more data
  11.     while (channel.TryRead(out var count))
  12.     {
  13.         Console.WriteLine($"{count}");
  14.     }
  15. }
  17. Console.WriteLine("Streaming completed");

HubConnection 上的 StreamAsChannelAsync 方法用于调用服务器到客户端流式处理方法。将中心方法中定义的集线器方法名称和参数传递到 StreamAsChannelAsync。StreamAsChannelAsync<T> 上的泛型参数指定流方法返回的对象的类型。从流调用返回 ChannelReader<T>，并表示客户端上的流。

  1. // Call "Cancel" on this CancellationTokenSource to send a cancellation message to
  2. // the server, which will trigger the corresponding token in the hub method.
  3. var cancellationTokenSource = new CancellationTokenSource();
  4. var channel = await hubConnection.StreamAsChannelAsync<int>(
  5.     "Counter", 10, 500, cancellationTokenSource.Token);
  7. // Wait asynchronously for data to become available
  8. while (await channel.WaitToReadAsync())
  9. {
  10.     // Read all currently available data synchronously, before waiting for more data
  11.     while (channel.TryRead(out var count))
  12.     {
  13.         Console.WriteLine($"{count}");
  14.     }
  15. }
  17. Console.WriteLine("Streaming completed");

HubConnection 上的 StreamAsChannelAsync 方法用于调用服务器到客户端流式处理方法。将中心方法中定义的集线器方法名称和参数传递到 StreamAsChannelAsync。StreamAsChannelAsync<T> 上的泛型参数指定流方法返回的对象的类型。从流调用返回 ChannelReader<T>，并表示客户端上的流。

  1. var channel = await hubConnection
  2.     .StreamAsChannelAsync<int>("Counter", 10, 500, CancellationToken.None);
  4. // Wait asynchronously for data to become available
  5. while (await channel.WaitToReadAsync())
  6. {
  7.     // Read all currently available data synchronously, before waiting for more data
  8.     while (channel.TryRead(out var count))
  9.     {
  10.         Console.WriteLine($"{count}");
  11.     }
  12. }
  14. Console.WriteLine("Streaming completed");

客户端到服务器的流式处理Client-to-server streaming

可以通过两种方法从 .NET 客户端调用客户端到服务器的流式处理中心方法。可以将 IAsyncEnumerable<T> 或 ChannelReader 作为参数传入 SendAsync、InvokeAsync或 StreamAsChannelAsync，具体取决于所调用的集线器方法。

只要将数据写入 IAsyncEnumerable 或 ChannelWriter 对象，服务器上的集线器方法就会收到来自客户端的数据的新项。

如果使用 IAsyncEnumerable 对象，则流在返回流项的方法退出后结束。

备注

以下示例需要C# 8.0 或更高版本。

  1. async IAsyncEnumerable<string> clientStreamData()
  2. {
  3.     for (var i = 0; i < 5; i++)
  4.     {
  5.         var data = await FetchSomeData();
  6.         yield return data;
  7.     }
  8.     //After the for loop has completed and the local function exits the stream completion will be sent.
  9. }
  11. await connection.SendAsync("UploadStream", clientStreamData());

或者，如果使用的是 ChannelWriter，则使用 channel.Writer.Complete()完成通道：

  1. var channel = Channel.CreateBounded<string>(10);
  2. await connection.SendAsync("UploadStream", channel.Reader);
  3. await channel.Writer.WriteAsync("some data");
  4. await channel.Writer.WriteAsync("some more data");
  5. channel.Writer.Complete();

JavaScript 客户端JavaScript client

服务器到客户端流式处理Server-to-client streaming

JavaScript 客户端通过 connection.stream调用集线器上的服务器到客户端流式处理方法。stream 方法接受两个参数：

  • 集线器方法的名称。在下面的示例中，中心方法名称是 Counter。
  • 在 hub 方法中定义的参数。在下面的示例中，参数是要接收的流项数的计数以及流项之间的延迟。

connection.stream 返回 IStreamResult，它包含 subscribe 方法。将 IStreamSubscriber 传递到 subscribe，并设置 next、error和 complete 回调，以便从 stream 调用接收通知。

  1. connection.stream("Counter", 10, 500)
  2.     .subscribe({
  3.         next: (item) => {
  4.             var li = document.createElement("li");
  5.             li.textContent = item;
  6.             document.getElementById("messagesList").appendChild(li);
  7.         },
  8.         complete: () => {
  9.             var li = document.createElement("li");
  10.             li.textContent = "Stream completed";
  11.             document.getElementById("messagesList").appendChild(li);
  12.         },
  13.         error: (err) => {
  14.             var li = document.createElement("li");
  15.             li.textContent = err;
  16.             document.getElementById("messagesList").appendChild(li);
  17.         },
  18. });

若要从客户端结束流，请对从 subscribe 方法返回的 ISubscription 调用 dispose 方法。调用此方法会导致取消集线器方法的 CancellationToken 参数（如果提供了一个参数）。

  1. connection.stream("Counter", 10, 500)
  2.     .subscribe({
  3.         next: (item) => {
  4.             var li = document.createElement("li");
  5.             li.textContent = item;
  6.             document.getElementById("messagesList").appendChild(li);
  7.         },
  8.         complete: () => {
  9.             var li = document.createElement("li");
  10.             li.textContent = "Stream completed";
  11.             document.getElementById("messagesList").appendChild(li);
  12.         },
  13.         error: (err) => {
  14.             var li = document.createElement("li");
  15.             li.textContent = err;
  16.             document.getElementById("messagesList").appendChild(li);
  17.         },
  18. });

若要从客户端结束流，请对从 subscribe 方法返回的 ISubscription 调用 dispose 方法。

客户端到服务器的流式处理Client-to-server streaming

JavaScript 客户端通过将 Subject 作为参数传入到 send、invoke或 stream（具体取决于所调用的集线器方法），在集线器上调用客户端到服务器的流式处理方法。Subject 是一种类似于 Subject的类。例如，在 RxJS 中，可以使用该库中的Subject类。

  1. const subject = new signalR.Subject();
  2. yield connection.send("UploadStream", subject);
  3. var iteration = 0;
  4. const intervalHandle = setInterval(() => {
  5.     iteration++;
  6.     subject.next(iteration.toString());
  7.     if (iteration === 10) {
  8.         clearInterval(intervalHandle);
  9.         subject.complete();
  10.     }
  11. }, 500);

使用项调用 subject.next(item) 会将项写入流，集线器方法接收服务器上的项。

若要结束流，请调用 subject.complete()。

Java 客户端Java client

服务器到客户端流式处理Server-to-client streaming

SignalR Java 客户端使用 stream 方法来调用流式处理方法。stream 接受三个或更多参数：

  • 流项的预期类型。
  • 集线器方法的名称。
  • 在 hub 方法中定义的参数。
  1. hubConnection.stream(String.class, "ExampleStreamingHubMethod", "Arg1")
  2.     .subscribe(
  3.         (item) -> {/* Define your onNext handler here. */ },
  4.         (error) -> {/* Define your onError handler here. */},
  5.         () -> {/* Define your onCompleted handler here. */});

HubConnection 上的 stream 方法返回流项类型的可观察对象。可观察类型的 subscribe 方法是定义 onNext、onError 和 onCompleted 处理程序的位置。

其他资源Additional resources