Cara mengembalikan file (FileContentResult) di ASP.NET WebAPI

Dalam pengontrol MVC biasa, kita dapat menampilkan pdf dengan a FileContentResult.

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

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

Tapi bagaimana kita bisa mengubahnya menjadi ApiController?

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

Inilah yang saya coba tetapi tampaknya tidak berhasil.

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

Hasil yang dikembalikan ditampilkan di browser adalah:

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

Dan ada posting serupa di SO: Mengembalikan file biner dari pengontrol di ASP.NET Web API . Ini berbicara tentang keluaran file yang ada. Tetapi saya tidak bisa membuatnya bekerja dengan aliran.

Ada saran?

Alih-alih kembali StreamContentsebagai Content, saya dapat membuatnya bekerja dengan 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;
}

Jika Anda ingin kembali, IHttpActionResultAnda dapat melakukannya seperti ini:

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

Pertanyaan ini membantu saya.

Jadi, coba ini:

Kode pengontrol:

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

Lihat marka Html (dengan acara klik dan url sederhana):

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

Berikut ini adalah implementasi yang mengalirkan konten file keluar tanpa buffering (buffering dalam byte [] / MemoryStream, dll. Bisa menjadi masalah server jika itu file besar).

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

Ini bisa digunakan seperti ini:

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

Saya tidak yakin bagian mana yang harus disalahkan, tetapi inilah mengapa MemoryStreamtidak bekerja untuk Anda:

Saat Anda menulis surat MemoryStream, itu menambah Positionproperti itu. Konstruktor StreamContentmemperhitungkan aliran saat ini Position. Jadi jika Anda menulis ke aliran, maka meneruskannya keStreamContent , respons akan mulai dari ketiadaan di akhir aliran.

Ada dua cara untuk memperbaikinya dengan benar:

1) membuat konten, menulis untuk streaming

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

2) menulis untuk streaming, mengatur ulang posisi, membuat konten

[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) terlihat sedikit lebih baik jika Anda memiliki Stream baru, 1) lebih sederhana jika streaming Anda tidak dimulai pada 0

Bagi saya itu adalah perbedaan di antara keduanya

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

dan

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

Yang pertama adalah mengembalikan representasi JSON dari StringContent: {"Header": [{"Key": "Content-Type", "Value": ["application / octet-stream; charset = utf-8"]}]}

Sedangkan yang kedua mengembalikan file yang tepat.

Tampaknya Request.CreateResponse memiliki kelebihan yang mengambil string sebagai parameter kedua dan ini tampaknya yang menyebabkan objek StringContent itu sendiri dirender sebagai string, alih-alih konten yang sebenarnya.