从 .NET Core 控制器返回 CSV

Question

我无法将 .NET Core API 控制器端点解析为 CSV 下载。我正在使用从 .NET 4.5 控制器中提取的以下代码：

[HttpGet]
[Route("{id:int}")]
public async Task<HttpResponseMessage> Get(int id)
{
    string csv = await reportManager.GetReport(CustomerId, id);
    var response = new HttpResponseMessage(HttpStatusCode.OK);
    response.Content = new StringContent(csv);
    response.Content.Headers.ContentType = new MediaTypeHeaderValue("text/csv");
    response.Content.Headers.ContentDisposition = 
        new ContentDispositionHeaderValue("attachment") { FileName = "report.csv" };
    return response;
}

当我从我的 Angular 4 应用程序中访问此端点时，我收到以下响应写入浏览器：

{
    "version": {
        "major": 1,
        "minor": 1,
        "build": -1,
        "revision": -1,
        "majorRevision": -1,
        "minorRevision": -1
    },
    "content": {
        "headers": [
            {
                "key": "Content-Type",
                "value": [
                    "text/csv"
                ]
            },
            {
                "key": "Content-Disposition",
                "value": [
                    "attachment; filename=11.csv"
                ]
            }
        ]
    },
    "statusCode": 200,
    "reasonPhrase": "OK",
    "headers": [ ],
    "requestMessage": null,
    "isSuccessStatusCode": true
}

我的期望是，当我点击端点时，会提示用户下载 CSV。

我发现this 发布了有关如何在 .NET Core 中“导出”CSV 的帖子。问题是我正在从其源（AWS S3 存储桶）检索内存中的 CSV，而此代码似乎仅在您拥有 IEnumerable<object> 时才有效。

我想知道我的问题是出在请求标头还是响应标头中，其中存在阻止浏览器从我的 API 检索 CSV 的东西。这是我在浏览器控制台中看到的：

Answer 1

Newcomers to this question please see Svek's answer。最初的问题是关于 http Content-Disposition，但看起来搜索引擎在这里发送通用 .net 核心 csv 查询。 Svek 的回答很好地概述了 .Net Core 可用于从控制器返回 CSV 数据的工具。

---

强制下载文件而不是内联显示的正确方法是使用Content-Disposition response header. 虽然下面的解决方案有效 (see documentation)，但有人指出这可能会产生意想不到的副作用。

---

旧答案

将Content-Type 响应标头设置为application/octet-stream 将强制大多数主流浏览器提示用户保存文件，而不是在窗口中显示。

尝试做这样的事情：

var result = new FileContentResult(myCsvByteArray, "application/octet-stream");
result.FileDownloadName = "my-csv-file.csv";
return result;

See my answer to this similar question for more info

Answer 2

解决方法：使用FileResult

如果您希望客户端获得“保存文件”对话框，则应使用此选项。

这里有多种选择，如FileContentResult、FileStreamResult、VirtualFileResult、PhysicalFileResult；但它们都源自FileResult - 所以我们将在本示例中使用那个。

public async Task<FileResult> Download()
{
    string fileName = "foo.csv";
    byte[] fileBytes = ... ;

    return File(fileBytes, "text/csv", fileName); // this is the key!
}

如果您更喜欢使用public async Task<IActionResult>，上述方法也可以使用。

关键是你返回一个File类型。

附加：内容处置

FileResult 将自动为attachment 提供正确的Content-Disposition 标头。

如果要在浏览器中打开文件（“内联”），而不是提示“保存文件”对话框（“附件”）。然后您可以通过更改 Content-Disposition 标头值来做到这一点。

例如，我们想在浏览器中显示PDF文件。

public IActionResult Index()
{
    byte[] contents = FetchPdfBytes();
    Response.AddHeader("Content-Disposition", "inline; filename=test.pdf");
    return File(contents, "application/pdf");
}

感谢SO Answer

---

自定义格式化程序

自定义格式化程序通常是一个不错的选择，因为它们允许客户端询问他们想要的数据类型，例如更流行的 JSON 或不太流行的 XML。

这主要通过提供客户端传递给服务器的 Accept 标头中指定的内容来工作，例如 CSV、XLS、XML、JSON 等。

您想使用"text/csv" 的格式类型，但没有预定义的格式器，因此您必须手动将其添加到输入和输出格式器集合中：

services.AddMvc(options =>
{
    options.InputFormatters.Insert(0, new MyCustomInputFormatter());
    options.OutputFormatters.Insert(0, new MyCustomOutputFormatter());
});

非常简单的自定义格式化程序

这是自定义格式化程序的一个非常简单的版本，它是Microsoft Docs example 提供的精简版。

public class CsvOutputFormatter : TextOutputFormatter
{
    public CsvOutputFormatter()
    {
        SupportedMediaTypes.Add(MediaTypeHeaderValue.Parse("text/csv"));
        SupportedEncodings.Add(Encoding.UTF8);
        SupportedEncodings.Add(Encoding.Unicode);
    }

    protected override bool CanWriteType(Type type)
    {
        return true; // you could be fancy here but this gets the job done.
    }

    public override Task WriteResponseBodyAsync(OutputFormatterWriteContext context, Encoding selectedEncoding)
    {
        var response = context.HttpContext.Response;
        
        // your magic goes here
        string foo = "Hello World!";

        return response.WriteAsync(foo);
    }
}

强制使用特定格式

// force all actions in the controller
[Produces("text/csv")]
public class FooController
{
    // or apply on to a single action
    [Produces("text/csv")]
    public async Task<IActionResult> Index()
    {
    }
}  

---

有关更多信息，我建议您阅读：

• Introduction to formatting response data in ASP.NET Core MVC
• Custom formatters in ASP.NET Core MVC