前言

从.NET Core 2.1版开始,到目前为止,控制器操作可以返回三种类型的WebApi响应。这三种类型都有自己的优点和缺点,但都缺乏满足REST和高可测性的选项。

ASP.NET Core中可用的响应类型包括最近发布的2.2版本

  • 具体类型的结果
  • IActionResult
  • 的ActionResult <T>

最后一个reult选项  ActionResult <T>是在.NET Core 2.1中引入的。我将使用一个简单的例子来比较使用这三个控制器动作响应类型选项的优缺点。

文章内容

返回HTTP状态

这是您在WebAPI应用程序开发过程中必须要具备的。虽然可以遵循REST,但是任何程序功能都是由业务需求驱动的。如果由于控制器操作而返回特定类型,您可能偶尔发现的一件事肯定会返回自定义HTTP状态代码。

让我们看看具有特定类型返回的简单操作,并让它们注意比较。

具体类型

[HttpGet("{id}")]
public IEnumerable<string> GetById(int id)
{
if (id>0)
{
return new List<string>()
{
"Value1","Value2","Value3"
};
}
return null;
}

我们有了上面的简单单吗,如果ID参数大于0,并返回字符串列表,反则返回null。转换成HTTP,对于任何返回的数据,我们将有 200 OK 状态吗响应,以下是我使用PostMan的测试结果图,请参考。

如果没有数据,我们将会有一个204 No Content 响应。 对于大多数客户来说,这是非常满意的,但是假设我们需要返回另一个状态代码,例如,小于0的任何值,我们直接希望告诉客户发送的数据无效,理想情况下,我们将会返回404 BadRequest状态代码。

现在这是特定类型选项问题,由于我们的方法,我们不能立即返回400 BadRequest状态代码,如果我们决定抛出一个异常会导致500 ServerError的响应,这是错误的,因为无效数据基本上是客户端错误并且属于4xx响应代码列表。

执行此操作的方法是显示设定响应状态码并返回空值,这样就可以保留未同步的两个操作间隙,因为你必须要处理状态并返回数据。

[HttpGet("{id}")]
public IEnumerable<string> GetById(int id)
{
if (id > 0)
{
return new List<string>()
{
"Value1","Value2","Value3"
};
}
else if (id < 0)
Response.StatusCode = 400;
return null;
}

处理HTTP POST和HTTP PATCH / PUT请求时遇到的问题更多,而不是200 OK,除了之前的400 BadRequest之外,您可能还必须使用201 Created of 202 Accepted HTTP状态代码进行响应,这将是模型验证的情况。使用不同的状态代码并不是那么直接,并且您有多条线负责正确的响应,这与其他两种返回类型不同。

IActionResult

让我们看看我们如何通过使用IActionResult作为控制器动作的返回类型来解决这个问题

[HttpGet("{id}")]
public IActionResult GetById(int id)
{
if (id > 0)
{
return Ok(new List<String>()
{
"Value1",
"Value2",
"Value3",
});
}
else if (id < 0)
{
return BadRequest();
}
return NoContent();
}

现在我们可以自由使用我们认为适合的状态代码,以告知客户我们或我们没有任何限制地处理他的请求。使用IAction结果显然比返回特定类型实例更先进,让.NET决定什么是状态代码。

ActionResult<T>

关于状态代码,IActionResult和ActionResult <T>返回类型同样适用在从方法返回结果时直接设置状态代码方面会产生很大差异

但是,还有其他方面,ActionResult <T>比IActionResult更高级,更适合从控制器操作方法返回响应。

[HttpGet("{id}")]
public ActionResult<IEnumerable<string>> GetById(int id)
{
if (id > 0)
{
return Ok(new List<String>()
{
"Value1",
"Value2",
"Value3",
});
}
else if (id < 0)
{
return BadRequest();
}
return NoContent();
}

您已经了解了ASP.NET MVC Core WebAPI项目中控制器操作的不同响应类型的一些优缺点。很明显IActionResult和ActionResult <T>是比返回特定类型更好的选择,虽然您可能会发现在控制器操作中返回特定类型更为舒适,但您可能会使单元测试无法正确覆盖您的代码,因此将来可能会打开潜在的危险。

总结

具体类型

如果在执行动作期间没有已知的防范条件,则返回特定类型就足够了。上述操作不接受任何参数,因此不需要参数约束验证。

IActionResult类型

当一个动作中有多个ActionResult返回类型时,IActionResult返回类型是合适的。这些类型代表各种HTTP状态代码。属于此类别的一些常见返回类型是BadRequestResult(400),NotFoundResult(404)和OkObjectResult(200)。

ActionResult <T>类型

大多数操作都有特定的返回类型。在操作执行期间可能发生意外情况,在这种情况下不返回特定类型。例如,操作的输入参数可能无法通过模型验证。在这种情况下,通常返回适当的ActionResult类型而不是特定类型。

ASP.NET Core WebAPI控制器返回类型的最佳选项的更多相关文章

  1. asp.net mvc Controller控制器返回类型

    ASP.NET MVC包括了执行常见任务的ActionResult类型.这些类型罗列在表5-1中.每个类型都将在随后的小节中详细讨论. 表5-1  动作结果的类型及其说明 动作结果的类型 说    明 ...

  2. asp.net core webapi 日期返回中出现字母T

    全局配置 在Startup文件中修改 // This method gets called by the runtime. Use this method to add services to the ...

  3. ASP.NET Core webapi json 返回时间格式问题

    网站找了几个方案不好使,比如: 1: services.AddMvc().AddJsonOptions(opt => { opt.SerializerSettings.DateFormatStr ...

  4. ASP.NET Core WebApi返回结果统一包装实践

    前言 近期在重新搭建一套基于ASP.NET Core WebAPI的框架,这其中确实带来了不少的收获,毕竟当你想搭建一套框架的时候,你总会不自觉的去想,如何让这套框架变得更完善一点更好用一点.其中在关 ...

  5. ASP.NET Core WebApi 返回统一格式参数(Json 中 Null 替换为空字符串)

    相关博文:ASP.NET Core WebApi 返回统一格式参数 业务场景: 统一返回格式参数中,如果包含 Null 值,调用方会不太好处理,需要替换为空字符串,示例: { "respon ...

  6. asp.net core WebApi 返回 HttpResponseMessage

    ASP.NET WebApi 2 中的示例代码: [Route("values/{id}")] public async Task<HttpResponseMessage&g ...

  7. 【转】ASP.NET Core WebAPI JWT Bearer 认证失败返回自定义数据 Json

    应用场景:当前我们给微信小程序提供服务接口,接口中使用了权限认证这一块,当我使用 JWT Bearer 进行接口权限认证的时候,返回的结果不是我们客户端想要的,其它我们想要给客户端返回统一的数据结构, ...

  8. ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了

    引言 在使用asp.net core 进行api开发完成后,书写api说明文档对于程序员来说想必是件很痛苦的事情吧,但文档又必须写,而且文档的格式如果没有具体要求的话,最终完成的文档则完全取决于开发者 ...

  9. ASP.NET Core WebApi使用Swagger生成api

    引言 在使用asp.net core 进行api开发完成后,书写api说明文档对于程序员来说想必是件很痛苦的事情吧,但文档又必须写,而且文档的格式如果没有具体要求的话,最终完成的文档则完全取决于开发者 ...

随机推荐

  1. Newtonsoft.Json输出Json时动态忽略属性

    一,前言 最近做项目采用Json形式和其他客户端交互,借助于Newtonsoft.Json . 由于业务场景不同,输出的Json内容也不同.要想忽略的属性,可以借助Newtonsoft.Json的特性 ...

  2. Codechef April Challenge 2019 游记

    Codechef April Challenge 2019 游记 Subtree Removal 题目大意: 一棵\(n(n\le10^5)\)个结点的有根树,每个结点有一个权值\(w_i(|w_i\ ...

  3. MyBatis3系列__06查询的几点补充

    关于查询的一点补充: 当查询部门信息时,希望查询该部门下的所有员工,下面会采取两种方式实现: 1.联合查询 public Department getDeptWithEmpById(Integer i ...

  4. Hive表生成函数explode讲解

    Hive中的表分析函数接受零个或多个输入,然后产生多列或多行输出. 1.explode函数 explode函数以array类型数据输入,然后对数组中的数据进行迭代,返回多行结果,一行一个数组元素值 A ...

  5. 用generator改写ajax

    function request(url) { // this is where we're hiding the asynchronicity, // away from the main code ...

  6. Java课程之团队开发(团队介绍)

    一.介绍团队和团队成员 团队名称:凯域软创 团队成员介绍:张某某,崔某某,焦某某,陈某 二.关于团队作品 1.作品名称:课程表 2.你的创意解决了用户的什么需求:查看课程信息的需求 3.你有什么招数用 ...

  7. Spring源码阅读 源码环境搭建(一)

    ring 源码阅读的搭建(一) 一 下载spring源码 进入官方网页:https://spring.io/projects/spring-framework 进入相关的github位置,下载zip包 ...

  8. extremecomponents

    具体教程: http://www.cnblogs.com/QQParadise/articles/1488920.html 教程中涉及到springmvc的相关知识 下载地址:http://sourc ...

  9. excel写入操作

    字典列表类型数据写入excel. #导入xlwt库 import xlwt import os # 步骤1:获取excel文件的绝对路径 dirPath = os.path.join(os.getcw ...

  10. new Date()设置日期在IOS的兼容问题

    一般这样创建一个日期变量 var d = new Date("2017-08-11 12:00:00"); 发现在iOS中不兼容,返回valid Date. IOS中不支持 - 连 ...