在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作

来源:https://www.cnblogs.com/JackyGz/p/18438519
-Advertisement-
Play Games

本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...


image

前言:什麼是操作篩選器

操作篩選器是 ASP.NET Core Web API 中的一種過濾器,用於在執行控制器操作(Action)之前或之後執行一些代碼,完成特定的功能,比如執行日誌記錄、身份驗證、授權、異常處理等通用的處理邏輯。

每次 ASP.NET Core Web API 中控制器的操作方法被執行的時候,操作篩選器都會被執行,所以操作篩選器預設是應用於所有控制器的操作方法的。

一個項目中可以註冊多個操作篩選器,這些操作篩選器組成一個鏈,上一個篩選器執行完了再執行下一個。next 就是一個用來指向下一個操作篩選器的委托,如果當前的操作篩選器是最後一個篩選器的話,next 就會執行要執行的操作方法。

操作篩選器跟前文(見《如何在 ASP.NET Core Web API 方法執行前後 “偷偷“ 作一些 “壞“ 事?初識 ActionFilterAttribute》)講過的 ActionFilterAttribute 比較相似,ActionFilterAttribute 是用於將操作篩選器邏輯應用於控制器操作的一種方式,而操作篩選器是一種更廣泛的概念,可以說,ActionFilterAttribute 是操作篩選器的一種特定實現方式,它通過特性的方式將操作篩選器邏輯應用於控制器操作。

Step By Step 步驟

  1. 創建一個 ASP.NET Core Web API 項目

  2. 編寫兩個自定義的操作篩選器 MyActionFilter1 和 MyActionFilter2,實現 IAsyncActionFilter 介面(註意看代碼中的註釋

    using Microsoft.AspNetCore.Mvc.Filters;
    
    public class MyActionFilter1 : IAsyncActionFilter
    {
    	// context 參數代表 Action 執行的上下文對象,從 context 中我們可以獲取請求的路徑、參數值等信息
    	// next 參數代表下一個要執行的操作篩選器
    	public async Task OnActionExecutionAsync(
    		ActionExecutingContext context, 
    		ActionExecutionDelegate next)
    	{
    		// next 之前的代碼是在操作方法執行之前要執行的代碼
    		Console.WriteLine("MyActionFilter 1:開始執行");
    
    		// 用 next 來執行下一個操作篩選器,
    		// 如果這是最後一個操作篩選器,它就會執行實際的操作方法
    		// next 的返回值是操作方法的執行結果,返回值是 ActionExecutedContext 類型的。
    		// 如果操作方法執行的時候出現了未處理異常,
    		// 那麼 ActionExecutedContext 的 Exception 屬性就是異常對象,
    		// ActionExecutedContext 的 Result 屬性就是操作方法的執行結果。
    		ActionExecutedContext r = await next();
    		
    		// 以下代碼則是在操作方法執行之後要執行的代碼
    		if (r.Exception != null)
    		{
    			Console.WriteLine("MyActionFilter 1:執行失敗");
    		}
    		else
    		{
    			Console.WriteLine("MyActionFilter 1:執行成功");
    		}
    	}
    }
    
    public class MyActionFilter2 : IAsyncActionFilter
    {
    	public async Task OnActionExecutionAsync(
    		ActionExecutingContext context, 
    		ActionExecutionDelegate next)
    	{
    		Console.WriteLine("MyActionFilter 2:開始執行");
    		ActionExecutedContext r = await next();
    		if (r.Exception != null)
    		{
    			Console.WriteLine("MyActionFilter 2:執行失敗");
    		}
    		else
    		{
    			Console.WriteLine("MyActionFilter 2:執行成功");
    		}
    	}
    }
    
  3. 打開 Program.cs,註冊這兩個操作篩選器

    using Microsoft.AspNetCore.Mvc;
    
    var builder = WebApplication.CreateBuilder(args);
    
    // Add services to the container.
    
    builder.Services.AddControllers();
    // Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
    builder.Services.AddEndpointsApiExplorer();
    builder.Services.AddSwaggerGen();
    
    // 註冊操作篩選器服務
    builder.Services.Configure<MvcOptions>(options => {
    	options.Filters.Add<MyActionFilter1>();
    	options.Filters.Add<MyActionFilter2>();
    });
    
    var app = builder.Build();
    
    // Configure the HTTP request pipeline.
    if (app.Environment.IsDevelopment())
    {
    	app.UseSwagger();
    	app.UseSwaggerUI();
    }
    
    app.UseHttpsRedirection();
    
    app.UseAuthorization();
    
    app.MapControllers();
    
    app.Run();
    
  4. 打開控制器,增加一個用於測試的操作方法

    using Microsoft.AspNetCore.Mvc;
    
    namespace 操作篩選器.Controllers
    {
    	[ApiController]
    	[Route("[controller]/[action]")]
    	public class TestController : ControllerBase
    	{
    		[HttpGet]
    		public string GetData()
    		{
    			Console.WriteLine("執行GetData");
    			return "yzk";
    		}
    	}
    }
    

測試運行和結果

執行順序:
MyActionFilter 1:開始執行
MyActionFilter 2:開始執行
執行GetData
MyActionFilter 2:執行成功
MyActionFilter 1:執行成功

我是老楊,一個執著於編程樂趣、至今奮鬥在一線的 10年+ 資深研發老鳥,是軟體項目管理師,也是快樂的程式猿,持續免費分享全棧實用編程技巧、項目管理經驗和職場成長心得!歡迎關註老楊的公眾號(名稱:代碼掌控者),和你共同探索代碼世界的奧秘!

image


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

-Advertisement-
Play Games
更多相關文章
  • 部署SpringBoot項目(通關版) 一、概述 使用 java -jar 命令直接部署項目的JAR包和使用Docker製作鏡像進行部署是兩種常見的部署方式。以下是對這兩種方式的概述和簡要的優劣勢分析: 1.1、使用 java -jar 命令直接部署項目的JAR包 概述: 通過 java -jar ...
  • 在 Python 中,字元串格式化是將變數插入到字元串中的一種方式,Python 提供了多種字元串格式化的方法,包括舊式的 % 格式化、新式的 str.format 方法以及 f-string(格式化字元串字面量)。 ...
  • 一:背景 1. 講故事 前些天在看 AOT的時候關註了下 源生成器,挺有意思的一個東西,今天寫一篇文章簡單的分享下。 二:源生成器探究之旅 1. 源生成器是什麼 簡單來說,源生成器是Roslyn編譯器給程式員開的一道口子,在這個口子里可以塞入一些自定義的cs代碼,讓Roslyn編譯器在編譯代碼的時候 ...
  • 一、依賴註入相關知識 1.1、依賴註入的原理和優點 依賴註入(DI),是IOC控制反轉思想 的實現。由一個DI容器,去統一管理所有的服務生命周期,服務的創建、銷毀、獲取,都是由DI容器去處理的。 依賴註入,很大程度解耦了服務之間的依賴關係,服務之間依賴的是抽象(依賴的是 服務/服務介面 的 “類型” ...
  • 在Linux centos環境下安裝部署sql server資料庫,並結合cpolar內網穿透工具,創建安全隧道將其映射到公網上,獲取公網地址,實現在外異地遠程連接家裡/公司的sqlserver資料庫,而無需公網IP,無需設置路由器,亦無需雲伺服器。 1.安裝sql server 下載 SQL Se ...
  • Redis Stream簡介 Redis Stream是隨著5.0版本發佈的一種新的Redis數據類型: 高效消費者組:允許多個消費者組從同一數據流的不同部分消費數據,每個消費者組都能獨立地處理消息,這樣可以並行處理和提高效率。 阻塞操作:消費者可以設置阻塞操作,這樣它們會在流中有新數據添加時被喚醒 ...
  • 前言 隨著工業4.0時代的到來,物聯網技術正在以前所未有的速度改變著我們的生產和生活方式。本文給大家介紹一個基於 .NET 6 開發的跨平臺工業物聯網網關解決方案。 工業物聯網(IIoT)成為了連接物理世界與數字世界的紐帶。而在這個網路中,工業物聯網網關就像是一個智能的交通警察,負責指揮著設備與雲端 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...