如何在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

，而不是返回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; 
} 

Answer 2

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標記（與click事件和簡單的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 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; 
} 

2 ）看起來好一點，如果你有一個新的流，1）更簡單，如果你的流不從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;字符集= UTF-8" ]}]}

而第二個被返回文件正確。

似乎Request.CreateResponse具有重載採用字符串作爲第二個參數，這似乎有是什麼導致StringContent對象本身呈現爲一個字符串，而不是實際的內容。