วิธีคืนไฟล์ (FileContentResult) ใน ASP.NET WebAPI

ในการควบคุม MVC ปกติเราสามารถส่งออก PDF FileContentResultด้วย

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: กลับแฟ้มไบนารีจากตัวควบคุมใน ASP.NET Web API มันพูดเกี่ยวกับการส่งออกไฟล์ที่มีอยู่ แต่ฉันไม่สามารถทำงานกับสตรีมได้

ข้อเสนอแนะใด ๆ

แทนที่จะกลับมาStreamContentเป็นContentฉันสามารถทำให้มันใช้งาน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;
}

หากคุณต้องการกลับมา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;
}

คำถามนี้ช่วยฉัน

ดังนั้นลองทำสิ่งนี้:

รหัสควบคุม:

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

นี่คือการใช้งานที่สตรีมเนื้อหาของไฟล์โดยไม่บัฟเฟอร์ (การบัฟเฟอร์ในไบต์ [] / 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);
    }
}

ฉันไม่แน่ใจว่าส่วนไหนที่จะตำหนิ แต่นี่เป็นสาเหตุที่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;
}

2) ดูดีขึ้นเล็กน้อยถ้าคุณมีสตรีมสด 1) จะง่ายกว่าหากสตรีมของคุณไม่เริ่มต้นที่ 0

สำหรับฉันมันเป็นความแตกต่างระหว่าง

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

คนแรกที่ส่งคืนการแสดง JSON ของ StringContent: {"ส่วนหัว": [{"คีย์": "ประเภทเนื้อหา", "ค่า": ["แอปพลิเคชัน / octet-stream; charset = utf-8"]}]}

ในขณะที่ไฟล์ที่สองส่งคืนไฟล์ที่ถูกต้อง

ดูเหมือนว่า Request.CreateResponse มีการโอเวอร์โหลดที่ใช้สตริงเป็นพารามิเตอร์ที่สองและดูเหมือนว่าจะเป็นสาเหตุที่ทำให้วัตถุ StringContent แสดงเป็นสตริงแทนที่จะเป็นเนื้อหาจริง