ASP.NET Core中的Controller

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

ASP.NET CORE出現之前我們實現的Controller,MVC都繼承自Controller基類,WebApi的話繼承自ApiController。現在ASP.NET CORE把MVC跟WebApi合併了,已經不再區分MVC或者WebApi。ASP.NET CORE的Controller繼承結... ...


ASP.NET CORE出現之前我們實現的Controller,MVC都繼承自Controller基類,WebApi的話繼承自ApiController。現在ASP.NET CORE把MVC跟WebApi合併了,已經不再區分MVC或者WebApi。ASP.NET CORE的Controller繼承結構也發生了變化。我們看其他示例的時候會發現有些繼承自Controller有些繼承自ControllerBase。事實上ControllerBase是Controller的基類。也就是說如果你繼承自Controller,其實就是繼承了ControllerBase。那什麼時候該選擇直接繼承ControllerBase呢?

ControllerBase

我們先看看ControllerBase的元數據:

很長並沒有截全。可以看到ControllerBase是個抽象類,並且實現了大量的虛方法。這些虛方法大都是對應了Http的狀態碼。
比如:

public virtual OkResult Ok(); //http status 200
public virtual NotFoundResult NotFound(); //http status 404
public virtual ForbidResult Forbid(); //http status 403
public virtual CreatedResult Created(Uri uri, [ActionResultObjectValue] object value); // http status 201
...還有很多很多...

顯然這是為Restful Api設計的基類,所以當你要設計一個Restful(web api)介面的時候可以選擇繼承自ControllerBase,它已經可以滿足你的需求。

Controller

查看下Controller的元數據:

Controller也是一個抽象類,繼承自ControllerBase,並且繼承了幾個介面。很明顯Controller比ControllerBase多的內容主要是一些跟MVC打交道的東西。
比如:Viewbag、Viewdata屬性,Json、View方法等:

public dynamic ViewBag { get; }
public ViewDataDictionary ViewData { get; set; }
public virtual JsonResult Json(object data);
public virtual ViewResult View();
...

所以如果你是需要實現一個MVC系統,想要使用cshtml模板跟razor試圖引擎渲染頁面則需要繼承Controller。

POCO Controller

除了繼承Controller、ControllerBase之外,ASP.NET CORE框架可以讓你的POCO類直接變成Controller。

使用“Controller”尾碼

下麵的代碼,TestController可以正常工作嗎?

    [Route("api/[controller]")]
    public class TestController 
    {
        [HttpGet]
        public string Get()
        {
            return "TestController";
        }
    }

運行一下:

雖然TestController類並沒有繼承自任何類,但是他確實可以在ASP.NET CORE框架內正常工作。ASP.NET CORE框架預設會查找尾碼為“Controller”的類,並把它當做真正的Controller使用,在路由系統最終匹配Controller的時候它也會被嘗試匹配。

使用ControllerAttribute

如果你的控制器類有什麼特別需求,連類名都不想加入“Controller”的尾碼,那麼還有一種方法就是使用ControllerAttribute。

    [Controller]
    [Route("api/[controller]")]
    public class POCO 
    {
        [HttpGet]
        public string Get()
        {
            return "POCOController";
        }
    }

運行一下:

POCO類並沒有繼承自任何類,並且也沒有“Controller”尾碼命名,但是因為它被標記了ControllerAttribute同樣會被ASP.NET CORE框架認為是一個Controller。在路由系統最終匹配Controller的時候它也會被嘗試匹配。

使用NonControllerAttribute

如果你的一個類名恰巧包含“Controller”的尾碼,但你並不想ASP.NET CORE框架發現它,你可以在類上加上NonControllerAttribute。這樣ASP.NET CORE框架就會忽略它。
改一下剛纔的TestController,加上[NonController]:

    [NonController]
    [Route("api/[controller]")]
    public class TestController 
    {
        [HttpGet]
        public string Get()
        {
            return "TestController";
        }
    }

運行一下:

/api/test已經匹配不到controller了。

總結

  1. 設計restful(web api)介面的時候可以繼承ControllerBase
  2. 設計MVC系統的時候可以繼承Controller
  3. 當一個POCO類名稱包含"Controller"尾碼或添加ControllerAttribute的時候框架會認為這是一個控制器
  4. 當一個類不想被框架當做控制器的時候可以添加NonControllerAttribute

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

-Advertisement-
Play Games
更多相關文章
  • # -*- coding: utf-8 -*-#/usr/local/bin/python3# @Time : 2020/3/7 4:05 PM# @Author : eric# @File : get_audio_loudness.py# @Software: PyCharmimport osim ...
  • 架構概述 B/S架構(Browser/Server,瀏覽器/伺服器模式):是一種通過將瀏覽器作為客戶端的網路結構模式,利用已經逐步成熟的web瀏覽器技術,結合瀏覽器的多種功能,使用瀏覽器來作為早先C/S(Client/Serve)架構下複雜的客戶端,使用C/S架構使得用戶的客戶端得到統一,將軟體系統 ...
  • CILI123磁力導航是資源多,更新快的磁力鏈接搜索導航,集成了10多個有效可用的磁力網站。這些網站包含有幾千萬的影視音樂、軟體、電子書等BT種子資源。更新快的磁力鏈接搜索引擎,實時通過DHT網路獲取最新的BT種子文件信息,並生成磁力鏈接。 ...
  • 雙親委派載入模型 為什麼需要雙親委派載入模型 主要是為了安全,避免用戶惡意載入破壞 正常運行的位元組碼文件,比如說載入一個自己寫的 。這樣就有可能造成包衝突問題。 類載入器種類 啟動類載入器:用於載入 中`rt.jar`的位元組碼文件 擴展類載入器:用於載入 中`/jre/lib/ext`文件夾下的位元組 ...
  • 【目錄】 一、綁定方法與非綁定方法 二、非綁定方法 一、綁定方法與非綁定方法 ​ 類中定義的函數分為兩大類:綁定方法和非綁定方法 ​ 其中綁定方法又分為綁定到對象的對象方法和綁定到類的類方法。 ​ 在類中正常定義的函數預設是綁定到對象的,而為某個函數加上裝飾器@classmethod後,該函數就綁定 ...
  • 前言 隨著 Web 2.0 時代的到來,互聯網的網路架構已經從傳統的 架構轉變為更加方便、快捷的 架構,B/S 架構大大簡化了用戶使用網路應用的難度,提高了用戶體驗。 架構帶來了以下兩方面的好處: 客戶端使用統一的瀏覽器( )。由於瀏覽器具有統一性,不需要特殊的配置和網路連接。另外瀏覽器的交互特性使 ...
  • 服務提供者 創建一個名為 的服務提供者項目 POM 該項目下有兩個子模塊,分別是 和 ,前者用於定義介面,後者用於實現介面。 服務提供者介面模塊 在服務提供者項目下創建一個名為 的模塊, 該項目模塊只負責 定義介面 POM 定義一個介面 服務提供者介面實現模塊 創建名為 服務提供者介面的實現模塊,用 ...
  • 什麼是 Nacos Config 在分散式系統中,由於服務數量巨多,為了方便服務 配置文件統一管理 , 實時更新 ,所以需要分散式配置中心組件。 是 的替代方案。 的存儲配置功能為分散式系統中的外部化配置提供伺服器端和客戶端支持,可以在 中集中管理 Spring Cloud 應用的外部屬性配置。 引 ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...