ASP.NET Core 2 學習筆記（三）

来源:https://www.cnblogs.com/snaildev/archive/2018/05/23/9075424.html
-Advertisement-
Play Games

之前ASP.NET中使用的HTTP Modules及HTTP Handlers，在ASP.NET Core中已不復存在，取而代之的是Middleware。Middleware除了簡化了HTTP Modules/Handlers的使用方式，還帶入了Pipeline的概念。本篇將介紹ASP.NET Co ...


之前ASP.NET中使用的HTTP Modules及HTTP Handlers，在ASP.NET Core中已不復存在，取而代之的是Middleware。Middleware除了簡化了HTTP Modules/Handlers的使用方式，還帶入了Pipeline的概念。
本篇將介紹ASP.NET Core的Middleware概念及用法。

Middleware 概念

ASP.NET Core在Middleware的官方說明中，使用了Pipeline這個名詞，意指Middleware像水管一樣可以串聯在一起，所有的Request及Response都會層層經過這些水管。
用圖例可以很容易理解，如下圖：

 

App.Use

Middleware的註冊方式是在Startup.cs的Configure對IApplicationBuilder使用Use方法註冊。
大部分擴展的Middleware也都是以Use開頭的方法註冊，例如：

  • UseMvc()：MVC的Middleware
  • UseRewriter()：URL rewriting的Middleware

一個簡單的Middleware 範例。如下：

Startup.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.DependencyInjection;

namespace MyWebsite
{
    public class Startup
    {
        // This method gets called by the runtime. Use this method to add services to the container.
        // For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940
        public void ConfigureServices(IServiceCollection services)
        {
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.Use(async (context, next) =>
            {
                await context.Response.WriteAsync("First Middleware in. \r\n");
                await next.Invoke();
                await context.Response.WriteAsync("First Middleware out. \r\n");
            });

            app.Use(async (context, next) =>
            {
                await context.Response.WriteAsync("Second Middleware in. \r\n");
                await next.Invoke();
                await context.Response.WriteAsync("Second Middleware out. \r\n");
            });

            app.Use(async (context, next) =>
            {
                await context.Response.WriteAsync("Third Middleware in. \r\n");
                await next.Invoke();
                await context.Response.WriteAsync("Third Middleware out. \r\n");
            });

            app.Run(async (context) =>
            {
                await context.Response.WriteAsync("Hello World! \r\n");
            });
        }
    }
}

用瀏覽器打開網站任意連結，輸出結果：　

First Middleware in. 
Second Middleware in. 
Third Middleware in. 
Hello World! 
Third Middleware out. 
Second Middleware out. 
First Middleware out.

在Pipeline的概念中，註冊順序是很重要的事情。請求經過的順序一定是先進後出。

Request 流程如下圖： 

 

 Middleware 也可以作為攔截使用，如下：

 Startup.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.DependencyInjection;

namespace MyWebsite
{
    public class Startup
    {
        // This method gets called by the runtime. Use this method to add services to the container.
        // For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940
        public void ConfigureServices(IServiceCollection services)
        {
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.Use(async (context, next) =>
            {
                await context.Response.WriteAsync("First Middleware in. \r\n");
                await next.Invoke();
                await context.Response.WriteAsync("First Middleware out. \r\n");
            });

            app.Use(async (context, next) =>
            {
                await context.Response.WriteAsync("Second Middleware in. \r\n");

                // 水管阻塞，封包不往後送
                var condition = false;
                if (condition)
                {
                    await next.Invoke();
                }
                await context.Response.WriteAsync("Second Middleware out. \r\n");
            });

            app.Use(async (context, next) =>
            {
                await context.Response.WriteAsync("Third Middleware in. \r\n");
                await next.Invoke();
                await context.Response.WriteAsync("Third Middleware out. \r\n");
            });

            app.Run(async (context) =>
            {
                await context.Response.WriteAsync("Hello World! \r\n");
            });
        }
    }
}

輸出結果：

First Middleware in. 
Second Middleware in. 
Second Middleware out. 
First Middleware out.

在Second Middleware 中，因為沒有達成條件，所以封包也就不在往後面的水管傳送。流程如圖：

App.Run

Run是Middleware的最後一個行為，以上面圖例來說，就是最末端的Action。
它不像Use能串聯其他Middleware，但Run還是能完整的使用Request及Response。

App.Map

Map是能用來處理一些簡單路由的Middleware，可依照不同的URL指向不同的Run及註冊不同的Use。
新增一個路由如下：

Startup.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.DependencyInjection;

namespace MyWebsite
{
    public class Startup
    {
        // This method gets called by the runtime. Use this method to add services to the container.
        // For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940
        public void ConfigureServices(IServiceCollection services)
        {
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.Use(async (context, next) =>
            {
                await context.Response.WriteAsync("First Middleware in. \r\n");
                await next.Invoke();
                await context.Response.WriteAsync("First Middleware out. \r\n");
            });

            // app.Use(async (context, next) =>
            // {
            //     await context.Response.WriteAsync("Second Middleware in. \r\n");

            //     // 水管阻塞，封包不往後送
            //     var condition = false;
            //     if (condition)
            //     {
            //         await next.Invoke();
            //     }
            //     await context.Response.WriteAsync("Second Middleware out. \r\n");
            // });

            app.Map("/second", mapApp =>
            {
                mapApp.Use(async (context, next) =>
                {
                    await context.Response.WriteAsync("Second Middleware in. \r\n");
                    await next.Invoke();
                    await context.Response.WriteAsync("Second Middleware out. \r\n");
                });
                mapApp.Run(async context =>
                {
                    await context.Response.WriteAsync("Second. \r\n");
                });
            });


            app.Use(async (context, next) =>
            {
                await context.Response.WriteAsync("Third Middleware in. \r\n");
                await next.Invoke();
                await context.Response.WriteAsync("Third Middleware out. \r\n");
            });

            app.Run(async (context) =>
            {
                await context.Response.WriteAsync("Hello World! \r\n");
            });
        }
    }
}

開啟網站任意連結，會顯示：

First Middleware in. 
Third Middleware in. 
Hello World! 
Third Middleware out. 
First Middleware out.

開啟網站http://localhost:5000/second，則會顯示：

First Middleware in. 
Second Middleware in. 
Second. 
Second Middleware out. 
First Middleware out.

 

創建Middleware 類

如果Middleware全部都寫在Startup.cs，代碼將很難維護，所以應該把自定義的Middleware邏輯獨立出來。
建立Middleware類不需要額外繼承其它類或介面，一般的類即可，例子如下：

FirstMiddleware.cs

using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;

namespace MyWebsite
{
    public class FirstMiddleware
    {
        private readonly RequestDelegate _next;

        public FirstMiddleware(RequestDelegate next)
        {
            _next = next;
        }

        public async Task Invoke(HttpContext context)
        {
            await context.Response.WriteAsync($"{nameof(FirstMiddleware)} in. \r\n");

            await _next(context);

            await context.Response.WriteAsync($"{nameof(FirstMiddleware)} out. \r\n");
        }
    }
}

全局註冊

在Startup.Configure註冊Middleware就可以套用到所有的Request。如下：

Startup.cs

// ...
public class Startup
{
    // ...
    public void Configure(IApplicationBuilder app)
    {
        app.UseMiddleware<FirstMiddleware>();
        // ...
    }
}

局部註冊

Middleware 也可以只套用在特定的Controller 或Action。註冊方式如下：

Controllers\HomeController.cs

// ..
[MiddlewareFilter(typeof(FirstMiddleware))]
public class HomeController : Controller
{
    // ...

    [MiddlewareFilter(typeof(SecondMiddleware))]
    public IActionResult Index()
    {
        // ...
    }
}

Extensions

大部分擴展的Middleware都會用一個靜態方法包裝，如：UseMvc()、UseRewriter()等。
自定義的Middleware當然也可以透過靜態方法包，範例如下：

Extensions\CustomMiddlewareExtensions.cs

using Microsoft.AspNetCore.Builder;

namespace MyWebsite
{
    public static class CustomMiddlewareExtensions
    {
        public static IApplicationBuilder UseFirstMiddleware(this IApplicationBuilder builder)
        {
            return builder.UseMiddleware<FirstMiddleware>();
        }
    }
}

註冊Extension Middleware 的方式如下：

Startup.cs

// ...
public class Startup
{
    // ...
    public void Configure(IApplicationBuilder app)
    {
        app.UseFirstMiddleware();
        // ...
    }
}

參考

ASP.NET Core Middleware Fundamentals 
Creating Custom Middleware In ASP.Net Core

 

老司機發車啦：https://github.com/SnailDev/SnailDev.NETCore2Learning


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

-Advertisement-
Play Games
更多相關文章
  • 【C#】轉一篇MSDN雜誌文：ASP.NET Pipeline: Use Threads and Build Asynchronous Handlers in Your Server-Side Web Code
    序：這是一篇發表在2003年6月刊的MSDN Magazine的文章，現在已經不能線上閱讀，只提供chm下載。講的是非同步請求處理那些事，正是我上一篇博文涉及的東西（BTW，事實上這篇雜誌闡述了那麼搞然並卵），期間有搜索到這篇文章，很受裨益。擔心MS哪麽時候不再提供下載以及本地保管不便，所以現在謄上來 ...
  • .Net core使用EF Core Migration做資料庫升級
    恢復內容開始 (1)VS Code下創建含有授權功能的並且使用localdb作為資料庫的命令 dotnet new -au individual -uld --name identitySample identitySample為項目名稱 (2)創建完成以後會在項目的appsettings.json ...
  • ConnectionString 屬性尚未初始化
    關於“ConnectionString 屬性尚未初始化”的問題（如下圖）， 我在下麵一段代碼中發現了問題所在: 問題就出在標紅的代碼上，cnn.dispose（） 釋放con對象所占用的資源，釋放後這個對象就不可用了，所以出現“ConnectionString 屬性尚未初始化”的問題，當頁面首次載入 ...
  • BitAdminCore框架應用篇：（三）核心套件querySuite入門介紹
    BitAdminCore應用索引 NET Core應用框架之BitAdminCore框架應用篇系列 一、簡介 querySuite為適應後臺快速增刪查改而自行開發的組件。 開發套件的核心思想： 1、佈局與功能分離：佈局歸佈局，功能歸功能。 2、佈局易讀性：使用行業通用佈局，能看到需要呈現的完整元素。 ...
  • c# .net中的簡單Job
    using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; using System.Threading; using Syst... ...
  • 學習ASP.NET Core Razor 編程系列十——添加新欄位
    在經過了上面幾篇文章的學習這賓，本篇文章我們來學習如何在已經的功能中添加新欄位。 ...
  • BitAdminCore框架更新日誌20180523
    20180523更新內容 本次更新兩個內容，一是增加視頻處理功能，二是增加定時服務功能。 視頻處理 定時服務 BitAdminCore框架，用最少的代碼，實現最多的功能 本次新暫未發佈，後續有空發佈 計劃修改內容 1、人臉登錄功能需要重構，目前功能不完善。 2、QuerySuite類重構，同時支持m ...
  • .NET 簡易方法攔截器
    偉大的無產階級Willaim曾說過："無論你覺得自己多麼的了不起，也永遠有人比你更強"。對，我說過！我就是william。 今天想記錄一下在項目中遇到的一個比較有意思的東西，異常攔截器(也不能完全說只是異常攔截，準確的說應該叫方法攔截)，那有的人可能會說，異常攔截器不就是用Try……Catch就好了 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 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 ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類