在ASP.NET Web API中从控制器返回二进制文件

Question

我正在使用ASP.NET MVC的新WebAPI处理Web服务，该服务将提供二进制文件，主要是.cab和.exe文件。

下面的控制器方法似乎工作，这意味着它返回一个文件，但它设置的内容类型application/json：

public HttpResponseMessage<Stream> Post(string version, string environment, string filetype) 
{ 
    var path = @"C:\Temp\test.exe"; 
    var stream = new FileStream(path, FileMode.Open); 
    return new HttpResponseMessage<Stream>(stream, new MediaTypeHeaderValue("application/octet-stream")); 
} 

有没有更好的方式来做到这一点？

Answer 1

尝试使用简单HttpResponseMessage其Content属性设置为StreamContent：

// using System.IO; 
// using System.Net.Http; 
// using System.Net.Http.Headers; 

public HttpResponseMessage Post(string version, string environment, 
    string filetype) 
{ 
    var path = @"C:\Temp\test.exe"; 
    HttpResponseMessage result = new HttpResponseMessage(HttpStatusCode.OK); 
    var stream = new FileStream(path, FileMode.Open, FileAccess.Read); 
    result.Content = new StreamContent(stream); 
    result.Content.Headers.ContentType = 
     new MediaTypeHeaderValue("application/octet-stream"); 
    return result; 
} 

有几件事情需要注意使用的stream：

• 您不能致电stream.Dispose()，因为Web API仍然需要能够在处理控制器方法的result以将数据发送回客户端时访问它。因此，请勿使用using (var stream = …)块。 Web API将为您处理流。

• 确保该流的当前位置设置为0（即流的数据的开始）。在上面的例子中，这是一个给定的，因为你只是刚刚打开文件。然而，在其他情况下（例如，当你第一次写一些二进制数据到MemoryStream），确保stream.Seek(0, SeekOrigin.Begin);或设置stream.Position = 0;

• 随着文件流，显式指定FileAccess.Read权限可以帮助防止Web服务器上的访问权限问题; IIS应用程序池帐户通常只能读取/列出/执行wwwroot的访问权限。

Answer 2

您正在使用的重载设置序列化格式化程序的枚举。您需要明确指定内容类型，如：

httpResponseMessage.Content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream"); 

Answer 3

你可以尝试

httpResponseMessage.Content.Headers.Add("Content-Type", "application/octet-stream"); 

Answer 4

对于的Web API 2，可以实现IHttpActionResult。这里是我的：

class FileResult : IHttpActionResult 
{ 
    private readonly string _filePath; 
    private readonly string _contentType; 

    public FileResult(string filePath, string contentType = null) 
    { 
     if (filePath == null) throw new ArgumentNullException("filePath"); 

     _filePath = filePath; 
     _contentType = contentType; 
    } 

    public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken) 
    { 
     var response = new HttpResponseMessage(HttpStatusCode.OK) 
     { 
      Content = new StreamContent(File.OpenRead(_filePath)) 
     }; 

     var contentType = _contentType ?? MimeMapping.GetMimeMapping(Path.GetExtension(_filePath)); 
     response.Content.Headers.ContentType = new MediaTypeHeaderValue(contentType); 

     return Task.FromResult(response); 
    } 
} 

然后像这样在你的控制器：

[Route("Images/{*imagePath}")] 
public IHttpActionResult GetImage(string imagePath) 
{ 
    var serverPath = Path.Combine(_rootPath, imagePath); 
    var fileInfo = new FileInfo(serverPath); 

    return !fileInfo.Exists 
     ? (IHttpActionResult) NotFound() 
     : new FileResult(fileInfo.FullName); 
} 

而且这里有一个方法，你可以告诉IIS忽略的扩展名的请求，使该请求将使它的控制器：

<!-- web.config --> 
<system.webServer> 
    <modules runAllManagedModulesForAllRequests="true"/> 

Answer 5

尽管建议的解决方案工作得很好，还有另一种方式，返回来自控制器的字节数组，响应流格式正确：

• 在请求中，设置标头“Accept：application/octet-stream”。
• 服务器端，添加一个媒体类型格式支持此MIME类型。

不幸的是，WebApi没有包含任何“application/octet-stream”格式。在GitHub上有一个实现：BinaryMediaTypeFormatter（为了使它适用于webapi 2，方法签名已更改，有一些小修改）。

您可以添加此格式到全局配置：

HttpConfiguration config; 
// ... 
config.Formatters.Add(new BinaryMediaTypeFormatter(false)); 

的WebAPI现在应该使用BinaryMediaTypeFormatter如果请求指定了正确的Accept头。

我喜欢这个解决方案，因为动作控制器返回字节[]是更舒适的测试。尽管如此，如果您想返回另一种内容类型而不是“application/octet-stream”（例如“image/gif”），另一种解决方案允许您进行更多控制。

Answer 6

对于使用接受的答案中的方法下载相当大的文件时出现多次API调用问题的任何人，请将响应缓冲设置为true System.Web.HttpContext.Current.Response.Buffer =真正;

这可以确保在整个二进制内容在服务器端缓存，然后发送给客户端。否则，你会看到多个请求被发送到控制器，如果你没有正确处理它，文件将被损坏。