在 ASP.NET Core 中流式传输内存中生成的文件

Question

在互联网上搜索了几个小时后，我不知道如何解决我的 ASP.NET Core 2.x 问题。

我正在动态生成 CSV（可能需要几分钟），然后尝试将其发送回客户端。在我开始发送响应之前，许多客户端都超时了，所以我试图将文件流回给他们（立即响应 200）并异步写入流。以前在 ASP 中使用 PushStreamContent 似乎可以做到这一点，但我不确定如何构造我的代码，以便异步完成 CSV 生成并立即返回 HTTP 响应。

[HttpGet("csv")]
public async Task<FileStreamResult> GetCSV(long id)
{
    // this stage can take 2+ mins, which obviously blocks the response
    var data = await GetData(id);
    var records = _csvGenerator.GenerateRecords(data); 

    // using the CsvHelper Nuget package
    var stream = new MemoryStream();
    var writer = new StreamWriter(stream);
    var csv = new CsvWriter(writer);

    csv.WriteRecords(stream, records);
    await writer.FlushAsync();

    return new FileStreamResult(stream, new MediaTypeHeaderValue("text/csv))
    {
        FileDownloadName = "results.csv"
    };
 }

如果您向此控制器方法发出请求，则在整个 CSV 完成生成并最终获得响应之前，您将一无所获，此时大多数客户端请求已超时。

我尝试将 CSV 生成代码包装在 Task.Run() 中，但这也对我的问题没有帮助。

Answer 1

ASP.NET Core 没有内置 PushStreamContext 类型的类型。但是，您可以使用 build your own FileCallbackResult 来做同样的事情。这个example code 应该这样做：

public class FileCallbackResult : FileResult
{
    private Func<Stream, ActionContext, Task> _callback;

    public FileCallbackResult(MediaTypeHeaderValue contentType, Func<Stream, ActionContext, Task> callback)
        : base(contentType?.ToString())
    {
        if (callback == null)
            throw new ArgumentNullException(nameof(callback));
        _callback = callback;
    }

    public override Task ExecuteResultAsync(ActionContext context)
    {
        if (context == null)
            throw new ArgumentNullException(nameof(context));
        var executor = new FileCallbackResultExecutor(context.HttpContext.RequestServices.GetRequiredService<ILoggerFactory>());
        return executor.ExecuteAsync(context, this);
    }

    private sealed class FileCallbackResultExecutor : FileResultExecutorBase
    {
        public FileCallbackResultExecutor(ILoggerFactory loggerFactory)
            : base(CreateLogger<FileCallbackResultExecutor>(loggerFactory))
        {
        }

        public Task ExecuteAsync(ActionContext context, FileCallbackResult result)
        {
            SetHeadersAndLog(context, result, null);
            return result._callback(context.HttpContext.Response.Body, context);
        }
    }
}

用法：

[HttpGet("csv")]
public IActionResult GetCSV(long id)
{
  return new FileCallbackResult(new MediaTypeHeaderValue("text/csv"), async (outputStream, _) =>
  {
    var data = await GetData(id);
    var records = _csvGenerator.GenerateRecords(data); 
    var writer = new StreamWriter(outputStream);
    var csv = new CsvWriter(writer);
    csv.WriteRecords(stream, records);
    await writer.FlushAsync();
  })
  {
    FileDownloadName = "results.csv"
  };
}

请记住，FileCallbackResult 与 PushStreamContext 具有相同的限制：如果在回调中发生错误，则 Web 服务器无法通知客户端该错误。您所能做的就是传播异常，这将导致 ASP.NET 提前关闭连接，因此客户端会收到“连接意外关闭”或“下载中止”错误。这是因为 HTTP 在正文开始流式传输之前在标头中发送错误代码 first。

Answer 2

如果文档生成需要2+ 分钟，则它应该是asynchronous。可能是这样的：

1. 客户端发送请求生成文档
2. 您接受请求，在后台开始生成并回复类似generation has been started, we will notify you 的消息
3. 在客户端您定期检查文档是否准备好并最终获取链接

您也可以使用signalr 进行操作。步骤相同，但客户不需要检查文档的状态。完成后可以推送链接。