Cách trả lại tệp (FileContentResult) trong ASP.NET WebAPI

Trong một bộ điều khiển MVC thông thường, chúng ta có thể xuất pdf bằng a FileContentResult.

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

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

Nhưng làm thế nào chúng ta có thể thay đổi nó thành một ApiController?

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

Đây là những gì tôi đã thử nhưng nó dường như không hoạt động.

[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);            
}

Kết quả trả về được hiển thị trong trình duyệt là:

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

Và có một bài tương tự trên SO: Trả lại tệp nhị phân từ bộ điều khiển trong ASP.NET Web API . Nó nói về đầu ra một tập tin hiện có. Nhưng tôi không thể làm cho nó hoạt động với một luồng.

Bất kỳ đề xuất?

Thay vì trở lại StreamContentnhư Content, tôi có thể làm cho nó hoạt động với ByteArrayContent.

[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;
}

Nếu bạn muốn trở về, IHttpActionResultbạn có thể làm như thế này:

[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;
}

Câu hỏi này đã giúp tôi.

Vì vậy, hãy thử điều này:

Mã điều khiển:

[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;          
}

Xem đánh dấu Html (với sự kiện nhấp chuột và url đơn giản):

<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>

Đây là một triển khai giúp truyền phát nội dung của tệp mà không cần đệm (đệm theo byte [] / MemoryStream, v.v. có thể là sự cố máy chủ nếu đó là tệp lớn).

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);
    }
}

Nó có thể được sử dụng đơn giản như thế này:

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

Tôi không chắc chắn chính xác phần nào để đổ lỗi, nhưng đây là lý do tại sao MemoryStreamkhông làm việc cho bạn:

Khi bạn viết thư MemoryStream, nó sẽ tăng Positiontài sản của nó . Hàm tạo của StreamContenttính đến hiện tại của luồng Position. Vì vậy, nếu bạn viết vào luồng, sau đó chuyển nó sang StreamContent, phản hồi sẽ bắt đầu từ hư vô ở cuối luồng.

Có hai cách để khắc phục điều này:

1) xây dựng nội dung, ghi vào luồng

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

2) ghi vào luồng, đặt lại vị trí, xây dựng nội dung

[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;
}

2) có vẻ tốt hơn một chút nếu bạn có Luồng mới, 1) đơn giản hơn nếu luồng của bạn không bắt đầu từ 0

Đối với tôi đó là sự khác biệt giữa

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

và

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

Cái đầu tiên là trả về đại diện JSON của StringContent: {"Headers": [{"Key": "Content-Type", "Value": ["application / octet-stream; charset = utf-8"]}]}

Trong khi cái thứ hai đã trả lại tập tin thích hợp.

Dường như Request.CreateResponse có tình trạng quá tải, lấy một chuỗi làm tham số thứ hai và đây dường như là nguyên nhân khiến chính đối tượng StringContent được hiển thị dưới dạng chuỗi, thay vì nội dung thực tế.