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

发布于03月04日

我正在使用ASP开发一个web服务.NET MVC的新WebAPI将提供二进制文件，主要是.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"));
}

有没有更好的方法来做这件事？

推荐答案

try 使用简单的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的读取/列出/执行访问权限.