C# WebAPI的幾種返回類型方式

更新時間：2025年11月27日 10:49:57 作者：她說彩禮65萬

本文主要介紹了C# WebAPI的幾種返回類型方式,包括直接返回指定類型、返回IActionResult實例和返回ActionResult,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

     [ApiController]
    [Route("[controller]")]
    public class WeatherForecastController : ControllerBase
    {
        [HttpGet]
        public IEnumerable Get()
        {
            var rng = new Random();
            return Enumerable.Range(1, 5).Select(index =&gt; new WeatherForecast
            {
                Date = DateTime.Now.AddDays(index),
                TemperatureC = rng.Next(-20, 55),
                Summary = Summaries[rng.Next(Summaries.Length)]
            })
            .ToArray();
        }
    }

除了這種，也可以返回 IActionResult 實例和 ActionResult 實例。

雖然返回指定的類型是最簡單粗暴的，但它只能返回數(shù)據(jù)，附帶不了http狀態(tài)碼，而 IActionResult 實例可以將 數(shù)據(jù) + Http狀態(tài)碼 一同帶給前端，最后就是 ActionResult 它封裝了前面兩者，可以實現(xiàn)兩種模式的自由切換。

接下來一起討論下如何在 ASP.NET Core Web API 中使用這三種方式。

創(chuàng)建 Controller 和 Model 類

在項目的 Models 文件夾下新建一個 Author 類，代碼如下：

  public class Author
    {
        public int Id { get; set; }
        public string FirstName { get; set; }
        public string LastName { get; set; }
    }

有了這個 Author 類，接下來創(chuàng)建一個 DefaultController 類。

using Microsoft.AspNetCore.Mvc;
using System.Collections.Generic;
 
namespace IDGCoreWebAPI.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class DefaultController : ControllerBase
    {
        private readonly List authors = new List();
        public DefaultController()
        {
            authors.Add(new Author()
            {
                Id = 1,
                FirstName = "Joydip",
                LastName = "Kanjilal"
            });
            authors.Add(new Author()
            {
                Id = 2,
                FirstName = "Steve",
                LastName = "Smith"
            });
        }
 
        [HttpGet]
        public IEnumerable Get()
        {
            return authors;
        }
 
        [HttpGet("{id}", Name = "Get")]
        public Author Get(int id)
        {
            return authors.Find(x =&gt; x.Id == id);
        }
    }
}

在 Action 中返回指定類型

最簡單的方式就是在 Action 中直接返回一個簡單類型或者復(fù)雜類型，其實在上面的代碼清單中，可以看到 Get 方法返回了一個 authors 集合，看清楚了，這個方法定義的是 IEnumerable。

[HttpGet]
public IEnumerable Get()
{
   return authors;
}

在 ASP.NET Core 3.0 開始，你不僅可以定義同步形式的 IEnumerable方法，也可以定義異步形式的 IAsyncEnumerable方法，后者的不同點在于它是一個異步模式的集合，好處就是 不阻塞 當(dāng)前的調(diào)用線程，關(guān)于 IAsyncEnumerable 更多的知識，我會在后面的文章中和大家分享。

下面的代碼展示了如何用 異步集合 來改造 Get 方法。

[HttpGet]
public async IAsyncEnumerable Get()
{
   var authors = await GetAuthors();
   await foreach (var author in authors)
   {
        yield return author;
   }
}

在 Action 中返回 IActionResult 實例

如果你要返回 data + httpcode 的雙重需求，那么 IActionResult 就是你要找的東西，下面的代碼片段展示了如何去實現(xiàn)。

[HttpGet]
public IActionResult Get()
{
  if (authors == null)
      return NotFound("No records");
 
  return Ok(authors);
}

上面的代碼有 Ok，NotFound 兩個方法，對應(yīng)著 OKResult，NotFoundResult， Http Code 對應(yīng)著 200，404。當(dāng)然還有其他的如：CreatedResult, NoContentResult, BadRequestResult, UnauthorizedResult, 和 UnsupportedMediaTypeResult，都是 IActionResult 的子類。

在 Action 中返回ActionResult實例

ActionResult 是在 ASP.NET Core 2.1 中被引入的，它的作用就是包裝了前面這種模式，怎么理解呢？就是即可以返回 IActionResult ，也可以返回指定類型，從 ActionResult 類下的兩個構(gòu)造函數(shù)中就可以看的出來。

public sealed class ActionResult : IConvertToActionResult
{
	public ActionResult Result  {get;}
 
	public TValue Value  {get;}
 
	public ActionResult(TValue value)
	{
		if (typeof(IActionResult).IsAssignableFrom(typeof(TValue)))
		{
			throw new ArgumentException(Resources.FormatInvalidTypeTForActionResultOfT(typeof(TValue), "ActionResult"));
		}
		Value = value;
	}
 
	public ActionResult(ActionResult result)
	{
		if (typeof(IActionResult).IsAssignableFrom(typeof(TValue)))
		{
			throw new ArgumentException(Resources.FormatInvalidTypeTForActionResultOfT(typeof(TValue), "ActionResult"));
		}
		Result = (result ?? throw new ArgumentNullException("result"));
	}
}

有了這個基礎(chǔ)，接下來看看如何在 Action 方法中去接這兩種類型。

[HttpGet]
public ActionResult&gt; Get()
{
  if (authors == null)
       return NotFound("No records");
   return authors;
}

和文章之前的 Get 方法相比，這里直接返回 authors 而不需要再用 OK(authors) 包裝，是不是一個非常好的簡化呢？接下來再把 Get 方法異步化，首先考慮下面返回 authors 集合的異步方法。

private async Task&gt; GetAuthors()
{
    await Task.Delay(100).ConfigureAwait(false);
    return authors;
}

值得注意的是，異步方法必須要有至少一個 await 語句，如果不這樣做的話，編譯器會提示一個警告錯誤，告知你這個方法將會被 同步執(zhí)行，為了避免出現(xiàn)這種尷尬，我在 Task.Delay 上做了一個 await。

下面就是更新后的 Get 方法，注意一下這里我用了 await 去調(diào)用剛才創(chuàng)建的異步方法，代碼參考如下。

[HttpGet]
public async Task&gt;&gt; Get()
{
   var data = await GetAuthors();
   if (data == null)
        return NotFound("No record");
   return data;
}

如果你有一些定制化需求，可以實現(xiàn)一個自定義的 ActionResult 類，做法就是實現(xiàn) IActionResult 中的 ExecuteResultAsync 方法即可。

到此這篇關(guān)于C# WebAPI的幾種返回類型方式的文章就介紹到這了,更多相關(guān)C# WebAPI返回類型內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: