迁移至.NET 6后，能否调整ApiController的HTTP响应Header顺序？

背景原因 #

ASP.NET Core（包括.NET 6）默认会对响应头进行字母排序，这主要是因为Kestrel服务器为适配HTTP/2规范（该规范要求头字段按字典序排列）而做的处理。而.NET Framework + Nancy的旧项目没有这个强制排序逻辑，因此迁移后出现头顺序不一致的问题。

解决方法 #

方法1：配置Kestrel使用HTTP/1.x并关闭头排序（仅适用于HTTP/1.x场景） #

如果你的服务不需要支持HTTP/2，可以强制Kestrel使用HTTP/1.x，此时Kestrel不会对响应头进行强制排序，你可以直接通过HttpContext.Response.Headers按顺序添加头：

// 在Program.cs中配置Kestrel
builder.WebHost.ConfigureKestrel(options =>
{
    // 监听指定端口并强制使用HTTP/1.x
    options.ListenAnyIP(5000, listenOptions =>
    {
        listenOptions.Protocols = Microsoft.AspNetCore.Server.Kestrel.Core.HttpProtocols.Http1;
    });

    // 如果不需要Kestrel自动添加Server头，可关闭后手动添加
    options.AddServerHeader = false;
});

之后在Controller或中间件中按顺序添加头即可：

public IActionResult Get()
{
    var response = HttpContext.Response;
    // 按指定顺序添加头
    response.Headers["Content-Length"] = "206";
    response.Headers["Content-Type"] = "application/json; charset=utf-8";
    response.Headers["Vary"] = "Accept";
    response.Headers["Server"] = "Microsoft-HTTPAPI/2.0";
    response.Headers["Link"] = "</Servicename.xml>; rel=\"application/xml\"";
    response.Headers["x-powered-by"] = "...";
    
    // Date头Kestrel会自动添加，若要自定义顺序需先清除再手动添加
    response.Headers.Remove("Date");
    response.Headers["Date"] = DateTime.UtcNow.ToString("r");
    
    return Json(new { /* 响应内容 */ });
}

方法2：自定义中间件手动构造完整响应（兼容HTTP/1.x和HTTP/2） #

如果必须支持HTTP/2，由于HTTP/2规范强制要求头排序，只能通过中间件绕过Kestrel的头处理逻辑，手动构造整个响应：

// 在Program.cs中注册中间件（注意要放在UseRouting和UseEndpoints之前）
app.Use(async (context, next) =>
{
    // 保存原始响应流，替换为内存流以捕获响应内容
    var originalBody = context.Response.Body;
    using var memoryStream = new MemoryStream();
    context.Response.Body = memoryStream;

    // 执行后续中间件（包括MVC处理逻辑）
    await next();

    // 读取捕获的响应内容
    memoryStream.Seek(0, SeekOrigin.Begin);
    var responseContent = await new StreamReader(memoryStream).ReadToEndAsync();
    var contentBytes = Encoding.UTF8.GetBytes(responseContent);

    // 重置响应，清除所有自动生成的头
    context.Response.Clear();

    // 按指定顺序手动添加所有响应头
    context.Response.Headers["Content-Length"] = contentBytes.Length.ToString();
    context.Response.Headers["Content-Type"] = "application/json; charset=utf-8";
    context.Response.Headers["Vary"] = "Accept";
    context.Response.Headers["Server"] = "Microsoft-HTTPAPI/2.0";
    context.Response.Headers["Link"] = "</Servicename.xml>; rel=\"application/xml\"";
    context.Response.Headers["x-powered-by"] = "...";
    context.Response.Headers["Date"] = DateTime.UtcNow.ToString("r");

    // 将响应内容写入原始流
    context.Response.Body = originalBody;
    await context.Response.Body.WriteAsync(contentBytes);
});

注意事项 #

• HTTP规范本身并不要求响应头的顺序，仅HTTP/2有强制排序要求。如果不是因为遗留客户端依赖头顺序，建议保留默认排序逻辑。
• 部分头（如Date、Server）会由Kestrel自动添加，若要自定义顺序，需先调用Remove清除后再手动添加。

内容的提问来源于stack exchange，提问作者Matthias Müller