一文說通Dotnet Core的中間件

来源:https://www.cnblogs.com/tiger-wang/archive/2020/06/03/13038419.html
-Advertisement-
Play Games

前幾天，公眾號後臺有朋友在問Core的中間件，所以專門抽時間整理了這樣一篇文章。 一、前言 中間件（Middleware）最初是一個機械上的概念，說的是兩個不同的運動結構中間的連接件。後來這個概念延伸到軟體行業，大家把應用操作系統和電腦硬體之間過渡的軟體或系統稱之為中間件，比方驅動程式，就是一個典型 ...


前幾天，公眾號後臺有朋友在問Core的中間件，所以專門抽時間整理了這樣一篇文章。

 

一、前言

中間件（Middleware）最初是一個機械上的概念，說的是兩個不同的運動結構中間的連接件。後來這個概念延伸到軟體行業，大家把應用操作系統和電腦硬體之間過渡的軟體或系統稱之為中間件，比方驅動程式，就是一個典型的中間件。再後來，這個概念就泛開了，任何用來連接兩個不同系統的東西，都被叫做中間件。

所以，中間件只是一個名詞，不用太在意，實際代碼跟他這個詞，也沒太大關係。

 

中間件技術，早在.Net framework時期就有，只不過，那時候它不是Microsoft官方的東西，是一個叫OWIN的三方框架下的實現。到了.Net core，Microsoft才把中間件完整加到框架里來。

感覺上，應該是Core參考了OWIN的中間件技術（猜的，未求證）。在實現方式上，兩個框架下的中間件沒什麼區別。

 

下麵，我們用一個實際的例子，來理清這個概念。

    為了防止不提供原網址的轉載，特在這裡加上原文鏈接：https://www.cnblogs.com/tiger-wang/p/13038419.html

二、開發環境&基礎工程

這個Demo的開發環境是：Mac + VS Code + Dotnet Core 3.1.2。

$ dotnet --info
.NET Core SDK (reflecting any global.json):
 Version:   3.1.201
 Commit:    b1768b4ae7

Runtime Environment:
 OS Name:     Mac OS X
 OS Version:  10.15
 OS Platform: Darwin
 RID:         osx.10.15-x64
 Base Path:   /usr/local/share/dotnet/sdk/3.1.201/

Host (useful for support):
  Version: 3.1.3
  Commit:  4a9f85e9f8

.NET Core SDKs installed:
  3.1.201 [/usr/local/share/dotnet/sdk]

.NET Core runtimes installed:
  Microsoft.AspNetCore.App 3.1.3 [/usr/local/share/dotnet/shared/Microsoft.AspNetCore.App]
  Microsoft.NETCore.App 3.1.3 [/usr/local/share/dotnet/shared/Microsoft.NETCore.App]

 

首先，在這個環境下建立工程：

  1. 創建Solution
% dotnet new sln -o demo
The template "Solution File" was created successfully.
  1. 這次，我們用Webapi創建工程
% cd demo
% dotnet new webapi -o demo
The template "ASP.NET Core Web API" was created successfully.

Processing post-creation actions...
Running 'dotnet restore' on demo/demo.csproj...
  Restore completed in 179.13 ms for demo/demo.csproj.

Restore succeeded.
  1. 把工程加到Solution中
% dotnet sln add demo/demo.csproj

基礎工程搭建完成。

三、創建第一個中間件

我們先看下Demo項目的Startup.cs文件：

namespace demo
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();
        }

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

            app.UseHttpsRedirection();

            app.UseRouting();

            app.UseAuthorization();

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
            });
        }
    }
}

這是Startup預設生成後的樣子（註意，不同的操作系統下生成的代碼會略有不同，但本質上沒區別）。

其中，Configure是中間件的運行定義，ConfigureServices是中間件的參數設置註入。

 

我們在Configure方法里，加入一個簡單的中間件：

app.UseAuthorization();
/////////////////////下麵是加入的代碼
app.Use(async (context, next) =>
{
    // your code
    await next.Invoke();
    // your code
});
/////////////////////////
app.UseEndpoints(endpoints =>
{
        endpoints.MapControllers();
});

在這個代碼中，app.Use是引入中間件的方式，而真正的中間件，是async (context, next)，這是一個delegate方法。

中間件方法的兩個參數，context是上下文HttpContext，next指向下一個中間件。

其中，next參數很重要。中間件採用管道的形式執行。多個中間件，通過next進行調用。

四、中間件的短路

在前一節，我們看到了中間件的標準形式。

有時候，我們希望中間件執行完成後就退出執行，而不進入下一個中間件。這時候，我們可以把await next.Invoke()從代碼中去掉。變成下麵的形式：

app.Use(async (context, next) =>
{
    // your code
});

對於這種形式，Microsoft給出了另一個方式的寫法：

app.Run(async context =>
{
    // your code
});

這兩種形式，效果完全一樣。

這種形式，我們稱之為短路，就是說在這個中間件執行後，程式即返回數據給客戶端，而不執行下麵的中間件。

五、中間件的映射

有時候，我們需要把一個中間件映射到一個Endpoint，用以對外提供簡單的API處理。這種時間，我們需要用到映射：

app.Map("/apiname", apiname => {
    app.Use(async (context, next) =>
    {
        // your code
        await next.Invoke();
    });  
});

此外，映射支持嵌套：

app.Map("/router", router => {
        router.Map("/api1name", api1Name => {
        app.Use(async (context, next) =>
        {
            // your code
            await next.Invoke();
        }); 
        });
      router.Map("/api2name", api2Name => {
        app.Use(async (context, next) =>
        {
            // your code
            await next.Invoke();
        });     
    });
})

對於這兩個嵌套的映射，我們訪問的Endpoint分別是/router/api1name和/router/api2name。

 

以上部分，就是中間件的基本內容。

但是，這兒有個問題：為什麼我們從各處文章里看到的中間件，好像都不是這麼寫的？

嗯，答案其實很簡單，我們看到的方式，也都是中間件。只不過，那些代碼，是這個中間件的最基本樣式的變形。

下麵，我們就來說說變形。

六、變形1: 獨立成一個類

大多數情況下，我們希望中間件能獨立成一個類，方便控制，也方便程式編寫。

這時候，我們可以這樣做：先寫一個類：

public class TestMiddleware
{
    private readonly RequestDelegate _next;

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

    public async Task Invoke(HttpContext context)
    {
        // Your code
        await _next.Invoke(context);
    }
}

這個類里context和next和上面簡單形式下的兩個參數，類型和意義是完全一樣的。

下麵，我們把這個類引入到Configure中：

app.UseMiddleware<TestMiddleware>();

註意，引入Middleware類，需要用app.UseMiddleware而不是app.Use。

app.Use引入的是方法，而app.UseMiddleware引入的是類。就這點區別。

 

如果再想高大上一點，可以做個Extensions：

public static class TestMiddlewareExtensions
{
    public static IApplicationBuilder UseTestMiddleware(this IApplicationBuilder app)
    {
        return app.UseMiddleware<TestMiddleware>();
    }
}

然後，在Configure中，就可以換成：

app.UseTestMiddleware();

 

看著高大上了有沒有？

七、變形2: 簡單引入參數

有時候，我們需要給在中間件初始化時，給它傳遞一些參數。

看類：

public class TestMiddleware
{
    private readonly RequestDelegate _next;
    private static object _parameter

    public TestMiddleware(RequestDelegate next, object parameter)
    {
        _next = next;
        _parameter = parameter;
    }

    public async Task Invoke(HttpContext context)
    {
        // Your code
        await _next.Invoke(context);
    }
}

那相應的，我們在Configure中引入時，需要寫成：

app.UseMiddleware<TestMiddleware>(new object());

 

同理，如果我們用Extensions時：

public static class TestMiddlewareExtensions
{
    public static IApplicationBuilder UseTestMiddleware(this IApplicationBuilder app, object parameter)
    {
        return app.UseMiddleware<TestMiddleware>(parameter);
    }
}

同時，引入變為：

app.UseTestMiddleware(new object());

八、變形3: 依賴註入參數

跟前一節一樣，我們需要引入參數。這一節，我們用另一種更優雅的方式：依賴註入參數。

先創建一個interface：
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • spring註入map,spring註入一個介面的多個實現類在map里
    spring註入map,spring註入一個介面的多個實現類在map里 ...
  • python-AES加密解密
    轉載https://www.jianshu.com/p/5d27888e7c93#!/xh #!/usr/bin/env python # -*- coding=utf-8 -*- """ AES加密解密工具類 @author jzx @date 2018/10/24 此工具類加密解密結果與 htt ...
  • Kotlin與java8的SAM轉換對比
    什麼是sam 轉換 Single Abstract Method 實際上這是java8中提出的概念，你就把他理解為是一個方法的介面的就可以了 看一下我們每天都在使用的線程池 ExecutorService executorService= Executors.newScheduledThreadPo ...
  • 結合 AOP 輕鬆處理事件發佈處理日誌
    結合 AOP 輕鬆處理事件發佈處理日誌 Intro 前段時間，實現了 EventBus 以及 EventQueue 基於 Event 的事件處理，但是沒有做日誌（EventLog）相關的部分，原本想增加兩個介面， 處理事件發佈日誌和事件處理日誌，最近用了 AOP 的思想處理了 EntityFrame ...
  • api.versioning 版本控制 自動識別最高版本
    Microsoft.AspNetCore.Mvc.Versioning //引入程式集 .net core 下麵api的版本控製作用不需要多說，可以查閱https://www.cnblogs.com/dc20181010/p/11313738.html 普通的版本控制一般是通過鏈接、header此類 ...
  • 基於 abp vNext 和 .NET Core 開發博客項目 - 博客介面實戰篇（二）
    系列文章 基於 abp vNext 和 .NET Core 開發博客項目 - 使用 abp cli 搭建項目 基於 abp vNext 和 .NET Core 開發博客項目 - 給項目瘦身，讓它跑起來 基於 abp vNext 和 .NET Core 開發博客項目 - 完善與美化，Swagger登場 ...
  • C#基於NModbus實現MODBUSTCP字元串、浮點數讀寫
    引用NModbus 在NuGet搜索NModbus，添加引用。 封裝ModbusTcp類 public class ModbusTCP { private ModbusFactory modbusFactory; private IModbusMaster master; private TcpCl ...
  • 在MVC項目中使用 Swagger API文檔
    參考文檔： https://www.cnblogs.com/liaods/p/10101513.html https://www.cnblogs.com/zyz-Notes/p/12030281.html 本示例使用MVC項目做演示（不推薦，推薦直接用WebAPI)，框架版本使用 4.6.2 為了支 ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類