ASP.NET Core 6中OnGet调用HttpContext.Response.WriteAsync抛异常问题

问题说明 #

在ASP.NET Core 6的Razor Pages项目中，修改Index.cshtml.cs的OnGet方法，添加HttpContext.Response.WriteAsync("<h1>hello world</h1>")代码后，运行时抛出异常，错误信息如下：

fail: Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware[1]
执行请求时发生未处理的异常。
System.InvalidOperationException: 标头为只读，响应已启动。

错误原因 #

Razor Pages的生命周期中，OnGet方法执行完成后，框架会自动启动响应流程，开始渲染Index.cshtml视图并向客户端发送响应内容。此时响应的标头已经发送，响应流处于已启动状态，无法再通过HttpContext.Response.WriteAsync直接写入内容，否则会触发冲突导致异常。

解决方案 #

方案1：返回ContentResult替代直接写入响应 #

如果不需要渲染视图，只想输出指定内容，将OnGet方法的返回类型改为IActionResult，返回ContentResult即可：

using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.RazorPages;

namespace ResponserWrite.Pages
{
    public class IndexModel : PageModel
    {
        private readonly ILogger<IndexModel> _logger;

        public IndexModel(ILogger<IndexModel> logger)
        {
            _logger = logger;
        }

        public IActionResult OnGet()
        {
            return Content("<h1>hello world</h1>", "text/html");
        }
    }
}

方案2：在视图中输出内容 #

如果需要保留视图渲染，直接在Index.cshtml中添加输出内容即可，无需在PageModel中操作响应流：

<h1>hello world</h1>
<!-- 其他视图原有内容 -->

方案3：通过中间件操作响应流 #

如果必须直接操作响应流，建议在自定义中间件中实现——中间件处于请求管道的更早阶段，此时响应尚未启动，可以安全写入内容。示例代码如下：

public class CustomResponseMiddleware
{
    private readonly RequestDelegate _next;

    public CustomResponseMiddleware(RequestDelegate next)
    {
        _next = next;
    }

    public async Task InvokeAsync(HttpContext context)
    {
        // 在后续管道执行前写入内容
        await context.Response.WriteAsync("<h1>hello world</h1>");
        await _next(context);
    }
}

// 在Program.cs中注册中间件
app.UseMiddleware<CustomResponseMiddleware>();

内容的提问来源于stack exchange，提问作者prasad mamidi