ASP.NET WebAPI에서 파일 (FileContentResult)을 반환하는 방법

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

그리고 비슷한 게시물이 있습니다 : 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;          
}

클릭 이벤트 및 간단한 URL과 함께 HTML 마크 업보기 :

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

다음은 파일을 버퍼링하지 않고 파일의 내용을 스트리밍하는 구현입니다 (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);
    }
}

어떤 부분을 비난해야할지 확실 MemoryStream하지 않지만 다음은 왜 효과 가 없는지입니다.

에 쓰면 속성 MemoryStream이 증가합니다 Position. 의 생성자 StreamContent는 스트림의 current를 고려합니다 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");

첫 번째는 StringContent의 JSON 표현을 리턴했습니다. { "Headers": [{ "Key": "Content-Type", "Value": [ "application / octet-stream; charset = utf-8"]}]}

두 번째 파일이 올바른 파일을 반환하는 동안.

Request.CreateResponse에 문자열을 두 번째 매개 변수로 사용하는 오버로드가있는 것 같습니다. 이것은 StringContent 객체 자체가 실제 내용 대신 문자열로 렌더링되게하는 것으로 보입니다.