ASP.NET Core如何知道一個請求執行了哪些中介軟體？

Ax0ne發表於2023-04-09
ASP.NET

第一步，新增Nuget包引用

需要新增兩個Nuget包分別是：Microsoft.AspNetCore.MiddlewareAnalysis和Microsoft.Extensions.DiagnosticAdapter，前者是分析記錄中介軟體核心程式碼實現後者是用來接收日誌輸出的，由於是用的DiagnosticSource方式記錄日誌，所以需要使用DiagnosticListener物件的SubscribeWithAdapter方法來訂閱。

第二步，實現一個分析診斷介面卡

這個介面卡是為了方便我們把從DiagnosticSource接收到的日誌物件輸出到控制檯，具體程式碼實現如下

    public class AnalysisDiagnosticAdapter
    {
        private readonly ILogger<AnalysisDiagnosticAdapter> _logger;
        public AnalysisDiagnosticAdapter(ILogger<AnalysisDiagnosticAdapter> logger)
        {
            _logger = logger;
        }

        [DiagnosticName("Microsoft.AspNetCore.MiddlewareAnalysis.MiddlewareStarting")]
        public void OnMiddlewareStarting(HttpContext httpContext, string name, Guid instance, long timestamp)
        {
            _logger.LogInformation($"中介軟體-啟動: '{name}'; Request Path: '{httpContext.Request.Path}'");
        }

        [DiagnosticName("Microsoft.AspNetCore.MiddlewareAnalysis.MiddlewareException")]
        public void OnMiddlewareException(Exception exception, HttpContext httpContext, string name, Guid instance, long timestamp, long duration)
        {
            _logger.LogInformation($"中介軟體-異常: '{name}'; '{exception.Message}'");
        }

        [DiagnosticName("Microsoft.AspNetCore.MiddlewareAnalysis.MiddlewareFinished")]
        public void OnMiddlewareFinished(HttpContext httpContext, string name, Guid instance, long timestamp, long duration)
        {
            _logger.LogInformation($"中介軟體-結束: 耗時[{duration/10000}] '{name}'; Status: '{httpContext.Response.StatusCode}'");
        }
    }

第三步，註冊相關服務來啟用分析中介軟體的功能

  1. 註冊中介軟體分析服務
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddMiddlewareAnalysis();
  1. 訂閱我們的分析診斷介面卡
var listener = app.Services.GetRequiredService<DiagnosticListener>();
var observer = ActivatorUtilities.CreateInstance<AnalysisDiagnosticAdapter>(app.Services);
using var disposable = listener.SubscribeWithAdapter(observer);

這樣基本就完成了分析記錄中介軟體的功能，啟動程式看看效果

日誌已經成功的輸出到我們的控制檯了，不過才四個中介軟體，應該不止這麼少的，再在註冊中介軟體分析服務哪裡新增一句程式碼

var builder = WebApplication.CreateBuilder(args);
// 新增的下面這句程式碼
builder.Services.Insert(0, ServiceDescriptor.Transient<IStartupFilter, AnalysisStartupFilter>());
builder.Services.AddMiddlewareAnalysis();

現在再來看看效果，發現變成8箇中介軟體了多了四個

在Release模式編譯後，執行發現中介軟體的執行效率非常高，幾乎不佔用時間

異常記錄這裡就不放圖了，有興趣的朋友自己去試試。
簡單三步就可以知道一個請求到底執行了哪些中介軟體還是挺方便的。想知道實現原理可以去看看Microsoft.AspNetCore.MiddlewareAnalysis這個庫，一共才四個檔案看起來不費事。

相關文章