ASP.NET Core MVC 中的 [Controller] 和 [NonController]

来源:http://www.cnblogs.com/savorboard/archive/2016/09/20/dotnet-controller-2.html
-Advertisement-
Play Games

前言 我們知道,在 MVC 應用程式中,有一部分約定的內容。其中關於 Controller 的約定是這樣的。 每個 Controller 類的名字以 Controller 結尾,並且放置在 Controllers 目錄中。 Controller 使用的視圖是在 Views 主目錄的一個子目錄中,這個 ...


前言

我們知道,在 MVC 應用程式中,有一部分約定的內容。其中關於 Controller 的約定是這樣的。

  • 每個 Controller 類的名字以 Controller 結尾,並且放置在 Controllers 目錄中。
  • Controller 使用的視圖是在 Views 主目錄的一個子目錄中,這個子目錄是根據控制器名稱(後面減去Controller尾碼)來命名的。

明白了以上約定之後,就來一起看看下麵吧。

Controller VS NonController 中內置的約定

在 ASP.NET Core MVC 中已經統一了 MVC 和 Web Api 及 Web Pages, 他們具有相同的 Controller ,並且在 RC2 之後的版本中,ASP.NET Core MVC 支持了 POCO Controller,所以你在做一個 Web Api 的 Controller 的時候不需要再繼承自 Controller 基類。

POCO Controller 即 public 的,非抽象的,沒有任何繼承,不實現任何介面的 Controller 類,類似於 POCO Class,僅僅是以 Controller 結尾而已。

到這裡,有些同學可能會問了,在 POCO Controller 中如果我想獲取 HTTP 上下文的一些東西應該怎麼獲取呢? 嗯?。。。 這確實是個問題。。。。怎麼辦呢? 老實的繼承基類 Controller 吧,因為 Vnext 中的 POCO Controller 屬性註入已經被取消了。

如果你創建了一個 POCO Controller ,那麼他們的名字必須以 Controller 結尾,只有這樣他們才是一個有效的 Controller,不然的話,MVC 不會認為你這是一個 Controller 對象。即使你具有 Route 之類的標記也不可以。

所以,在創建一個 MVC Controller 的時候,就有兩個先決條件:

  • -- 繼承自 Controller 基類
  • -- 或者使用一個以 Controller 結尾的名字

下麵是創建兩種 Controller 的一個 Web Api Controller示例:

[Route("api/[controller]")]
public class FooController : Controller
{
    [HttpGet]
    public string Get()
    {
        return "foo";
    }
}
 
[Route("api/[controller]")]
public class BarController
{
    [HttpGet]
    public string Get()
    {
        return "bar";
    }
}

現在有同學可能會問了,第一個既然已經繼承了 Controller 基類,再在定義 Controller 的時候還要加 Controller 尾碼不是多此一舉麽?這樣寫可不可以呢?

[Route("api/[controller]")]
public class Foo : Controller
{
    [HttpGet]
    public string Get()
    {
        return "foo";
    }
}

好吧,這樣子也是正確的。為什麼呢?這是因為繼承的基類 Controller 已經被打上了 ControllerAttribute 的標記,打上了這個標記之後,在構建掃描的時候就會被認為是一個 Controller,也就是說整個繼承樹已經被認為是一個有效的 MVC Controller 了。

那麼,有同學又問了,這樣可不可以呢?

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

這樣子是不行的,因為這是一個 POCO Controller,沒有任何標記使 MVC 框架會認為這是一個有效的Controller,這個時候,如果 如果想讓框架認為這是一個有效的 Controller,可以通過添加 ControllerAttribute 的方式:

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

這個時候,MVC 框架就會認為這是個有效的 Controller 了。

同樣的,這樣的代碼也是有效的,因為基類已經有了 ControllerAttribute 標記 :

[Controller]
public class ApiBase {}
 
[Route("api/[controller]")]
public class Bar : ApiBase
{
    [HttpGet]
    public string Get()
    {
        return "bar";
    }
}

還有一種可能性,就是當你有一個類,它恰好是以 Controller 結尾,但是實際上並不是一個 Controller 類怎麼辦呢? 這個時候,你就需要添加一個 NonControllerAttribute 標記,來聲明當前的類並不是一個 MVC 的 Controller 類,從而避免在構建的時候,框架會認錯。

[NonController]
public class DemoController
{
    // 非 action 代碼
}

有一點需要註意的是,NonControllerAttribute 標記比 ControllerAttribute 具有更高的優先順序,所以當一個 Controller 同時具有這兩個標記的時候,會以 NonControllerAttribute 為準。

實際上,只要是整個 Controller 繼承樹中有一個 Controller 被標記為 NonControllerAttribute 的時候,整個繼承樹的 Controller 均會被認為是無效的 Controller 了。


本文地址:http://www.cnblogs.com/savorboard/p/dontnet-controller.html
作者博客:Savorboard
歡迎轉載,請在明顯位置給出出處及鏈接


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

-Advertisement-
Play Games
更多相關文章
  • 1、簡單控制項 ①label 作用是顯示文字,編譯後的結果是span 邊框--邊框顏色,邊框樣式,邊框粗細 ②literal 作用是顯示文字,編譯後的結果不會生成任何元素,主要是用於傳遞JavaScript代碼 ③TextBox 文字輸入框 TextMode--SingleLine 被編譯為 type ...
  • 1.資料庫名為Demo,數據結構如圖 2.後臺代碼如下 ...
  • 1. 類和結構能夠實現介面 2. 介面聲明包含如下四種類型:屬性、方法、事件和索引;這些函數聲明不能包含任何實現代碼,而在每一個成員的主體後必須使用分號 3. 繼承介面的類或結構必須實現介面中的所有成員 4. 顯示介面的實現註意下麵的代碼 ...
  • 走進非同步編程的世界 - 在 WinForm 中執行非同步操作 序 這是繼《開始接觸 async/await 非同步編程》、《走進非同步編程的世界 - 剖析非同步方法》後的第三篇。主要介紹在 WinForm 中如何執行非同步操作。 目錄 在 WinForm 程式中執行非同步操作 在 WinForm 中使用非同步 L ...
  • 背水一戰 Windows 10 之 控制項(進度類): RangeBase, Slider, ProgressBar, ProgressRing ...
  • 配置針對應用程式的運行狀況監視的一個服務 配置節內容比以往的較為複雜,如下 實際上這是運行狀況監視是一個事件定義與處理的模型,簡單來看整個運行狀況監視基本點有以下三個 1.在eventMappings定義事件 2.在providers定義事件的處理 3.通過rules綁定事件給某個處理程式去處理。 ...
  • Awesome系列的.Net資源整理。awesome-dotnet是由quozd發起和維護。內容包括:編譯器、壓縮、應用框架、應用模板、加密、資料庫、反編譯、IDE、日誌、風格指南等。 API 框架 NancyFx:輕量、用於構建 HTTP 基礎服務的非正式(low-ceremony)框架,基於.N ...
  • 代碼: 方法一:窗體的代碼-->可以直接通過預設的Click事件來實現控制進度條。 方法二:通過調用其他類里的方法來實現對進度條的控制。 註意一:需要using System.Windows.Forms; 註意二:進度條ToolStripProgressBar的許可權需要改成Public 效果圖:(左 ...
一周排行
    -Advertisement-
    Play Games
  • 示例項目結構 在 Visual Studio 中創建一個 WinForms 應用程式後,項目結構如下所示: MyWinFormsApp/ │ ├───Properties/ │ └───Settings.settings │ ├───bin/ │ ├───Debug/ │ └───Release/ ...
  • [STAThread] 特性用於需要與 COM 組件交互的應用程式,尤其是依賴單線程模型(如 Windows Forms 應用程式)的組件。在 STA 模式下,線程擁有自己的消息迴圈,這對於處理用戶界面和某些 COM 組件是必要的。 [STAThread] static void Main(stri ...
  • 在WinForm中使用全局異常捕獲處理 在WinForm應用程式中,全局異常捕獲是確保程式穩定性的關鍵。通過在Program類的Main方法中設置全局異常處理,可以有效地捕獲並處理未預見的異常,從而避免程式崩潰。 註冊全局異常事件 [STAThread] static void Main() { / ...
  • 前言 給大家推薦一款開源的 Winform 控制項庫,可以幫助我們開發更加美觀、漂亮的 WinForm 界面。 項目介紹 SunnyUI.NET 是一個基於 .NET Framework 4.0+、.NET 6、.NET 7 和 .NET 8 的 WinForm 開源控制項庫,同時也提供了工具類庫、擴展 ...
  • 說明 該文章是屬於OverallAuth2.0系列文章,每周更新一篇該系列文章(從0到1完成系統開發)。 該系統文章,我會儘量說的非常詳細,做到不管新手、老手都能看懂。 說明:OverallAuth2.0 是一個簡單、易懂、功能強大的許可權+可視化流程管理系統。 有興趣的朋友,請關註我吧(*^▽^*) ...
  • 一、下載安裝 1.下載git 必須先下載並安裝git,再TortoiseGit下載安裝 git安裝參考教程:https://blog.csdn.net/mukes/article/details/115693833 2.TortoiseGit下載與安裝 TortoiseGit,Git客戶端,32/6 ...
  • 前言 在項目開發過程中,理解數據結構和演算法如同掌握蓋房子的秘訣。演算法不僅能幫助我們編寫高效、優質的代碼,還能解決項目中遇到的各種難題。 給大家推薦一個支持C#的開源免費、新手友好的數據結構與演算法入門教程:Hello演算法。 項目介紹 《Hello Algo》是一本開源免費、新手友好的數據結構與演算法入門 ...
  • 1.生成單個Proto.bat內容 @rem Copyright 2016, Google Inc. @rem All rights reserved. @rem @rem Redistribution and use in source and binary forms, with or with ...
  • 一:背景 1. 講故事 前段時間有位朋友找到我,說他的窗體程式在客戶這邊出現了卡死,讓我幫忙看下怎麼回事?dump也生成了,既然有dump了那就上 windbg 分析吧。 二:WinDbg 分析 1. 為什麼會卡死 窗體程式的卡死,入口門檻很低,後續往下分析就不一定了,不管怎麼說先用 !clrsta ...
  • 前言 人工智慧時代,人臉識別技術已成為安全驗證、身份識別和用戶交互的關鍵工具。 給大家推薦一款.NET 開源提供了強大的人臉識別 API,工具不僅易於集成,還具備高效處理能力。 本文將介紹一款如何利用這些API,為我們的項目添加智能識別的亮點。 項目介紹 GitHub 上擁有 1.2k 星標的 C# ...