我正在使用ASP.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"));
}
有更好的方法吗？
尝试使用一个简单的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的读/列出/执行访问权限。
HttpResponseMessage和流本身在方法外仍会被使用，因此无法真正向结果(HttpResponseMessage)或流本身添加using。正如@Dan所述，当框架完成向客户端发送响应后，它们将被框架处理程序释放。 - carlosfigueira对于 Web API 2，您可以实现IHttpActionResult。以下是我的实现：
using System;
using System.IO;
using System.Net;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading;
using System.Threading.Tasks;
using System.Web;
using System.Web.Http;
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"/>
async修饰符并完全删除任务的创建：https://gist.github.com/ronnieoverby/ae0982c7832c531a9022 - Ronnie Overby您可以在API控制器方法中使用IActionResult接口，如下所示。
[HttpGet("GetReportData/{year}")]
public async Task<IActionResult> GetReportData(int year)
{
// Render Excel document in memory and return as Byte[]
Byte[] file = await this._reportDao.RenderReportAsExcel(year);
return File(file, "application/vnd.openxmlformats", "fileName.xlsx");
}
这个例子很简化，但是应该可以表达出要点。在.NET Core中，这个过程比以前的.NET版本要简单得多 - 即不需要设置响应类型、内容、头等等。
当然，文件的MIME类型和扩展名也会根据个人需求而有所不同。
虽然建议的解决方案可行，但还有另一种从控制器返回字节数组的方式，可以正确格式化响应流：
不幸的是，WebApi不包括任何针对 "application/octet-stream" 的格式化程序。 这里有一个实现在GitHub上：BinaryMediaTypeFormatter（做了一些小改动使其适用于WebApi 2，方法签名已更改）。
您可以将此格式化程序添加到全局配置中：
HttpConfiguration config;
// ...
config.Formatters.Add(new BinaryMediaTypeFormatter(false));
如果请求正确的 "Accept" header，则 WebApi 现在应使用 BinaryMediaTypeFormatter。
我更喜欢这个解决方案，因为操作控制器返回 byte[] 类型更容易测试。尽管另一种解决方案允许您在返回其他内容类型（例如 "image/gif"）时拥有更多控制权。
如果您在使用接受的答案中的方法下载一个相当大的文件时，遇到API被多次调用的问题，请将响应缓冲设置为true。 System.Web.HttpContext.Current.Response.Buffer = true;
这样可以确保在将二进制内容发送到客户端之前，在服务器端对整个二进制内容进行缓冲。否则，您将看到多个请求发送到控制器，如果您没有正确处理它，文件将变得损坏。
httpResponseMessage.Content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
Content Type: application/json。如果在返回 httpResponseMessage 响应之前中断，则似乎已正确设置 Content Type。还有其他的想法吗？ - Josh Earl你可以尝试
httpResponseMessage.Content.Headers.Add("Content-Type", "application/octet-stream");
httpResponseMessage.Content.Headers.Add("Content-Type", "application/octet-stream");