.NET 6传统API控制器使用IResult返回值无法正确返回状态码的问题

问题原因 #

传统ControllerBase会将返回的IResult实例当作普通响应内容，包装成OkObjectResult返回，因此始终得到200状态码，而不会执行IResult自身定义的响应逻辑（比如BadRequest对应的400状态码）。

解决方法 #

以下两种方案无需编写大量映射函数，可快速解决问题：

方法1：扩展方法手动执行IResult

创建扩展方法直接执行IResult的响应逻辑，再返回空结果避免被包装：

public static class ResultActionExtensions
{
    public static async Task<ActionResult> AsActionResult(this IResult result, HttpContext context)
    {
        await result.ExecuteAsync(context);
        return new EmptyResult();
    }
}

控制器中使用示例：

[ApiController]
public class TestController : ControllerBase
{
    [HttpPut("test")]
    public async Task<ActionResult> Test()
    {
        var result = Results.BadRequest("请求参数错误");
        return await result.AsActionResult(HttpContext);
    }
}

方法2：全局配置OutputFormatter（批量解决）

如果多个控制器都需要返回IResult，可配置全局输出格式化器，自动处理IResult类型返回值：

1. 实现自定义格式化器：

public class ResultOutputFormatter : IOutputFormatter
{
    public bool CanWriteResult(OutputFormatterCanWriteContext context)
    {
        return context.Object is IResult;
    }

    public async Task WriteAsync(OutputFormatterWriteContext context)
    {
        if (context.Object is IResult result)
        {
            await result.ExecuteAsync(context.HttpContext);
            await context.HttpContext.Response.CompleteAsync();
        }
    }
}

2. 在Program.cs中注册格式化器：

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllers(options =>
{
    options.OutputFormatters.Insert(0, new ResultOutputFormatter());
});

var app = builder.Build();

// 其他中间件配置...

app.MapControllers();
app.Run();

之后控制器可直接返回IResult，无需修改返回类型：

[ApiController]
public class TestController : ControllerBase
{
    [HttpPut("test")]
    public async Task<IResult> Test()
    {
        return Results.BadRequest("请求参数错误");
    }
}

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