web-dev-qa-db-ja.com

ASP.NET WebAPIでファイル（FileContentResult）を返す方法

通常の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にも同様の記事があります： ASP.NET Web APIのコントローラからバイナリファイルを返す 。既存ファイルの出力について話しています。しかし、私はそれをストリームで動作させることはできませんでした。

助言がありますか？

c#asp.netasp.net-mvcasp.net-web-api
146
Blaise

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;
}
168
Blaise

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;
}
76
Ogglas

これ 質問は私を助けた。

だから、これを試してみてください：

コントローラコード：

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

どの部分を非難するのか正確には分かりませんが、MemoryStreamがあなたのために働かない理由はここにあります：

MemoryStreamに書き込むと、Positionプロパティが増加します。 StreamContentのコンストラクタは、ストリームの現在のPositionを考慮に入れます。そのため、ストリームに書き込みを行い、それをStreamContentに渡すと、応答はストリームの最後の何もないところから始まります。

これを正しく修正する方法は2つあります。

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）新しいStreamがある場合は少し見栄えがよく、1）ストリームが0から始まっていない場合はより簡単です。

6
M.Stramm

私にとってはそれは違いだった

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"]}]}

2番目のものがファイルを適切に返している間。

Request.CreateResponseは2番目のパラメータとして文字列を受け取るオーバーロードを持っているようで、これが実際のコンテンツではなくStringContentオブジェクト自体を文字列としてレンダリングさせる原因となっていたようです。

3
EnderWiggin

これは、ファイルの内容をバッファリングせずにストリームアウトする実装です（大きなファイルの場合、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);
    }
}
3
Simon Mourier