[水煮 ASP.NET Web API2 方法論](3-7)預設 Action 請求方式以及 NonActionAttribute

来源:http://www.cnblogs.com/shuizhucode/archive/2016/12/09/6148685.html
-Advertisement-
Play Games

對於到多數開發者,都會忽略或者不知道 Action 沒有任何 HTTP 的聲明屬性,Web Api 怎樣處理? 對於初學者,還是需要瞭解 NonActionAttribute ...


問題

在 Controller 中有一個 public 的方法,但是又不想將這個 publlic 方法暴露成為一個 API。

 

解決方案

ASP.NET Web API 中,正常是通過 HTTP 謂詞來匹配 Controller 中相關 Action 的。預設情況下,Contoller 中的每個 public 方法都是一個 Action。為了防止 public 的方法成為 Action,只要在 public 的方法上使用 [NonAction] 屬性就可以。

 

工作原理

NoActionAttribute(如代碼片段 3-19 所示)是一個非操作類,其中沒有做任何事情,只是一個標記。

代碼片段 3-19. NonAction 定義

[AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
public sealed class NonActionAttribute : Attribute
{
}

 

ApiControllerActionSeletor,在 Controller 找到合適的 Action 時,內部的驗證執行如代碼片段 3-10 所示,他將 Controller 中所有的 public 方法都作為潛在的 Action,然後再進行逐步篩選,聲明再 ApiController 的會被排除掉,聲明再 IHttpController 也會被排除掉,最後,如果使用了 NonActionAttribute 的也會被排除掉。

 

代碼片段 3-20 ApiControllerActionSelector 針對 Action 的過濾規則

 

註意 這段驗證邏輯是在 ApiControllerAtionSelector 內部的,如果自己代碼中繼承並實現了 IHttpActionSelector,要保證自己的實現中有類似邏輯的代碼,才能保證 NonActionAttribute 工作正常。

 

在 ReflectHttpActionDescriptor 類中 ASP.NET WEB API 會包裝每一個 Action,此外,他還負責找出 Action 應該處理 Http 的請求類型。他是通過方法名字或者在方法上使用了相關屬性(HttpGetAttribute,HttpPostAttribute,等等)。如果 Action 的名字是以 HTTP 動詞(GET,POST,PUT,DELETE)開頭的,ASP.NET WEB API 也會認為這 Action 適合處理相關 HTTP 類型的請求。

 

另外,Action 方法如果任何相關首碼或者聲明屬性都沒有,ASP.NET WEB API 會預設他只能處理 POST 請求。這個是一個很紅要,也很容易被忽略的地方。很多初學者會認為,什麼首碼或者屬性聲明也沒有,那麼,客戶端就不可能請求到這個 Action。

 

代碼演示

代碼片段 3-21 展示了三個 Action 方法。

  1. 處理 ASP.NET WEB API Get 請求。
  2. 處理 ASP.NET WEB API Post 請求(因為不使用任何 Http 謂詞的話,預設是 Post 請求)。
  3. 使用了 NonActionAttribute 來告訴 ASP.NET WEB API,這個 Controller 中的 public 方法不是 Action。

 

代碼片段 3-21. NonActionAttribute 例子

 

 


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

-Advertisement-
Play Games
更多相關文章
  • 系統中經常會使用導出Excel的功能。 之前使用的是NPOI,但是導出數據行數多就報記憶體溢出。 最近看到EPPlus可以用來導出Excel,就自己測了下兩者導出上的差異。 NPIO官網地址:http://npoi.codeplex.com/ EPPlus官網地址:http://epplus.code ...
  • 文章作者 Julie Lerman 是 Microsoft MVP、.NET 導師和顧問,住在佛蒙特州的山區。您可以在全球的用戶組和會議中看到她對數據訪問和其他 .NET 主題的演示。她的博客地址是 [thedatafarm.com/blog][1]。她是“ Entity Framework 編程 ...
  • 【博主】反骨仔 【出處】http://www.cnblogs.com/liqingwen/p/6155694.html ...
  • IIS7.0 IIS7.0主要引入了WAS(Windows Process Activation,不同於6.0中的Web Admin Service),分擔了原來w3svc的部分功能,同時為IIS7.0提供了非HTTP協協議的支持,通過適配器介面(Listener Adapter Interface ...
  • Ext.NET 4.1 系統框架的搭建(後臺) 附源碼 代碼運行環境:.net 4.5 VS2013 (代碼可直接編譯運行) 預覽圖: 分析圖: 上面系統的構建包括三塊區域:North、West和Center: North負責顯示系統信息,包括系統圖片、當前時間、登錄信息、退出登錄等功能。 West ...
  • 這幾天上網翻閱了不少前輩們的關於iis和asp.net運行原理的博客,學的有點零零散散,花了好長時間做了一個小結(雖然文字不多,但也花了不少時間呢),鄙人不才,難免有理解不道的地方,還望前輩們不吝賜教。 這篇博客主要是描述asp.net程式在iis6.0上的一個執行過程。 執行過程圖: 組件描述 H ...
  • 前言 在ASP.NET Core中引入了DI,並且通過構造函數註入參數,控制器中會大量使用DI註入各種的配置參數,如果配置註入的參數比較多,而且各個控制器需要的配置參數都基本一樣的話,那麼不斷重覆的複製黏貼代碼提供相應的構造函數,效率低效也,因此使用T4模板生成控制器的構造函數 ,這也得益於C#對分 ...
  • 什麼是發佈訂閱 發佈訂閱是一種設計模式定義了一對多的依賴關係,讓多個訂閱者對象同時監聽某一個主題對象。這個主題對象在自身狀態變化時,會通知所有的訂閱者對象,使他們能夠自動更新自己的狀態。 為了描述這種模式,我們將會構建一個簡單的日誌系統。它包括兩個程式——第一個程式負責發送日誌消息,第二個程式負責獲... ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...