主頁 > .NET開發 > .NET Core 自定義中間件 Middleware

.NET Core 自定義中間件 Middleware

2022-01-19 16:33:03 .NET開發

引言

很多看了上一章的朋友私信博主,問如何自定義,自己的中間件(Middleware),畢竟在實際的專案中,大家會有很多需求要用到中間件,比如防盜鏈、快取、日志等等功能,于是博主這邊就簡單講解一下框架、組件慣用的優雅手法,官方也推薦這種寫法,這樣會使得我們擴展性更好,也不會破壞原本結構,

什么是中間件

中間件是一種裝配到應用管道以處理請求回應的軟體, 每個組件:

  • 選擇是否將請求傳遞到管道中的下一個組件,
  • 可在管道中的下一個組件前后執行作業,

使用 RunMap 和 Use 擴展方法來配置請求委托,請求委托用于生成請求管道, 請求委托處理每個 HTTP 請求,

簡單的說,我們按需求決定使用哪些組件,程式運行時,一個HTTP請求過來,程式執行流程,是按照我們定義的組件順序執行的,所以我們專案上的中間件放置順序是不能亂的,并且不用的也不要裝配,避免消耗性能,

概念圖:

如果想做其他相關了解,博主建議直接在官網上看檔案,微軟的檔案寫的還是很好的,還提供的Demo下載,比很多網上博客講的好,

微軟官網地址:ASP.NET Core 中間件 | Microsoft Docs

接下來進入正題,我們寫一個,把所有http請求地址發送到MQ的中間件:

1.撰寫MsgMiddleware類

這里我們就使用直接撰寫Middleware類的方式,大家也可以使用實作IMiddleware介面的方式,兩種底層原理不一樣:前者是框架啟動時就實體化;后者是請求來時才實體化,用完立即釋放,

撰寫Middleware類注意:

  1. 撰寫好InvokeAsync或者Invoke方法
  2. 建構式引數需要一個RequestDelegate型別的委托

因為這塊原始碼是直接通過反射創建和呼叫的,不過原始碼也會對我們的類進行規范校驗,

代碼邏輯:

這里我們就實作一個簡單邏輯,根據Options配置SendFlag是否開啟發送MQ,如果是,就呼叫我們的ISendMessage發送服務,服務獲取方式大家也可以使用注入的方式

ISendMessage服務Options配置代碼,我放到了后面講解,畢竟邏輯簡單,而且也不是重點,

查看代碼
public class MsgMiddleware
    {
        private readonly RequestDelegate _next;
        private readonly MsgOptions options;
        /// <summary>
        /// 管道執行到該中間件時候下一個中間件的RequestDelegate請求委托,如果有其它引數,也同樣通過注入的方式獲得
        /// </summary>
        /// <param name="next"></param>
        public MsgMiddleware(RequestDelegate next, IOptions<MsgOptions> options)
        {
            //通過注入方式獲得物件
            _next = next;
            this.options = options.Value;
        }

        /// <summary>
        /// 自定義中間件要執行的邏輯
        /// </summary>
        /// <param name="context"></param>
        /// <returns></returns>
        public async Task Invoke(HttpContext context)
        {
            if (options.SendFlag)
            {
                //通過IOC獲取ISendMessage
                ISendMessage _message = context.RequestServices.GetService<ISendMessage>();
                _message.Send(context.Request.Path.Value);
            }
            //把context傳進去執行下一個中間件
            await _next(context);
        }
    }

2.撰寫IApplicationBuilder擴展方法

這里我們就定義兩個擴展方法,用來應對在Use時候直接配置Options,或者后面通過IOC方式配置Options

注意:如果在Use時候直接配置引數,我們的Options需要通過Options.Create(op)幫我們包裹成IOptions<>型別,因為撰寫的中間件引數是Options模式的一個IOptions介面

查看代碼
public static class MsgBuilderMiddlewareExtensions
    {
        //沒有Option,依靠IOC的Add的方式設定
        public static IApplicationBuilder UseMsgSend(this IApplicationBuilder app)
        {
            if (app == null)
            {
                throw new ArgumentNullException(nameof(app));
            }
            return app.UseMiddleware<MsgMiddleware>();
        }

        //Use直接配置Options
        public static IApplicationBuilder UseMsgSend(this IApplicationBuilder app, Action<MsgOptions> optionsAction)
        {
            if (app == null)
            {
                throw new ArgumentNullException(nameof(app));
            }
            //1  不能直接初始化Option
            //2  也不能找到ServiceCollection去初始化了
            MsgOptions op = new MsgOptions();
            optionsAction(op);
            return app.UseMiddleware<MsgMiddleware>(Options.Create(op));
        }
    }

3.撰寫IServiceCollection容器擴展方法

這樣的好處是,我們這樣可以集中注冊內部映射,隱藏實作細節,外部不需要關心,這個好處博主就不多說了,因為大家使用別人寫的組件也心有體會,對于使用者來說只需要關心怎么用,他內部有多么復雜的邏輯是不知道的,也不需要知道.

這里也是撰寫兩個擴展方法,用來應對在Use時候直接配置Options,或者后面通過IOC方式配置Options

代碼邏輯:

這兩個方法里面邏輯就是,注冊好業務服務、Options 等等,,,

查看代碼
/// <summary>
    /// 這樣可以集中注冊內部映射,外部不需要關心
    /// </summary>
    public static class ServiceCollectionExtensions
    {
        /// <summary>
        /// 配置資訊初始化由Middleware
        /// </summary>
        /// <param name="services"></param>
        /// <returns></returns>
        public static IServiceCollection AddSendMessage(this IServiceCollection services)
        {
            return services.AddSingleton<ISendMessage, SendMessage>();
        }

        /// <summary>
        /// 配置資訊直接用Option的模式去初始化
        /// </summary>
        /// <param name="services"></param>
        /// <param name="configure"></param>
        /// <returns></returns>
        public static IServiceCollection AddSendMessage(this IServiceCollection services, Action<MsgOptions> configure)
        {
            MsgOptions msg = new MsgOptions();
            configure(msg);
            services.Configure(configure);
            services.Configure(msg.RabbitMQOptions);
            return services.AddSendMessage();
        }
    }

4.定義Options類

定義好我們業務邏輯需要的配置資訊Options類

查看代碼
//MQ配置類
    public class RabbitMQOptions
    {
        public string IP { get; set; }
        public string Port { get; set; }
    }
    //Msg配置類
    public class MsgOptions
    {
        //是否發送
        public bool SendFlag { get; set; }
        //MQ配置
        internal Action<RabbitMQOptions>? RabbitMQOptions { get; private set; }

        public void Register(Action<RabbitMQOptions> action)
        {
            RabbitMQOptions = action;
        }
    }
    //Msg配置擴展方法,用來設定其MQ配置資訊
    public static class MsgOptionsExtensions
    {
        public static void UseRabbitMQ(this MsgOptions options, Action<RabbitMQOptions> configure)
        {
            if (configure == null)
            {
                throw new ArgumentNullException(nameof(configure));
            }
            options.Register(configure);
        }
    }

5.撰寫Msg服務

這里我們就用列印資訊的方式來表示我們將資料發送至MQ了

 public interface ISendMessage
    {
        void Send(string message);
    }
    public class SendMessage : ISendMessage
    {
        private readonly RabbitMQOptions rabbitMQ;
        public SendMessage(IOptions<RabbitMQOptions> rabbitMQ)
        {
            this.rabbitMQ = rabbitMQ.Value;
        }
        public void Send(string message)
        {
            Console.WriteLine($"發送訊息:{message},至--->{rabbitMQ.IP}:{rabbitMQ.Port}服務器");
        }
    }

6.使用自定義中間件

我們只需要呼叫我們定義的擴展方法即可,博主這里用的.NET 6,使用的頂級陳述句,老版本的朋友就在Startup類里配置,呼叫方式是一樣的

如下:

  1. Configure方法里使用,app.UseMsgSend()
  2. ConfigureServices方法里使用,services.AddSendMessage(x=>{...})
查看代碼
using WebApplication1.MiddlewareExp;
using WebApplication1.MiddlewareExp.Middleware;

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.AddSendMessage(c =>
{
    c.SendFlag = true;
    c.UseRabbitMQ(x =>
    {
        x.IP = "127.0.0.1";
        x.Port = "8080";
    });
});



var app = builder.Build();
// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

// 使用自定義的Msg中間件
app.UseMsgSend();

app.UseAuthorization();

app.MapControllers();

app.Run();

運行效果

如圖,我們請求多少次,請求都會經過我們中間件,

轉載請註明出處,本文鏈接:https://www.uj5u.com/net/415159.html

標籤:.NET Core

上一篇:使用.NET 6開發TodoList應用(填坑1)——實作當前登錄用戶獲取

下一篇:asp.net core 支持多種身份認證方式

標籤雲
其他(157675) Python(38076) JavaScript(25376) Java(17977) C(15215) 區塊鏈(8255) C#(7972) AI(7469) 爪哇(7425) MySQL(7132) html(6777) 基礎類(6313) sql(6102) 熊猫(6058) PHP(5869) 数组(5741) R(5409) Linux(5327) 反应(5209) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4554) 数据框(4311) css(4259) 节点.js(4032) C語言(3288) json(3245) 列表(3129) 扑(3119) C++語言(3117) 安卓(2998) 打字稿(2995) VBA(2789) Java相關(2746) 疑難問題(2699) 细绳(2522) 單片機工控(2479) iOS(2429) ASP.NET(2402) MongoDB(2323) 麻木的(2285) 正则表达式(2254) 字典(2211) 循环(2198) 迅速(2185) 擅长(2169) 镖(2155) 功能(1967) .NET技术(1958) Web開發(1951) python-3.x(1918) HtmlCss(1915) 弹簧靴(1913) C++(1909) xml(1889) PostgreSQL(1872) .NETCore(1853) 谷歌表格(1846) Unity3D(1843) for循环(1842)

熱門瀏覽
  • WebAPI簡介

    Web體系結構: 有三個核心:資源(resource),URL(統一資源識別符號)和表示 他們的關系是這樣的:一個資源由一個URL進行標識,HTTP客戶端使用URL定位資源,表示是從資源回傳資料,媒體型別是資源回傳的資料格式。 接下來我們說下HTTP. HTTP協議的系統是一種無狀態的方式,使用請求/ ......

    uj5u.com 2020-09-09 22:07:47 more
  • asp.net core 3.1 入口:Program.cs中的Main函式

    本文分析Program.cs 中Main()函式中代碼的運行順序分析asp.net core程式的啟動,重點不是剖析原始碼,而是理清程式開始時執行的順序。到呼叫了哪些實體,哪些法方。asp.net core 3.1 的程式入口在專案Program.cs檔案里,如下。ususing System; us ......

    uj5u.com 2020-09-09 22:07:49 more
  • asp.net網站作為websocket服務端的應用該如何寫

    最近被websocket的一個問題困擾了很久,有一個需求是在web網站中搭建websocket服務。客戶端通過網頁與服務器建立連接,然后服務器根據ip給客戶端網頁發送資訊。 其實,這個需求并不難,只是剛開始對websocket的內容不太了解。上網搜索了一下,有通過asp.net core 實作的、有 ......

    uj5u.com 2020-09-09 22:08:02 more
  • ASP.NET 開源匯入匯出庫Magicodes.IE Docker中使用

    Magicodes.IE在Docker中使用 更新歷史 2019.02.13 【Nuget】版本更新到2.0.2 【匯入】修復單列匯入的Bug,單元測驗“OneColumnImporter_Test”。問題見(https://github.com/dotnetcore/Magicodes.IE/is ......

    uj5u.com 2020-09-09 22:08:05 more
  • 在webform中使用ajax

    如果你用過Asp.net webform, 說明你也算是.NET 開發的老兵了。WEBform應該是2011 2013左右,當時還用visual studio 2005、 visual studio 2008。后來基本都用的是MVC。 如果是新開發的專案,估計沒人會用webform技術。但是有些舊版 ......

    uj5u.com 2020-09-09 22:08:50 more
  • iis添加asp.net網站,訪問提示:由于擴展配置問題而無法提供您請求的

    今天在iis服務器配置asp.net網站,遇到一個問題,記錄一下: 問題:由于擴展配置問題而無法提供您請求的頁面。如果該頁面是腳本,請添加處理程式。如果應下載檔案,請添加 MIME 映射。 WindowServer2012服務器,添加角色安裝完.netframework和iis之后,運行aspx頁面 ......

    uj5u.com 2020-09-09 22:10:00 more
  • WebAPI-處理架構

    帶著問題去思考,大家好! 問題1:HTTP請求和回傳相應的HTTP回應資訊之間發生了什么? 1:首先是最底層,托管層,位于WebAPI和底層HTTP堆疊之間 2:其次是 訊息處理程式管道層,這里比如日志和快取。OWIN的參考是將訊息處理程式管道的一些功能下移到堆疊下端的OWIN中間件了。 3:控制器處理 ......

    uj5u.com 2020-09-09 22:11:13 more
  • 微信門戶開發框架-使用指導說明書

    微信門戶應用管理系統,采用基于 MVC + Bootstrap + Ajax + Enterprise Library的技術路線,界面層采用Boostrap + Metronic組合的前端框架,資料訪問層支持Oracle、SQLServer、MySQL、PostgreSQL等資料庫。框架以MVC5,... ......

    uj5u.com 2020-09-09 22:15:18 more
  • WebAPI-HTTP編程模型

    帶著問題去思考,大家好!它是什么?它包含什么?它能干什么? 訊息 HTTP編程模型的核心就是訊息抽象,表示為:HttPRequestMessage,HttpResponseMessage.用于客戶端和服務端之間交換請求和回應訊息。 HttpMethod類包含了一組靜態屬性: private stat ......

    uj5u.com 2020-09-09 22:15:23 more
  • 部署WebApi隨筆

    一、跨域 NuGet參考Microsoft.AspNet.WebApi.Cors WebApiConfig.cs中配置: // Web API 配置和服務 config.EnableCors(new EnableCorsAttribute("*", "*", "*")); 二、清除默認回傳XML格式 ......

    uj5u.com 2020-09-09 22:15:48 more
最新发布
  • C#多執行緒學習(二) 如何操縱一個執行緒

    <a href="https://www.cnblogs.com/x-zhi/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/2943582/20220801082530.png" alt="" /></...

    uj5u.com 2023-04-19 09:17:20 more
  • C#多執行緒學習(二) 如何操縱一個執行緒

    C#多執行緒學習(二) 如何操縱一個執行緒 執行緒學習第一篇:C#多執行緒學習(一) 多執行緒的相關概念 下面我們就動手來創建一個執行緒,使用Thread類創建執行緒時,只需提供執行緒入口即可。(執行緒入口使程式知道該讓這個執行緒干什么事) 在C#中,執行緒入口是通過ThreadStart代理(delegate)來提供的 ......

    uj5u.com 2023-04-19 09:16:49 more
  • 記一次 .NET某醫療器械清洗系統 卡死分析

    <a href="https://www.cnblogs.com/huangxincheng/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/214741/20200614104537.png" alt="" /&g...

    uj5u.com 2023-04-18 08:39:04 more
  • 記一次 .NET某醫療器械清洗系統 卡死分析

    一:背景 1. 講故事 前段時間協助訓練營里的一位朋友分析了一個程式卡死的問題,回過頭來看這個案例比較經典,這篇稍微整理一下供后來者少踩坑吧。 二:WinDbg 分析 1. 為什么會卡死 因為是表單程式,理所當然就是看主執行緒此時正在做什么? 可以用 ~0s ; k 看一下便知。 0:000> k # ......

    uj5u.com 2023-04-18 08:33:10 more
  • SignalR, No Connection with that ID,IIS

    <a href="https://www.cnblogs.com/smartstar/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/u36196.jpg" alt="" /></a>...

    uj5u.com 2023-03-30 17:21:52 more
  • 一次對pool的誤用導致的.net頻繁gc的診斷分析

    <a href="https://www.cnblogs.com/dotnet-diagnostic/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/3115652/20230225090434.png" alt=""...

    uj5u.com 2023-03-28 10:15:33 more
  • 一次對pool的誤用導致的.net頻繁gc的診斷分析

    <a href="https://www.cnblogs.com/dotnet-diagnostic/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/3115652/20230225090434.png" alt=""...

    uj5u.com 2023-03-28 10:13:31 more
  • C#遍歷指定檔案夾中所有檔案的3種方法

    <a href="https://www.cnblogs.com/xbhp/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/957602/20230310105611.png" alt="" /></a&...

    uj5u.com 2023-03-27 14:46:55 more
  • C#/VB.NET:如何將PDF轉為PDF/A

    <a href="https://www.cnblogs.com/Carina-baby/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/2859233/20220427162558.png" alt="" />...

    uj5u.com 2023-03-27 14:46:35 more
  • 武裝你的WEBAPI-OData聚合查詢

    <a href="https://www.cnblogs.com/podolski/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/616093/20140323000327.png" alt="" /><...

    uj5u.com 2023-03-27 14:46:16 more