如何在 ASP.NET Web API 中以 ByteContent 形式返回文件？

在 ASP.NET Web API 中以字节数组形式返回文件

本文演示了如何在 ASP.NET Web API 中有效地将文件作为字节数组返回。 MVC 中常用的 FileContentResult 在这里不直接适用。

挑战：

使用为 MVC 设计的方法直接从 ApiController 返回 PDF 文件（或其他文件类型）通常会产生意想不到的结果。

解决方案：

关键是将文件作为字节数组处理。 这涉及几个步骤：

1. 流到字节数组转换：将文件读入流，然后将该流转换为字节数组。

2. ByteArrayContent 创建： 利用 ByteArrayContent 类，传递上一步中获得的字节数组。

3. 标头管理： 正确设置 Content-Disposition 标头以指定下载的文件名，并设置 Content-Type 标头以正确识别文件类型（例如，PDF 的“application/pdf”）。

4. HttpResponseMessage 构造： 将 ByteArrayContent 封装在 HttpResponseMessage 对象中，设置适当的 HTTP 状态代码（例如 HttpStatusCode.OK）。

代码示例：

[HttpGet]
public HttpResponseMessage Generate()
{
    using (var stream = new MemoryStream())
    {
        // ... Your file stream processing here ...  Populate the 'stream'

        var byteArray = stream.ToArray();
        var result = new HttpResponseMessage(HttpStatusCode.OK)
        {
            Content = new ByteArrayContent(byteArray)
        };
        result.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment")
        {
            FileName = "CertificationCard.pdf"
        };
        result.Content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream"); // Or application/pdf

        return result;
    }
}

这个修改后的示例展示了如何以字节数组的形式返回 PDF 文件（或任何文件类型），并附带必要的标头。 客户端（浏览器）现在应该正确处理文件下载。 请记住将占位符注释 // ... Your file stream processing here ... 替换为您实际的文件读取逻辑。 考虑使用更具体的 Content-Type 标头以获得更好的浏览器兼容性。

以上是如何在 ASP.NET Web API 中以 ByteContent 形式返回文件？的详细内容。更多信息请关注PHP中文网其他相关文章！