ASP.NET Core Mvc中空返回值的处理方式

原文地址：https://www.strathweb.com/2018/10/convert-null-valued-results-to-404-in-asp-net-core-mvc/
作者: Filip W.
译者: Lamond Lu

.NET Core MVC在如何返回操作结果方面非常灵活的。
你可以返回一个实现IActionResult接口的对象, 比如我们熟知的ViewResult, FileResult, ContentResult等。

[HttpGet]
public IActionResult SayGood()
{
    return Content("Good!");
}

当然你还可以直接返回一个类的实例。

[HttpGet]
public string HelloWorld()
{
    return "Hello World";
}

在.NET Core 2.1中, 你还可以返回一个ActionResult的泛型对象。

[HttpGet]
public ActionResult<IEnumerable<string>> Get()
{
    return new string[] { "value1", "value2" };
}

今天的博客中，我们将一起看一下.NET Core Mvc是如何返回一个空值对象的，以及如何改变.NET Core Mvc针对空值对象结果的默认行为。

.NET Core Mvc针对空值对象的默认处理行为

那么当我们在Action中返回null时, 结果是什么样的呢？
下面我们新建一个ASP.NET Core WebApi项目，并添加一个BookController, 其代码如下：

[Route("api/[controller]")]
[ApiController]
public class BookController : ControllerBase
{
    private readonly List<Book> _books = new List<Book> {
        new Book(1, "CLR via C#"),
        new Book(2, ".NET Core Programming")
    };

    [HttpGet("{id}")]
    public IActionResult GetById(int id)
    {
        var item = _books.FirstOrDefault(p => p.BookId == id);
        return Ok(item);
    }

    //[HttpGet("{id}")]
    //public ActionResult<Book> GetById(int id)
    //{
    //    var book = _books.FirstOrDefault(p => p.BookId == id);
    //    return book;
    //}

    //[HttpGet("{id}")]
    //public Book GetById(int id)
    //{
    //    var book = _books.FirstOrDefault(p => p.BookId == id);
    //    return book;
    //}
}

public class Book
{
    public Book(int bookId, string bookName)
    {
        BookId = bookId;
        BookName = bookName;
    }

    public int BookId { get; set; }

    public string BookName { get; set; }
}

在这个Controller中，我们定义了一个图书的集合，并提供了根据图书ID查询图书的三种实现方式。

然后我们启动项目, 并使用Postman, 并请求/api/book/3, 结果如下：

你会发现返回的Status是204 NoContent, 而不是我们想象中的200 OK。你可修改之前代码的注释, 使用其他2种方式，结果也是一样的。

你可以尝试创建一个普通的ASP.NET Mvc项目, 添加相似的代码，结果如下

返回的结果是200 OK, 内容是null

为什么会出现结果呢？
与前辈们(ASP.NET Mvc, ASP.NET WebApi)不同，ASP.NET Core Mvc非常巧妙的处理了null值，在以上的例子中，ASP.NET Core Mvc会选择一个合适的输出格式化器(output formatter)来输出响应内容。通常这个输出格式化器会是一个JSON格式化器或XML格式化器。

但是对于null值, ASP.NET Core Mvc使用了一种特殊的格式化器HttpNoContentOutputFormatter, 它会将null值转换成204的状态码。这意味着null值不会被序列化成JSON或XML, 这可能不是我们期望的结果, 有时候我们希望返回200 OK, 响应内容为null。

Tips: 当Action返回值是void或Task时，ASP.NET Core Mvc默认也会使用HttpNoContentOutputFormatter

通过修改配置移除默认的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;
        });
    });
}

修改之后我们重新运行程序，并使用Postman访问/api/book/3

结果如下, 返回值200 OK, 内容为null, 这说明我们的修改成功了。

使用404 Not Found代替204 No Content

在上面的例子中， 我们禁用了204 No Content行为，响应结果变为了200 OK, 内容为null。 但是有时候，我们期望当找不到任何结果时，返回404 Not Found , 那么这时候我们应该修改代码，进行扩展呢？

在.NET Core Mvc中我们可以使用自定义过滤器(Custom Filter), 来改变这一行为。

这里我们创建2个特性类NotFoundActionFilterAttribute和NotFoundResultFilterAttribute , 代码如下：

public class NotFoundActionFilterAttribute : ActionFilterAttribute
{
    public override void OnActionExecuted(ActionExecutedContext context)
    {
        if (context.Result is ObjectResult objectResult && objectResult.Value == null)
        {
            context.Result = new NotFoundResult();
        }
    }
}

public class NotFoundResultFilterAttribute : ResultFilterAttribute
{
    public override void OnResultExecuting(ResultExecutingContext context)
    {
        if (context.Result is ObjectResult objectResult && objectResult.Value == null)
        {
            context.Result = new NotFoundResult();
        }
    }
}

代码解释

  • 这里使用了ActionFilterAttribute和ResultFilterAttribute,ActionFilterAttribute中的OnActionExecuted方法会在action执行完后触发, ResultFilterAttribute的OnResultExecuting会在action返回结果前触发。
  • 这2个方法都是针对action的返回结果进行了替换操作，如果返回结果的值是null, 就将其替换成NotFoundResult

添加完成后，你可以任选一个类，将他们添加在

controller头部

[Route("api/[controller]")]
[ApiController]
[NotFoundResultFilter]
public class BookController : ControllerBase
{
    ...
}

或者action头部

[HttpGet("{id}")]
[NotFoundResultFilter]
public IActionResult GetById(int id)
{
    var item = _books.FirstOrDefault(p => p.BookId == id);
    return Ok(item);
}

你还可以在添加Mvc服务的时候配置他们

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc(o =>
    {
        o.Filters.Add(new NotFoundResultFilterAttribute());
    });
}

选择一种重新运行项目之后，效果和通过修改配置移除默认的null值格式化器是一样的。

IAlwaysRunResultFilter

以上的几种解决方案看似完美无缺，但实际上还是存在一点瑕疵。由于ASP.NET Core Mvc中过滤器的短路机制(即在任何一个过滤器中对Result赋值都会导致程序跳过管道中剩余的过滤器)，可能现在使用某些第三方组件后, 第三方组件在管道中插入自己的短路过滤器，从而导致我们的代码失效。

ASP.NET Core Mvc的过滤器，可以参见这篇文章

下面我们添加以下的短路过滤器。

public class ShortCircuitingFilterAttribute : ActionFilterAttribute
{
    public override void OnActionExecuting(ActionExecutingContext context)
    {
        context.Result = new ObjectResult(null);
    }
}

然后修改BookController中GetById的方法

[HttpGet("{id}")]
[ShortCircuitingFilter]
[NotFoundActionFilter]
public IActionResult GetById(int id)
{
    var item = _books.FirstOrDefault(p => p.BookId == id);
    return Ok(item);
}

重新运行程序后，使用Postman访问/api/book/3, 程序又返回了204 Not Content, 这说明我们的代码失效了。

这时候，为了解决这个问题，我们需要使用.NET Core 2.1中新引入的接口IAlwaysRunResultFilter。实现IAlwaysRunResultFilter接口的过滤器总是会执行，不论前面的过滤器是否触发短路。

这里我们添加一个新的过滤器NotFoundAlwaysRunFilterAttribute。

public class NotFoundAlwaysRunFilterAttribute : Attribute, IAlwaysRunResultFilter
{
    public void OnResultExecuted(ResultExecutedContext context)
    {
    }

    public void OnResultExecuting(ResultExecutingContext context)
    {
        if (context.Result is ObjectResult objectResult && objectResult.Value == null)
        {
            context.Result = new NotFoundResult();
        }
    }
}

然后我们继续修改BookController中的GetById方法, 为其添加NotFoundAlwaysRunFilter特性

[HttpGet("{id}")]
[ShortCircuitingFilter]
[NotFoundActionFilter]
[NotFoundAlwaysRunFilter]
public IActionResult GetById(int id)
{
    var item = _books.FirstOrDefault(p => p.BookId == id);
    return Ok(item);
}

重新运行程序后，使用Postman访问/api/book/3, 程序又成功返回了404 Not Found, 这说明我们的代码又生效了。

原文地址：https://www.cnblogs.com/lwqlun/p/9801047.html

时间： 2024-10-11 01:59:30

ASP.NET Core Mvc中空返回值的处理方式的相关文章

Pro ASP.NET Core MVC 第6版 第一章

第一章 ASP.NET Core MVC 的前世今生 ASP.NET Core MVC 是一个微软公司开发的Web应用程序开发框架,它结合了MVC架构的高效性和简洁性,敏捷开发的思想和技术,和.NET 平台的最好的部分.在本章,我们将学习为什么微软创建ASP.NET Core MVC, 看看他和他的前辈的比较以及和其他类似框架的比较,最后,大概讲一下ASP.NET core MVC里面有什么新东西,还有本书中包括哪些内容. 了解ASP.NET Core MVC的历史 最开始的ASP.NET 诞生

ASP.NET Core MVC/WebAPi 模型绑定探索

前言 相信一直关注我的园友都知道,我写的博文都没有特别枯燥理论性的东西,主要是当每开启一门新的技术之旅时,刚开始就直接去看底层实现原理,第一会感觉索然无味,第二也不明白到底为何要这样做,所以只有当你用到了,你再去看理论性的文章时才会豁然开朗,这是我一直以来学习技术的方法.本文我们来讲解.NET Core中的模型绑定. 话题 在ASP.NET Core之前MVC和Web APi被分开,也就说其请求管道是独立的,而在ASP.NET Core中,WebAPi和MVC的请求管道被合并在一起,当我们建立控

第二章 指南（2）用 Visual Studio 和 ASP.NET Core MVC 创建首个 Web API

小分享:我有几张阿里云优惠券,用券购买或者升级阿里云相应产品最多可以优惠五折!领券地址:https://promotion.aliyun.com/ntms/act/ambassador/sharetouser.html?userCode=ohmepe03 原文:Building Your First Web API with ASP.NET Core MVC and Visual Studio 作者:Mike Wasson 和 Rick Anderson 翻译:谢炀(kiler) 校对:何镇汐.

Pro ASP.NET Core MVC 6th 第三章

第三章 MVC 模式,项目和约定 在深入了解ASP.NET Core MVC的细节之前,我想确保您熟悉MVC设计模式背后的思路以及将其转换为ASP.NET Core MVC项目的方式. 您可能已经了解本章中讨论的一些想法和约定,特别是如果您已经完成了高级ASP.NET或C#开发. 如果没有,我鼓励你仔细阅读 - 深入地理解隐藏在MVC背后的东西可以帮助你在通读本书时更好地与MVC框架的功能联系起来. MVC的历史 模型视图控制器模式起源于20世纪70年代后期,来自施乐PARC的Smalltalk

Pro ASP.NET Core MVC 第6版 第二章（后半章）

增加动态输出 整个web应用平台的关注点在于构建并显示动态输出内容.在MVC里,控制器负责构建一些数据并将其传给视图.视图负责渲染成HTML. 从控制器向视图传递数据的一种方式是使用ViewBag 对象,它是一个控制器基类的成员.ViewBag是一个动态对象,你可以给他赋值任意属性给视图来渲染用.代码2-5 演示了如何在HomeController里传递简单对象. Listing 2-5. 设置视图数据 using System; using Microsoft.AspNetCore.Mvc;

【翻译】在Visual Studio中使用Asp.Net Core MVC创建你的第一个Web API应用（一）

HTTP is not just for serving up web pages. It's also a powerful platform for building APIs that expose services and data. HTTP is simple, flexible, and ubiquitous. Almost any platform that you can think of has an HTTP library, so HTTP services can re

Pro ASP.NET Core MVC 第6版 第二章（前半章）

目录 第二章 第一个MVC 应用程序 学习一个软件开发框架的最好方法是跳进他的内部并使用它.在本章,你将用ASP.NET Core MVC创建一个简单的数据登录应用.我将它一步一步地展示,以便你能看清楚怎样构建一个MVC 应用程序.为了让事情简单,我跳过了一些技术细节,但是不要担心,如果你是一个MVC的新手,你将会发现许多东西足够提起你的兴趣.因为我用的东西有些没做解释,所以我提供了一些参考以便你可以看到所有的细节的东西. 安装Visual Studio 要想根据本书实践的话,必须安装Visua

007.Adding a view to an ASP.NET Core MVC app -- 【在asp.net core mvc中添加视图】

Adding a view to an ASP.NET Core MVC app 在asp.net core mvc中添加视图 2017-3-4 7 分钟阅读时长 本文内容 1.Changing views and layout pages 修改视图和布局页 2.Change the title and menu link in the layout file 在布局文件中修改标题与菜单 3.Passing Data from the Controller to the View 从控制器向视图

剖析ASP.NET Core MVC（Part 1）- AddMvcCore（译）

原文:https://www.stevejgordon.co.uk/asp-net-core-mvc-anatomy-addmvccore发布于:2017年3月环境:ASP.NET Core 1.1 欢迎阅读新系列的第一部分,我将剖析MVC源代码,给大家展示隐藏在表面之下的工作机制.此系列将分析MVC的内部,如果觉得枯燥,可以停止阅读.但就我个人而言,也是经过反复阅读.调试甚至抓狂,直到最后理解ASP.NET MVC源代码(或者自认为理解),从中获益匪浅.通过了解框架的运作机制,我们可以更好的使