使用 ActionResult 时在中间件中设置响应头

Question

我有一个 asp .net core web api，我需要在响应中设置一些标头。这基于响应的正文。 (计算md5)

我想在自定义中间件中执行此操作，以便每个请求都具有相同的响应标头。

我尝试了以下设置：

首先我有一个带有简单端点的控制器：

[Route("api/[controller]")]
[ApiController]
public class TestController : ControllerBase
{
    [HttpGet]
    [Route("Test")]
    public IActionResult DoTest()
    {
        var result = new { someProp = "somePropValue" };
        return Ok(result);
    }
}

我添加了一个自定义中间件类：

public class CustomResponseHandler
{
    private readonly RequestDelegate _next;

    public CustomResponseHandler(RequestDelegate next)
    {
        _next = next;
    }
    public async Task InvokeAsync(HttpContext context)
    {
        await _next(context);
        context.Response.Headers.Add("foo", "fii");
    }
}

在启动时，我使用 Configure 方法添加了这个中间件：

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }

        app.UseHttpsRedirection();

        app.UseRouting();

        app.UseAuthorization();

        app.UseMiddleware<CustomResponseHandler>();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllers();
        });
    }

当我运行它时， context.Response.Headers.Add("foo", "fii");行确实被执行了。

从完美的端点返回结果后也会执行。

但是，当我查看响应时，仍然缺少标题“foo”。

有没有办法做到这一点。

我注意到在将结果返回端点之前添加标题时确实得到了标题：

    public IActionResult DoTest()
    {
        var result = new { someProp = "somePropValue" };
        Response.Headers.Add("foo", "fii");
        return Ok(result);
    }

Answer 1

当next() 在您的中间件中执行时，服务器已经开始向客户端发送响应。这意味着不能再修改标题。引用此Microsoft Docs：

不要调用 next.Invoke 在响应发送到客户端之后。响应开始后对 HttpResponse 的更改会引发异常。例如，设置标头和状态代码会引发异常。调用 next 后写入响应正文：

• 可能会导致协议违规。例如，写入超过规定的 Content-Length。

• 可能会破坏正文格式。例如，将 HTML 页脚写入 CSS 文件。

你应该做的是在调用next()之前添加标题，或者将它添加到Response.OnStarting的钩子中：

public async Task InvokeAsync(HttpContext context)
{
    context.Response.OnStarting(() =>
    {
        context.Response.Headers.Add("foo", "fii");
        return Task.CompletedTask;
    });
    await next();
}