快捷導(dǎo)航

ASP.NET?Core的中間件與管道介紹

更新時(shí)間：2022年01月13日 16:55:27 作者：不敢出門(mén)

這篇文章介紹了ASP.NET?Core的中間件與管道，文中通過(guò)示例代碼介紹的非常詳細(xì)。對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

今天來(lái)討論一個(gè)ASP.NET Core 很重要概念管道和中間件，在ASP.NET Core中，針對(duì)HTTP請(qǐng)求采用pipeline也就是通常說(shuō)的管道方式來(lái)處理，而管道容器內(nèi)可以?huà)燧d很多中間件（處理邏輯）“串聯(lián)”來(lái)處理HTTP請(qǐng)求，每一個(gè)中間件都有權(quán)決定是否需要執(zhí)行下一個(gè)中間件，或者直接做出響應(yīng)。這樣的機(jī)制使得HTTP請(qǐng)求能夠很好的被層層處理和控制，并且層次清晰處理起來(lái)甚是方便。示意圖如下：

為了再次說(shuō)明管道和中間件的概念，舉一個(gè)官方給出的權(quán)限驗(yàn)證的例子，中間件A,B分別按順序掛載在管道容器中，A為權(quán)限驗(yàn)證中間件，只有通過(guò)A的權(quán)限驗(yàn)證才能執(zhí)行B，如果沒(méi)有通過(guò)A的驗(yàn)證，A有權(quán)中斷管道處理直接返回相應(yīng)的錯(cuò)誤提示例如401等。這樣必須由上一節(jié)點(diǎn)來(lái)調(diào)用的串行遞歸執(zhí)行方式就是pipeline，而每一個(gè)節(jié)點(diǎn)就是中間件或者叫中間組件?，F(xiàn)在我們來(lái)看看如何在ASP.NET Core中使用中間件和管理自己的HTTP管道

環(huán)境配置與Startup

在了解中間件之前我們需要先知道Startup這個(gè)類(lèi)具體運(yùn)作方式，我們以下面這段代碼為例：

    /// <summary>
    /// web宿主的入口類(lèi)
    /// </summary>
    public class Startup
    {
        //加入服務(wù)項(xiàng)到容器， 這個(gè)方法將會(huì)被runtime調(diào)用
        public void ConfigureServices(IServiceCollection services)
        {

        }
        
        /// <summary>
        /// 配置HTTP請(qǐng)求管道
        /// </summary>
        /// <param name="app">被用于構(gòu)建應(yīng)用程序的請(qǐng)求管道 只可以在Startup中的Configure方法里使用</param>
        /// <param name="env">提供了訪問(wèn)應(yīng)用程序?qū)傩?，如環(huán)境變量</param>
        /// <param name="loggerFactory">提供了創(chuàng)建日志的機(jī)制</param>
        public void Configure(IApplicationBuilder app,IHostingEnvironment env,ILoggerFactory loggerFactory)
        {
            loggerFactory.AddConsole(); 
            
            if (env.IsDevelopment()) //根據(jù)配置的環(huán)境為開(kāi)發(fā)環(huán)境，則會(huì)配置拋出異常錯(cuò)誤界面
            {
                app.UseDeveloperExceptionPage();  //拋出詳細(xì)的異常錯(cuò)誤界面
            }

            //管道斷路
            app.Run(async (context) =>
            {
                await context.Response.WriteAsync("Hello World!");
            });
        }
    }

可以看到 Startup.cs 內(nèi)有兩個(gè)方法，一個(gè)是用來(lái)配置接口服務(wù)到管道容器中的ConfigureServices，一個(gè)是用來(lái)配置管道中間件的Configure。

為什么必須是這兩個(gè)方法名？

其實(shí)這兩個(gè)方法名并不是規(guī)定死的，但也不是任意規(guī)定的，他是根據(jù)容器的環(huán)境變量來(lái)判斷的，這里先給出官方文檔《多環(huán)境下工作》。

我們可以在文檔中了解到，Core使用“ASPNETCORE_ENVIRONMENT”字段來(lái)描述當(dāng)前運(yùn)行環(huán)境名稱(chēng)這就是上文中提到的環(huán)境配置，官方預(yù)設(shè)了3個(gè)環(huán)境名分別是Development（開(kāi)發(fā)環(huán)境）, Staging（測(cè)試環(huán)境）, Production（生產(chǎn)環(huán)境），如果您使用的是VSCode您可以在.vscode文件夾下的launch.json中找到“ASPNETCORE_ENVIRONMENT”字段，可以發(fā)現(xiàn)默認(rèn)情況下是Development，那說(shuō)這些到底有什么用呢？

在Startup中規(guī)定，配置服務(wù)和中間件兩個(gè)方法可以根據(jù)環(huán)境名稱(chēng)來(lái)命名和選擇調(diào)用，命名規(guī)則為ConfigureServices{ENVIRONMENT}和Configure{ENVIRONMENT}。如ASPNETCORE_ENVIRONMENT = “Development” 則ConfigureServices和Configure 可以寫(xiě)成ConfigureServicesDevelopment 和ConfigureDevelopment ，其他也是如此。這樣就可以通過(guò)配置ASPNETCORE_ENVIRONMENT 來(lái)決定該調(diào)用哪一個(gè)配置方法了。

ConfigureServices和Configure是什么環(huán)境下的呢？

ConfigureServices和Configure就好像Switch 語(yǔ)句中的 default一樣的道理，如果沒(méi)有找到任何符合環(huán)境名的方法名，就會(huì)執(zhí)行調(diào)用這兩個(gè)方法。如配置了Development，但卻沒(méi)有給出ConfigureServicesDevelopment ，這時(shí)就會(huì)執(zhí)行ConfigureServices，如果都沒(méi)有就會(huì)拋出異常。

必須設(shè)置成預(yù)設(shè)環(huán)境名嗎？

環(huán)境名配置的參數(shù)名不必是預(yù)設(shè)值，你可以自己寫(xiě)一個(gè)，比如LogEnv等等。

接下來(lái)我們看一下實(shí)現(xiàn)的代碼：

     /// <summary>
    /// web宿主的入口類(lèi)
    /// </summary>
    public class Startup
    {
        //加入服務(wù)項(xiàng)到容器， 這個(gè)方法將會(huì)被runtime調(diào)用
        public void ConfigureServices(IServiceCollection services)
        {

        }

        /// <summary>
        /// Log環(huán)境下配置HTTP請(qǐng)求管道
        /// </summary>
        /// <param name="app"></param>
        public void ConfigureLogHelp(IApplicationBuilder app){
            app.Run(async (context) =>
            {
                 await context.Response.WriteAsync("Hello World - ConfigureLogHelp");
            });
        }    

        /// <summary>
        /// 開(kāi)發(fā)環(huán)境下配置HTTP請(qǐng)求管道
        /// </summary>
        /// <param name="app"></param>
        public void ConfigureDevelopment(IApplicationBuilder app){
            app.Run(async (context) =>
            {
                 await context.Response.WriteAsync("Hello World - ConfigureDevelopment");
            });
        }


            
        /// <summary>
        /// 默認(rèn)情況下配置HTTP請(qǐng)求管道
        /// </summary>
        /// <param name="app">被用于構(gòu)建應(yīng)用程序的請(qǐng)求管道。只可以在 Startup 中的 Configure 方法里使用</param>
        /// <param name="env">提供了訪問(wèn)應(yīng)用程序?qū)傩裕绛h(huán)境變量</param>
        /// <param name="loggerFactory">提供了創(chuàng)建日志的機(jī)制</param>
        public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
        {

            //管道斷路
            app.Run(async (context) =>
            {
                await context.Response.WriteAsync("Hello World!");
            });
        }

當(dāng)ASPNETCORE_ENVIRONMENT = “Development”

當(dāng)ASPNETCORE_ENVIRONMENT = “LogHelp”

這樣做的好處就是你可以寫(xiě)自己的測(cè)試配置而不會(huì)影響到其他人或者開(kāi)發(fā)過(guò)程。當(dāng)然環(huán)境的作用還在于前端應(yīng)該引用什么樣的CSS和JS，關(guān)于這些我們之后在MVC的章節(jié)再來(lái)討論，想了解的博友可以看官方文檔

管道配置與Startup

說(shuō)完環(huán)境配置和Startup的關(guān)系，我們回來(lái)接著聊管道的事情，現(xiàn)在我們來(lái)說(shuō)說(shuō)Configure{ENVIRONMENT}一下Configure簡(jiǎn)稱(chēng)這個(gè)方法。

Configure這個(gè)方法是用于配置中間件到中管道容器（IApplicationBuilder），所以這個(gè)方法必須要包含一個(gè)IApplicationBuilder參數(shù)用來(lái)接受管道容器，方便開(kāi)發(fā)者配置。當(dāng)然他還可以接受其他的可選參數(shù)供開(kāi)發(fā)者使用如下：

（注：下圖來(lái)源于ASP.NET Core中文文檔）

需要提一下的是，剛剛我們上文中說(shuō)的環(huán)境名在IHostingEnvironment中可以獲取，對(duì)于預(yù)設(shè)值官方還做了判斷封裝，當(dāng)然你可以重構(gòu)它來(lái)封裝自己的環(huán)境名判斷。

HTTP管道容器由三個(gè)擴(kuò)展的方法來(lái)控制中間件的路由、掛載等等，分別是Run, Map, User。

a.Run方法會(huì)使得可以使管道短路，顧名思義就是終結(jié)管道向下執(zhí)行不會(huì)調(diào)用next()委托，所以Run方法最好放在管道的最后來(lái)執(zhí)行,如下面的代碼：

        /// <summary>
        /// 開(kāi)發(fā)環(huán)境下配置HTTP請(qǐng)求管道
        /// </summary>
        /// <param name="app"></param>
        public void ConfigureDevelopment(IApplicationBuilder app){
            app.Run(async (context) =>
            {
                 await context.Response.WriteAsync("Hello World - ConfigureDevelopment");
            });

            app.Run(async (context) =>
            {
                 await context.Response.WriteAsync("Hello World - ConfigureDevelopment 不會(huì)被執(zhí)行");
            });

        }

執(zhí)行結(jié)果：

b.Use不會(huì)主動(dòng)短路整個(gè)HTTP管道，但是也不會(huì)主動(dòng)調(diào)用下一個(gè)中間件，必須自行調(diào)用await next.Invoke(); 如果不使用這個(gè)方法去調(diào)用下一個(gè)中間件那么Use此時(shí)的效果其實(shí)和Run是相同的，我們來(lái)看正常的代碼：

        /// <summary>
        /// 開(kāi)發(fā)環(huán)境下配置HTTP請(qǐng)求管道
        /// </summary>
        /// <param name="app"></param>
        public void ConfigureDevelopment(IApplicationBuilder app){
            var order ="";
            app.Use(async (context, next) =>
            {
                order = $"{order}|Use start";
                await next.Invoke();
                order = $"{order}|Use end";
            });

            app.Run(async context =>
            {
                await context.Response.WriteAsync($"{order}|Run ext");
            });

        }

執(zhí)行結(jié)果如下：

可以看到，Use end并沒(méi)有被執(zhí)行到，因?yàn)樵谡{(diào)用下一個(gè)中間件時(shí)采用了Run,管道被終止了。

再來(lái)看看如果不顯式調(diào)用next.Invoke()時(shí)的代碼：

        /// <summary>
        /// 開(kāi)發(fā)環(huán)境下配置HTTP請(qǐng)求管道
        /// </summary>
        /// <param name="app"></param>
        public void ConfigureDevelopment(IApplicationBuilder app){
            var order ="";
            app.Use(async (context, next) =>
            {
                order = $"{order}|Use start";
                //去掉顯示調(diào)用下一個(gè)中間件
                //await next.Invoke();
                order = $"{order}|Use end";
                await context.Response.WriteAsync(order);
            });

            app.Run(async context =>
            {
                await context.Response.WriteAsync($"{order}|Run ext");
            });

        }

其結(jié)果如下：

可以發(fā)現(xiàn)Run這個(gè)中間件并沒(méi)有被執(zhí)行，而只是單純的執(zhí)行了Use這個(gè)中間件。所以說(shuō) 在不顯式調(diào)用下一個(gè)中間件的情況下，效果和Run時(shí)一樣的會(huì)使管道短路。

c.Map可以根據(jù)提供的URL來(lái)路由中間件，如下代碼判斷URL中訪問(wèn)"/test"時(shí)就會(huì)執(zhí)行某個(gè)中間件邏輯：

        /// <summary>
        /// 開(kāi)發(fā)環(huán)境下配置HTTP請(qǐng)求管道
        /// </summary>
        /// <param name="app"></param>
        public void ConfigureDevelopment(IApplicationBuilder app){
            app.Map("/test", HandleMapTest);
        }

        /// <summary>
        /// maptest 處理方法
        /// </summary>
        public void HandleMapTest(IApplicationBuilder app){
            app.Run(async (context) =>
            {
                await context.Response.WriteAsync("HandleMapTest Handler");
            });

        }

結(jié)果如下：

如果訪問(wèn)/test就會(huì)執(zhí)行相應(yīng)的中間件，反之則不會(huì)執(zhí)行。

MapWhen是Map的一個(gè)條件判斷的擴(kuò)展方法，可以通過(guò)它來(lái)判斷某個(gè)條件適合的時(shí)候執(zhí)行某一個(gè)中間件，如：當(dāng)攜帶某一個(gè)參數(shù)名稱(chēng)時(shí)，執(zhí)行某一個(gè)中間件或者反之，代碼如下：

        /// <summary>
        /// 開(kāi)發(fā)環(huán)境下配置HTTP請(qǐng)求管道
        /// </summary>
        /// <param name="app"></param>
        public void ConfigureDevelopment(IApplicationBuilder app){
           app.MapWhen(context => {
                return context.Request.Query.ContainsKey("username");
           }, HandleUserName);
           app.Run(async context =>
           {
                await context.Response.WriteAsync("default ext");
           });
        }

        /// <summary>
        /// 
        /// </summary>
        public void HandleUserName(IApplicationBuilder app){
            app.Run(async context =>
            {
                await context.Response.WriteAsync("UserName Map");
            });
        }

結(jié)果如下：