如何处理ASP.NET Core Mvc中的空返回值问题？

在ASP.NET Core MVC中，处理空返回值是开发过程中常见的需求，本文将深入探讨如何在.NET Core框架下，特别是在针对ASP.NET Core MVC的API控制器中，有效地处理空结果。

一、默认处理行为

当一个Action方法返回null时，ASP.NET Core MVC会根据Action的契约（契约式编程）进行处理，如果返回类型是ActionResult接口，如Action、ActionResult或IActionResult，且没有明确指定具体类型，那么默认情况下，Controller会尝试将null转换为StatusCodeResult，返回404 Not Found状态，这是因为Action未找到匹配的方法处理请求，这并不是所有情况下的最佳实践，为了更好地控制空值返回的行为，可以自定义处理逻辑。

二、自定义处理逻辑

1. 显式返回状态码

使用HttpStatusCodeResult，明确指定状态码，如返回204 No Content或404 Not Found，这样可以增强API的可预测性。

public IActionResult NotFoundBook() {
    return StatusCode(StatusCodes.Status404NotFound);
}

2. 创建自定义Result类

创建一个表示空值的专用ActionResult子类，比如EmptyResult，用于明确表示无数据返回。

public class EmptyResult : ActionResult {
    public override Task ExecuteResultAsync(ActionContext context) {
        context.HttpContext.Response.StatusCode = StatusCodes.Status204NoContent;
        return Task.CompletedTask;
    }
}
[HttpGet]
public EmptyResult GetEmptyResult() {
    return new EmptyResult();
}

3. 使用MaybeResult

如果返回的是值可以为null的数据，考虑使用MaybeResult或ValueTaskResult来封装可能的空值，这样可以在调用者端判断是否存在值。

public class MaybeResult<T> : IActionResult where T : class {
    private readonly T _value;
    public MaybeResult(T value) {
        _value = value;
    }
    public Task<IActionResult> ExecuteResultAsync(ActionContext context) {
        if (_value == null) return Task.FromResult((IActionResult)null);
        return Task.FromResult(ContentResult(_value));
    }
}
[HttpGet]
public MaybeResult<Book> GetOptionalBook() {
    var book = _books.FirstOrDefault(); // 如果有值则返回，否则返回null
    return new MaybeResult<Book>(book);
}

三、修改配置以移除默认的null值格式化器

可以通过设置HttpNoContentOutputFormatter对象的TreatNullValueAsNoContent属性为false，去除默认的HttpNoContentOutputFormatter对null值的格式化，在Startup.cs文件的ConfigureService方法中，我们在添加Mvc服务的地方，修改默认的输出格式化器，代码如下：

public void ConfigureServices(IServiceCollection services) {
    services.AddMvc(o => {
        o.OutputFormatters.RemoveType(typeof(HttpNoContentOutputFormatter));
        o.OutputFormatters.Insert(0, new HttpNoContentOutputFormatter {
            TreatNullValueAsNoContent = false
        });
    });
}

四、表格示例：不同情况下的处理方式对比

理解默认行为：了解ASP.NET Core MVC对空返回值的默认处理行为，有助于更好地控制API的响应。

明确返回状态码：通过显式返回状态码，可以增强API的可预测性和一致性。

使用自定义Result类：对于特定场景下的空值处理，可以考虑创建自定义的Result类来明确表示无数据返回。

利用MaybeResult：对于可能为null的返回值，使用MaybeResult或ValueTaskResult来封装，以便在调用者端进行判断。

修改配置：通过修改配置来移除默认的null值格式化器，以满足特定的业务需求。

六、FAQs

Q1: 如何在ASP.NET Core MVC中修改默认的null值处理行为？

A1: 可以通过设置HttpNoContentOutputFormatter对象的TreatNullValueAsNoContent属性为false来修改默认的null值处理行为，在Startup.cs文件的ConfigureService方法中进行配置。

Q2: 为什么有时候Action返回null会导致404 Not Found？

A2: 这是ASP.NET Core MVC的默认行为之一，当Action返回null且没有明确指定返回类型时，Controller会尝试将null转换为StatusCodeResult并返回404 Not Found状态码，这是因为Action未找到匹配的方法处理请求，为了避免这种情况，可以明确指定返回类型或返回状态码。

小伙伴们，上文介绍了“ASP.NET Core Mvc空返回值处理”的内容，你了解清楚吗？希望对你有所帮助，任何问题可以给我留言，让我们下期再见吧。