循序漸進學.Net Core Web Api開發系列【13】：中間件（Middleware）

来源:https://www.cnblogs.com/seabluescn/archive/2018/07/21/9345148.html
-Advertisement-
Play Games

系列目錄 循序漸進學.Net Core Web Api開發系列目錄 本系列涉及到的源碼下載地址：https://github.com/seabluescn/Blog_WebApi 一、概述 本篇介紹如何使用中間件（Middleware）。 二、初步演練 先寫幾個中間件 以上中間件前兩個沒有做什麼正經 ...


系列目錄

循序漸進學.Net Core Web Api開發系列目錄

 本系列涉及到的源碼下載地址：https://github.com/seabluescn/Blog_WebApi

 

一、概述

本篇介紹如何使用中間件（Middleware）。

 

二、初步演練

先寫幾個中間件

public class DemoAMiddleware
    {
        private readonly RequestDelegate _next;
        private readonly ILogger _logger;

        public DemoAMiddleware(RequestDelegate next, ILogger<DemoAMiddleware> logger)
        {
            _next = next;
            _logger = logger;
        }

        public async Task Invoke(HttpContext context)
        {
            _logger.LogInformation("(1) DemoAMiddleware.Invoke front");  
            await _next(context);
            _logger.LogInformation("[1] DemoAMiddleware:Invoke back");
        }       
    }

  public class DemoBMiddleware
    {
        private readonly RequestDelegate _next;
        private readonly ILogger _logger;

        public DemoBMiddleware(RequestDelegate next, ILogger<DemoBMiddleware> logger)
        {
            _next = next;
            _logger = logger;
        }

        public async Task Invoke(HttpContext context)
        {

            _logger.LogInformation("(2) DemoBMiddleware.Invoke part1");  
            await _next(context);
            _logger.LogInformation("[2] DemoBMiddleware:Invoke part2");
        }      
    }

    public class RequestRecordMiddleware
    {
        private readonly RequestDelegate _next;
        private readonly ILogger _logger;

        public RequestRecordMiddleware(RequestDelegate next, ILogger<RequestRecordMiddleware> logger)
        {
            _next = next;
            _logger = logger;
        }

        public async Task Invoke(HttpContext context)
        {
            _logger.LogInformation("(3) RequestRecordMiddleware.Invoke");

            String URL = context.Request.Path.ToString();
            _logger.LogInformation($"URL : {URL}");            

            await _next(context);

            _logger.LogInformation("[3] RequestRecordMiddleware:Invoke next");
            _logger.LogInformation($"StatusCode : {context.Response.StatusCode}");
        }       
    }

以上中間件前兩個沒有做什麼正經工作，就列印一些日誌信息，第三個幹了一點工作，它列印了用戶輸入的url，同時列印了返回給客戶端的狀態碼。

要使中間件工作，需要啟用中間件。

   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.AddMvc();
        }

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

            app.UseMiddleware<DemoAMiddleware>();
            app.UseMiddleware<DemoBMiddleware>();           
            app.UseMiddleware<RequestRecordMiddleware>();            

            app.UseStaticFiles();
            app.UseMvcWithDefaultRoute();
        }

通過擴展方法，我們對中間件的啟用代碼進行改造：

public static class RequestRecordMiddlewareExtensions
    {
        public static IApplicationBuilder UseRequestRecord(this IApplicationBuilder builder)
        {
            if (builder == null)
            {
                throw new ArgumentNullException("builder is null");
            }

            return builder.UseMiddleware<RequestRecordMiddleware>();
        }
    }

此時啟用代碼由：app.UseMiddleware<RequestRecordMiddleware>(); 

可以修改為：   app.UseRequestRecord();

實現效果沒有變化。可見下麵代碼都是中間件的使用。

app.UseStaticFiles();
app.UseMvcWithDefaultRoute();

　　

我的理解，中間件類似車間流水線上的工人，操作的零件就是HttpContext，每個人負責兩道工序，我把它們定義為“前道工序”和“後道工序”，通過代碼 _next(context); 把兩道工序隔離開，處理的順序需要特別註意，按照中間件註冊的順序依次處理“前道工序”，處理完成後，再按相反的順序處理“後道工序”，如果某個中間件沒有調用_next(context)，那麼就不會調用後續的中間件，所以中間件啟用的順序是需要特別考慮的。

以上代碼中三個中間件輸出到控制台的信息順序如下：

（1）

（2）

（3）

【3】

【2】

【1】

個人認為，“前道工序”應重點處理Request，“後道工序”應重點處理Response。

 

三、做一個類似MVC的中間件

我們做一個中間件，讓其返回一些內容給客戶端：

public class MyMvcMiddleware
    {
        private readonly RequestDelegate _next;
        private readonly ILogger _logger;

        public MyMvcMiddleware(RequestDelegate next, ILogger<DemoAMiddleware> logger)
        {
            _next = next;
            _logger = logger;
        }

        public async Task Invoke(HttpContext context)
        {  var str = "hello,world!";
            await  context.Response.WriteAsync(str);          
        }       
    }

這個中間件只是返回固定的字元串，我們還可以調用某個Controller的提供的方法。

   public class MyMvcMiddleware
    {
        private readonly RequestDelegate _next;
        private readonly ILogger _logger;

        public MyMvcMiddleware(RequestDelegate next, ILogger<DemoAMiddleware> logger)
        {
            _next = next;
            _logger = logger;
        }

        public async Task Invoke(HttpContext context)
        {
            var obj = context.RequestServices.GetRequiredService<ArticleController>().GetArticleList();
            var str = JsonConvert.SerializeObject(obj);
            await context.Response.WriteAsync(str);
        }
    }
ArticleController的定義如下：
    public class ArticleController : Controller
    {
        private readonly SalesContext _context;
        private readonly ILogger _logger;
        private readonly IMemoryCache _cache;

        public ArticleController(SalesContext context, ILogger<ArticleController> logger, IMemoryCache memoryCache)
        {
            _context = context;
            _logger = logger;
            _cache = memoryCache;
        }

        [HttpGet]
        public ResultObject GetArticleList()
        {
            _logger.LogInformation("==GetArticleList==");

            List<Article> articles = _context.Articles
                .AsNoTracking()
                .ToList();

            return new ResultObject
            {               
                result = articles
            };
        }  
    }

要在中間件中通過依賴使用該Controller，需要將其註冊到DI容器：

 public void ConfigureServices(IServiceCollection services)
{ 
      services.AddScoped<ArticleController>();
}

以上中間件實現了一個文章信息查詢的功能，如果在此中間件內先判斷路徑，再根據不同的路徑調用不同的Contorller提供的服務，就可以形成一個簡單的MVC中間件了。

 

四、中間件的用途

 中間件的使用體現了AOP（面向切片）的編程思想，在不修改現有代碼的情況下，通過增加一些中間件實現一些特定邏輯，可以做的事情很多，比如：

URL重寫

緩存處理

異常處理

用戶認證

 

五、中間件的註冊順序

前文提到中間件的註冊順序是比較重要的，建議的順序如下：

1. 異常/錯誤處理
2. 靜態文件伺服器
3. 身份驗證
4. MVC

 


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

-Advertisement-
Play Games
更多相關文章
  • Spring Cloud 微服務中搭建 OAuth2.0 認證授權服務
    在使用 Spring Cloud 體系來構建微服務的過程中，用戶請求是通過網關(ZUUL 或 Spring APIGateway)以 HTTP 協議來傳輸信息，API 網關將自己註冊為 Eureka 服務治理下的應用，同時也從 Eureka 服務中獲取所有其他微服務的實例信息。搭建 OAuth2 認... ...
  • 1.11（java學習筆記）封裝
    封裝將內部細節封裝起來，只暴露外部介面。 比如我們的電視就將複雜的內部線路用外殼封裝起來，只留下外部按鈕或遙控，用戶只需要知道按鈕或遙控的作用就可以，無需明白電視內部是如何工作。 而且封裝也保障了安全性，用戶只能去使用暴露在外部的介面，不能改變內部結構，保障了正常運行。 封裝後，使用者不必知曉複雜的 ...
  • 數據結構Java實現----鏈表
    MyLinkList類 1 package List; 2 3 // 單向鏈表 4 public class MyLinkList { 5 private Node root; // 根結點 6 private int size; // 結點個數 7 private int index; // 腳標 ...
  • 單向鏈表增刪查
    #include"stdio.h"#include"stdlib.h"typedef struct node{int e;struct node *next;}*NNode;//初始化 NNode InitList(NNode L){ NNode head=NULL; head=(NNode)mal ...
  • 題解 P1967 貨車運輸
    題目描述 A 國有 n 座城市，編號從 1 到 n，城市之間有 m 條雙向道路。每一條道路對車輛都有重量限制，簡稱限重。現在有 q 輛貨車在運輸貨物，司機們想知道每輛車在不超過車輛限重的情況下，最多能運多重的貨物。 輸入 第一行有兩個用一個空格隔開的整數 n，m，表示 A 國有 n 座城市和 m 條 ...
  • Requests神級庫！你會嗎？不會我教你好了！另一神器Pipenv的用法
    簡介 進群：125240963 即可獲取數十套PDF哦！ Pipenv，它的項目簡介為 Python Development Workflow for Humans，是 Python 著名的 requests 庫作者 kennethreitz 寫的一個包管理工具，它可以為我們的項目自動創建和管理虛擬 ...
  • Python 3 進階 —— print 列印和輸出
    在 Python 中，print 可以列印所有變數數據，包括自定義類型。 在 2.x 版本中，print 是個語句，但在 3.x 中卻是個內置函數，並且擁有更豐富的功能。 ...
  • pythonday14
    1. lambda 2. sorted 3. filter 4. map 5. 遞歸 6. 二分查找 ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類