ASP.NET Core中的Action的返回值类型实现

在Asp.net Core之前所有的Action返回值都是ActionResult,Json(),File()等方法返回的都是ActionResult的子类。并且Core把MVC跟WebApi合并之后Action的返回值体系也有了很大的变化。

ActionResult类

ActionResult类是最常用的返回值类型。基本沿用了之前Asp.net MVC的那套东西,使用它大部分情况都没问题。比如用它来返回视图,返回json,返回文件等等。如果是异步则使用Task。

  public class TestController : Controller
  {
    public ActionResult Index()
    {
      return View();
    }

    public ActionResult MyFile()
    {
      return File(new byte[] { }, "image/jpg");
    }

    public ActionResult MyJson()
    {
      return Json(new { name = "json" });
    }

    public ActionResult Ok()
    {
      return Ok();
    }
  }

IActionResult接口

ActionResult类实现了IActionResult接口所以能用ActionResult的地方都可以使用IActionResult来替换。同样异步的话使用Task包起来做为返回值。

  public class ITestController : Controller
  {
    public IActionResult Index()
    {
      return View();
    }

    public IActionResult MyFile()
    {
      return File(new byte[] { }, "image/jpg");
    }

    public IActionResult MyJson()
    {
      return Json(new { name = "json" });
    }

    public IActionResult HttpOk()
    {
      return Ok();
    }

    public async Task<IActionResult> AsyncCall()
    {
      await Task.Delay(1000);

      return Content("ok");
    }
  }

直接返回POCO类

Asp.net Core的Controller的Action可以把POCO类型(其实不一定是POCO类,可以是任意类型,但是使用的时候一般都返回viwemodel等POCO类)当做返回值,不一定非要是ActionResult或者IActionResult。Asp.net Core框架会帮我们自动序列化返回给前端,默认使用json序列化。同样异步的话使用Task包起来做为返回值。

 public class Person
  {
    public string Name { get; set; }

    public string Sex { get; set; }
  }

  public class ITestController : Controller
  {

     public Person GetPerson()
    {
      return new Person { Name = "abc", Sex = "f" };
    }

    public async Task<List<Person>> GetPersons()
    {
      await Task.Delay(1000);

      return new List<Person> {
      new Person { Name = "abc", Sex = "f" },
      new Person { Name = "efg", Sex = "m" }
      };
    }
  }

ActionResult< T >泛型类

当我们设计restful webapi系统的时候习惯使用POCO做为返回值。比如我们设计一个获取Person的api。通过 /person/001 url获取001号person。

  [Route("[controller]")]
  public class PersonController : Controller
  {
    IPersonRepository _repository;
    PersonController(IPersonRepository repository)
    {
      _repository = repository;
    }

    [HttpGet("{id}")]
    public Person Get(string id)
    {
      return _repository.Get(id);
    }
  }

这个方法看起来好像没什么问题,但其实有个小问题。如果repository.Get方法没有根据id查找到数据,那么将会返回null。如果null做为Action的返回值,最后框架会转换为204的http status code。

204表示No Content 。做为restful api,204的语义在这里会有问题,这里比较适合的status code是404 NOT FOUND 。那么我们来改一下:

   [HttpGet("{id}")]
    public Person Get(string id)
    {
      var person = _repository.Get(id);
      if (person == null)
      {
        Response.StatusCode = 404;
      }

      return person;
    }

现在如果查找不到person数据,则系统会返回404 Not Found 。

但是这看起来显然不够优雅,因为ControllerBase内置了NotFoundResult NotFound() 方法。这使用这个方法代码看起来更加清晰明了。继续改:

   [HttpGet("{id}")]
    public Person Get(string id)
    {
      var person = _repository.Get(id);
      if (person == null)
      {
        return NotFound();
      }
      return person;
    }

很不幸,这段代码VS会提示错误。因为返回值类型不一致。方法签名的返回值是Person,但是方法内部一会返回NotFoundResult,一会返回Person。

解决这个问题就该ActionResult< T >出场了。我们继续改一下:

   [HttpGet("{id}")]
    public ActionResult<Person> Get(string id)
    {
      var person = _repository.Get(id);
      if (person == null)
      {
        return NotFound();
      }

      return person;
    }

现在VS已经不会报错了,运行一下也可以正常工作。但仔细想想也很奇怪,为什么返回值类型改成了ActionResult< Person >就不报错了呢?明明返回值类型跟方法签名还是不一致啊?

深入ActionResult< T >

接上面的问题,让我们看一下ActionResult的内部:

看到这里就明白了原来ActionResult< T >里面内置了2个implicit operator方法。implicit operator用于声明隐式类型转换。

public static implicit operator ActionResult<TValue>(ActionResult result); 

表示ActionResult类型可以转换为ActionResult< TValue >类型。

public static implicit operator ActionResult<TValue>(TValue value)

表示TValue类型可以转换为ActionResult< TValue >类型。

因为有了这2个方法,当ActionResult或者TValue类型往ActionResult< T >赋值的时候会进行一次自动的类型转换。所以VS这里不会报错。

总结

  • 大部分时候Action的返回值可以使用ActionResult/IActionResult
  • 设计restful api的时候可以直接使用POCO类作为返回值
  • 如果要设计既支持POCO类返回值或者ActionResult类为返回值的action可以使用ActionResult< T >作为返回值
  • ActionResult< T >之所以能够支持两种类型的返回值类型,是因为使用了implicit operator内置了2个隐式转换的方法

到此这篇关于ASP.NET Core中的Action的返回值类型实现的文章就介绍到这了,更多相关ASP.NET Core Action的返回值类型内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

时间: 2020-04-18

asp.net core MVC 过滤器之ActionFilter过滤器(2)

本系类将会讲解asp.net core MVC中的内置过滤器的使用,将分为以下章节 asp.net core MVC 过滤器之ExceptionFilter过滤器(一) asp.net core MVC 过滤器之ActionFilter过滤器(二) asp.net core MVC 过滤器之ResultFilter过滤器(三) asp.net core MVC 过滤器之ResourceFilter过滤器(四) asp.net core MVC 过滤器之AuthorizationFilter过滤器

asp.net core MVC 全局过滤器之ExceptionFilter过滤器(1)

本系类将会讲解asp.net core MVC中的内置全局过滤器的使用,将分为以下章节 asp.net core MVC 过滤器之ExceptionFilter过滤器(一) asp.net core MVC 过滤器之ActionFilter过滤器(二) asp.net core MVC 过滤器之ResultFilter过滤器(三) asp.net core MVC 过滤器之ResourceFilter过滤器(四) asp.net core MVC 过滤器之AuthorizationFilter过

ASP.NET Core MVC 过滤器的使用方法介绍

过滤器的作用是在 Action 方法执行前或执行后做一些加工处理.使用过滤器可以避免Action方法的重复代码,例如,您可以使用异常过滤器合并异常处理的代码. 过滤器如何工作? 过滤器在 MVC Action 调用管道中运行,有时称为过滤器管道.MVC选择要执行的Action方法后,才会执行过滤器管道: 实现 过滤器同时支持同步和异步两种不同的接口定义.您可以根据执行的任务类型,选择同步或异步实现. 同步过滤器定义OnStageExecuting和OnStageExecuted方法,会在管道特定

asp.net core mvc实现伪静态功能

在大型网站系统中,为了提高系统访问性能,往往会把一些不经常变得内容发布成静态页,比如商城的产品详情页,新闻详情页,这些信息一旦发布后,变化的频率不会很高,如果还采用动态输出的方式进行处理的话,肯定会给服务器造成很大的资源浪费.但是我们又不能针对这些内容都独立制作静态页,所以我们可以在系统中利用伪静态的方式进行处理,至于什么是伪静态,大家可以百度下.我们这里就来介绍一下,在asp.net core mvc中实现伪静态的方式. mvc框架中,view代表的是视图,它执行的结果就是最终输出到客户端浏览

ASP.NET Core MVC学习之视图组件(View Component)

1.视图组件介绍 视图组件是 ASP.NET Core MVC 的新特性,类似于局部视图,但它更强大.视图组件不使用模型绑定,并且仅依赖于调用它时所提供的数据. 视图组件特点: 呈块状,而不是整个响应 包括在控制器和视图之间发现的相同的关注点和可测试性优点 可以拥有参数和业务逻辑 通常从布局页面调用 视图组件可以用在任何需要重复逻辑且对局部视图来说过于复杂的情况,例如: 动态导航菜单 标签云(需要查询数据库) 登录面板 购物车 最近发表的文章 典型博客上的侧边栏内容 将在每个页面上呈现的登录面板

ASP.NET Core Mvc中空返回值的处理方法详解

前言 如果你是一个初学者开始学习 ASP.NET 或 ASP.NET MVC, 你可能并不知道什么是. net Framework和. net ore.不用担心!我建议您看下官方文档https://docs.microsoft.com/zh-cn/aspnet/index , 您可以轻松地看到比较和差异. .NET Core MVC在如何返回操作结果方面非常灵活的. 你可以返回一个实现IActionResult接口的对象, 比如我们熟知的ViewResult, FileResult, Conte

ASP.NET Core MVC如何实现运行时动态定义Controller类型

昨天有个朋友在微信上问我一个问题:他希望通过动态脚本的形式实现对ASP.NET Core MVC应用的扩展,比如在程序运行过程中上传一段C#脚本将其中定义的Controller类型注册到应用中,问我是否有好解决方案.我当时在外边,回复不太方便,所以只给他说了两个接口/类型:IActionDescriptorProvider和ApplicationPartManager.这是一个挺有意思的问题,所以回家后通过两种方案实现了这个需求.源代码从这里下载. 一.实现的效果 我们先来看看实现的效果.如下所

详解ASP.NET Core MVC 源码学习:Routing 路由

前言 最近打算抽时间看一下 ASP.NET Core MVC 的源码,特此把自己学习到的内容记录下来,也算是做个笔记吧. 路由作为 MVC 的基本部分,所以在学习 MVC 的其他源码之前还是先学习一下路由系统,ASP.NET Core 的路由系统相对于以前的 Mvc 变化很大,它重新整合了 Web Api 和 MVC. 路由源码地址 :Routing-dev_jb51.rar 路由(Routing)功能介绍 路由是 MVC 的一个重要组成部分,它主要负责将接收到的 Http 请求映射到具体的一个

ASP.NET Core MVC 配置全局路由前缀

ASP.NET Core MVC 配置全局路由前缀 前言 大家好,今天给大家介绍一个 ASP.NET Core MVC 的一个新特性,给全局路由添加统一前缀.严格说其实不算是新特性,不过是Core MVC特有的. 应用背景 不知道大家在做 Web Api 应用程序的时候,有没有遇到过这种场景,就是所有的接口都是以 /api 开头的,也就是我们的api 接口请求地址是像这样的: http://www.example.com/api/order/333 或者是这样的需求 http://www.exa

Visual Studio ASP.NET Core MVC入门教程第一篇

ASP.NET Core MVC入门教程第一节课,具体内容如下 1.开始环境 visual studio 2017 社区版或其他版本.安装时勾选"Web和云"组中的"ASP.NET及网页开发"项和"其他工具"组中的".NET Core平台开发"项. 2.创建一个网页应用 (1)在 Visual Studio中, select 文件 >新建 >项目. (2) 在"新项目"对话框中的左面板中,点击&