Web API2返回application/octet-stream在IIS10失效IIS8.5正常问题排查

你看到的JSON是HttpResponseMessage对象本身被序列化后的结果，说明集成环境的Web API管道没有将HttpResponseMessage识别为原始响应对象，而是当成了普通DTO做了JSON序列化，结合环境差异常见触发原因如下：

• IIS 10默认启用的WebDAV模块拦截了二进制文件类POST响应，修改了输出逻辑
• 集成环境的Web.config缺失响应处理器配置，或者自定义媒体格式化器优先级高于原生HttpResponseMessage处理器
• 全局注册的响应拦截器/统一返回格式过滤器没有对文件响应做特殊处理，二次包装了返回结果
• 应用程序池托管模式、.NET版本配置错误，导致Web API管道执行逻辑异常

按优先级从高到低执行：

1. 验证问题来源 #

用Postman/ApiPost直接调用该接口，不经过前端页面请求，确认返回的JSON是服务端直接输出，排除前端处理错误的可能性。
2. ## 禁用WebDAV模块（最高概率）
IIS 10默认安装启用的WebDAV模块会拦截POST/PUT类的二进制响应，在Web.config的<system.webServer>节点下添加以下配置：

<modules runAllManagedModulesForAllRequests="true">
  <remove name="WebDAVModule" />
</modules>
<handlers>
  <remove name="WebDAV" />
  <remove name="ExtensionlessUrlHandler-Integrated-4.0" />
  <add name="ExtensionlessUrlHandler-Integrated-4.0" path="*." verb="*" type="System.Web.Handlers.TransferRequestHandler" preCondition="integratedMode,runtimeVersionv4.0" />
</handlers>

3. 修改返回类型避免被序列化 #

将接口返回类型从HttpResponseMessage改为IHttpActionResult，明确告知Web API按原始响应处理：

[HttpPost]
[Route("api/Chart/test")]
public async Task<IHttpActionResult> test(TestEntity request)
{
    try
    {
        var ms = await _service.testMethod(request.Data, request.ExportType, request.FileName);
        var content = new ByteArrayContent(ms.ToArray());
        content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
        content.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment")
        {
            FileName = request.FileName
        };
        return ResponseMessage(Request.CreateResponse(HttpStatusCode.OK, content));
    }
    catch (Exception)
    {
        return InternalServerError();
    }
}

4. 检查全局格式化器配置 #

确认WebApiConfig.cs中没有清空默认格式化器、强制优先JSON格式化器的配置，比如移除以下错误配置：

// 该配置会强制所有响应走JSON序列化
config.Formatters.Clear();
config.Formatters.Add(new JsonMediaTypeFormatter());

5. 核对应用程序池配置 #

确认集成环境的应用程序池符合以下要求：

• .NET Framework版本设置为v4.0（适配.NET Framework 4.6.1）
• 托管管道模式设置为集成模式，而非经典模式
• 关闭IIS响应压缩中对application/octet-stream类型的压缩规则

6. 排查全局拦截器 #

确认没有注册全局ActionFilter、DelegatingHandler做统一返回格式包装，如果有这类拦截器，需要添加判断逻辑，跳过文件类响应的包装。

内容的提问来源于stack exchange，提问作者Girish Khadse