c# - 返回查询结果的异步流

Question

我有以下从 RavenDB 返回无界结果流的 WebApi 方法:

public IEnumerable<Foo> Get()
{
    var query = DocumentSession.Query<Foo, FooIndex>();
    using (var enumerator = DocumentSession.Advanced.Stream(query))
        while (enumerator.MoveNext())
            yield return enumerator.Current.Document;
}

现在我想让它异步。天真的方法当然行不通:

public async Task<IEnumerable<Location>> Get()
{
    var query = AsyncDocumentSession.Query<Foo, FooIndex>();
    using (var enumerator = await AsyncDocumentSession.Advanced.StreamAsync(query))
        while (await enumerator.MoveNextAsync())
            yield return enumerator.Current.Document;
}

...因为该方法不能既是异步方法又是迭代器。

Answer 1

由于这是一个 WebAPI 操作方法，HTTP 将您限制为单一响应。如果你只是返回一个 IEnumerable<T> ，然后 ASP.NET 将在内存中枚举它，然后发送响应。

如果您对这个内存中的过程没问题，那么您可以自己做同样的事情:

public async Task<List<Location>> Get()
{
  var result = new List<Location>();
  var query = AsyncDocumentSession.Query<Foo, FooIndex>();
  using (var enumerator = await AsyncDocumentSession.Advanced.StreamAsync(query))
    while (await enumerator.MoveNextAsync())
      result.Add(enumerator.Current.Document);
  return result;
}

但是，我相信使用流式响应会更好，您可以通过 PushStreamContent 获得它。 ;像这样:

public HttpResponseMessage Get()
{
  var query = AsyncDocumentSession.Query<Foo, FooIndex>();
  HttpResponseMessage response = Request.CreateResponse();
  response.Content = new PushStreamContent(
      async (stream, content, context) =>
      {
        using (stream)
        using (var enumerator = await AsyncDocumentSession.Advanced.StreamAsync(query))
        {
          while (await enumerator.MoveNextAsync())
          {
            // TODO: adjust encoding as necessary.
            var serialized = JsonConvert.SerializeObject(enumerator.CurrentDocument);
            var data = UTF8Encoding.UTF8.GetBytes(serialized);
            var countPrefix = BitConverter.GetBytes(data.Length);
            await stream.WriteAsync(countPrefix, 0, countPrefix.Length);
            await stream.WriteAsync(data, 0, data.Length);
          }
        }
      });
  return response;
}

流式响应不需要您的服务器将整个响应保存在内存中；但是，您必须决定将文档写入响应流的正确方法。上面的示例代码只是将它们转换为 JSON，以 UTF8 编码，并为这些字符串添加(二进制)长度前缀。