如何在 ASP.NET WebAPI 中返回文件 (FileContentResult)

Question

在常规的 MVC 控制器中，我们可以输出带有 FileContentResult 的 pdf。

public FileContentResult Test(TestViewModel vm)
{
    var stream = new MemoryStream();
    //... add content to the stream.

    return File(stream.GetBuffer(), "application/pdf", "test.pdf");
}

但是我们怎样才能把它改成ApiController呢？

[HttpPost]
public IHttpActionResult Test(TestViewModel vm)
{
     //...
     return Ok(pdfOutput);
}

---

这是我尝试过的方法，但似乎不起作用。

[HttpGet]
public IHttpActionResult Test()
{
    var stream = new MemoryStream();
    //...
    var content = new StreamContent(stream);
    content.Headers.ContentType = new MediaTypeHeaderValue("application/pdf");
    content.Headers.ContentLength = stream.GetBuffer().Length;
    return Ok(content);            
}

在浏览器中显示的返回结果是：

{"Headers":[{"Key":"Content-Type","Value":["application/pdf"]},{"Key":"Content-Length","Value":["152844"]}]}

在 SO 上有一个类似的帖子：Returning binary file from controller in ASP.NET Web API 。它谈论输出现有文件。但我无法让它与流一起使用。

有什么建议吗？

Answer 1

This 问题帮助了我。

那么，试试这个：

控制器代码：

[HttpGet]
public HttpResponseMessage Test()
{
    var path = System.Web.HttpContext.Current.Server.MapPath("~/Content/test.docx");;
    HttpResponseMessage result = new HttpResponseMessage(HttpStatusCode.OK);
    var stream = new FileStream(path, FileMode.Open);
    result.Content = new StreamContent(stream);
    result.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment");
    result.Content.Headers.ContentDisposition.FileName = Path.GetFileName(path);
    result.Content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
    result.Content.Headers.ContentLength = stream.Length;
    return result;          
}

查看 Html 标记（带有点击事件和简单的 url）：

<script type="text/javascript">
    $(document).ready(function () {
        $("#btn").click(function () {
            // httproute = "" - using this to construct proper web api links.
            window.location.href = "@Url.Action("GetFile", "Data", new { httproute = "" })";
        });
    });
</script>


<button id="btn">
    Button text
</button>

<a href=" @Url.Action("GetFile", "Data", new { httproute = "" }) ">Data</a>

Answer 2

我可以使它与ByteArrayContent 一起工作，而不是将StreamContent 作为Content 返回。

[HttpGet]
public HttpResponseMessage Generate()
{
    var stream = new MemoryStream();
    // processing the stream.

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

    return result;
}

Answer 3

我不确定应该归咎于哪一部分，但这就是为什么 MemoryStream 不适合你：

当您写信给MemoryStream 时，它会增加它的Position 属性。 StreamContent 的构造函数考虑了流的当前Position。所以如果你写入流，然后将它传递给StreamContent，响应将从流末尾的虚无开始。

有两种方法可以正确解决此问题：

1. 构建内容，写入流

    [HttpGet]
    public HttpResponseMessage Test()
    {
        var stream = new MemoryStream();
        var response = Request.CreateResponse(HttpStatusCode.OK);
        response.Content = new StreamContent(stream);
        // ...
        // stream.Write(...);
        // ...
        return response;
    }
   

2. 写入流，重置位置，构造内容

    [HttpGet]
    public HttpResponseMessage Test()
    {
        var stream = new MemoryStream();
        // ...
        // stream.Write(...);
        // ...
        stream.Position = 0;
   
        var response = Request.CreateResponse(HttpStatusCode.OK);
        response.Content = new StreamContent(stream);
        return response;
    }
   

3. 如果你有一个新的 Stream，看起来会好一些，1) 如果你的 Stream 不是从 0 开始，那么会更简单

Answer 4

如果你想返回IHttpActionResult，你可以这样做：

[HttpGet]
public IHttpActionResult Test()
{
    var stream = new MemoryStream();

    var result = new HttpResponseMessage(HttpStatusCode.OK)
    {
        Content = new ByteArrayContent(stream.GetBuffer())
    };
    result.Content.Headers.ContentDisposition = new System.Net.Http.Headers.ContentDispositionHeaderValue("attachment")
    {
        FileName = "test.pdf"
    };
    result.Content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");

    var response = ResponseMessage(result);

    return response;
}

Answer 5

对我来说，这就是

var response = Request.CreateResponse(HttpStatusCode.OK, new StringContent(log, System.Text.Encoding.UTF8, "application/octet-stream");

和

var response = Request.CreateResponse(HttpStatusCode.OK);
response.Content = new StringContent(log, System.Text.Encoding.UTF8, "application/octet-stream");

第一个是返回 StringContent 的 JSON 表示： {"Headers":[{"Key":"Content-Type","Value":["application/octet-stream; charset=utf-8"] }]}

当第二个正在正确返回文件时。

似乎 Request.CreateResponse 有一个将字符串作为第二个参数的重载，这似乎是导致 StringContent 对象本身呈现为字符串而不是实际内容的原因。

Answer 6

这是一个将文件内容流式传输出来而不缓冲它的实现（如果文件是大文件，缓冲在 byte[] / MemoryStream 等可能是服务器问题）。

public class FileResult : IHttpActionResult
{
    public FileResult(string filePath)
    {
        if (filePath == null)
            throw new ArgumentNullException(nameof(filePath));

        FilePath = filePath;
    }

    public string FilePath { get; }

    public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
    {
        var response = new HttpResponseMessage(HttpStatusCode.OK);
        response.Content = new StreamContent(File.OpenRead(FilePath));
        var contentType = MimeMapping.GetMimeMapping(Path.GetExtension(FilePath));
        response.Content.Headers.ContentType = new MediaTypeHeaderValue(contentType);
        return Task.FromResult(response);
    }
}

可以这样简单地使用：

public class MyController : ApiController
{
    public IHttpActionResult Get()
    {
        string filePath = GetSomeValidFilePath();
        return new FileResult(filePath);
    }
}

Answer 7

 var memoryStream = new MemoryStream();
                await cloudFile.DownloadToStreamAsync(memoryStream);
                responseMessage.result = "Success";

                var contentType = "application/octet-stream";
            
                **using (var stream = new MemoryStream())
                {                    
                    return File(memoryStream.GetBuffer(), contentType, "Cartage.pdf");
                }**