ASP.NET Core中的Action的返回值類型

来源:https://www.cnblogs.com/kklldog/archive/2020/04/20/aspnetcore-actionresult.html
-Advertisement-
Play Games

在Asp.net Core之前所有的Action返回值都是ActionResult,Json(),File()等方法返回的都是ActionResult的子類。並且Core把MVC跟WebApi合併之後Action的返回值體系也有了很大的變化。 ActionResult類 ActionResult類是 ...


在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這裡不會報錯。

總結

  1. 大部分時候Action的返回值可以使用ActionResult/IActionResult
  2. 設計restful api的時候可以直接使用POCO類作為返回值
  3. 如果要設計既支持POCO類返回值或者ActionResult類為返回值的action可以使用ActionResult< T >作為返回值
  4. ActionResult< T >之所以能夠支持兩種類型的返回值類型,是因為使用了implicit operator內置了2個隱式轉換的方法

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 案例故事:有一天測試經理髮給我一個Bug列表, 這些Bug都是被開發打回來的無效(WithDrawn)Bug, 就是開發不認為是bug, 測試經理覺得很有必要去分析下, 為什麼這麼多無效bug,到底是什麼原因? 測試經理想知道,是測試提Bug太隨意,還是無此需求,還是開發bug流轉流程不對,還是其他 ...
  • 前言: Python可謂是現在很多人正在學或者想學的一個腳本語言了,提到學習自然就少不了拿項目練手,可是一般的項目根本提不起興趣嘛,這10個項目可是非常有趣的,不信你看看。 【Python 圖片轉字元畫】 用 50 行 Python 代碼完成圖片轉字元畫小工具。通過實驗將學習到 Linux 命令行操 ...
  • 給定四種水果,分別是蘋果(apple)、梨(pear)、桔子(orange)、葡萄(grape),單價分別對應為3.00元/公斤、2.50元/公斤、4.10元/公斤、10.20元/公斤。首先在屏幕上顯示以下菜單:[1] apple[2] pear[3] orange[4] grape[0] exit... ...
  • 一、全局修改 打開即可修改 二、針對當前項目修改 ...
  • 一、I/O操作概述 I/O概述: I/O在電腦中時指Input/Output,也就是Stream的輸入與輸出。我們通常說的輸入與輸出其實在操作系統中都是相對於記憶體而言的,InputStream(輸入流)是指數據從外部(網路、鍵盤、I/O設備)流進記憶體,OutputStream正好與之相反,數據從內 ...
  • 本題要求編寫程式,輸出菲波那契(Fibonacci)數列的前N項,每行輸出5個,題目保證輸出結果在長整型範圍內。Fibonacci數列就是滿足任一項數字是前兩項的和(最開始兩項均定義為1)的數列,例如:1,1,2,3,5,8,13,...。輸入格式:輸入在一行中給出一個整數N(1≤N≤46)。輸出格... ...
  • 一、Sublist導致OOM 代碼 @Slf4j public class SubListDemo { public static void subListOOM() { List<List<Integer>> data = new ArrayList<>(); for (int i = 0; i ...
  • 博主是一個在校大學生。在家學習javaweb項目的時候需要用到很多jar包,在網上搜jar包被各種坑,當然也有一些博主會分享到雲盤以供我們下載。 偶然間知道了一個專門為jar包下載的網站,而且是免費下載,就想著分享出來,不讓初學javaweb的小白為jar包下載而發愁。 當然啦,這也是博主的第一篇博 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...