feat: 现在中间件捕获异常时将触发回调而不是直接进行异常记录

Author: stratosblue

global.json

@@ -1,5 +1,5 @@
 {
   "msbuild-sdks": {
-    "MSTest.Sdk": "3.6.4"
+    "MSTest.Sdk": "3.7.2"
   }
 }

src/Cuture.AspNetCore.ResponseAutoWrapper/Cuture.AspNetCore.ResponseAutoWrapper.csproj

@@ -16,7 +16,7 @@
     <IsPackable>true</IsPackable>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
 
-    <Version>1.2.2</Version>
+    <Version>1.2.3</Version>
     <Description>Response and exception automatic wrapper for `asp.net core` to provide a consistent response content format for `Action`. 用于`asp.net core`的响应和异常自动包装器，使`Action`提供一致的响应内容格式。</Description>
 
     <PackageIdPrefix>Cuture.AspNetCore.ResponseAutoWrapper</PackageIdPrefix>

src/Cuture.AspNetCore.ResponseAutoWrapper/ResponseAutoWrapMiddleware.cs

@@ -26,6 +26,8 @@ internal class ResponseAutoWrapMiddleware
 
     private readonly ILogger _logger;
 
+    private readonly ResponseAutoWrapMiddlewareOptions.MiddlewareExceptionCaptured _middlewareExceptionCaptured;
+
     private readonly RequestDelegate _next;
 
     private readonly bool _notCatchExceptions;
@@ -90,6 +92,7 @@ public ResponseAutoWrapMiddleware(RequestDelegate next,
         _notCatchExceptions = !options.CatchExceptions;
         _throwCaughtExceptions = options.ThrowCaughtExceptions;
         _ignoreOptionsRequest = options.IgnoreOptionsRequest;
+        _middlewareExceptionCaptured = options.OnMiddlewareExceptionCaptured ?? LogMiddlewareException;
 
         var delegateCollection = GetService<ResponseAutoWrapperWorkDelegateCollection>();
 
@@ -123,22 +126,7 @@ public async Task InvokeAsync(HttpContext context)
                 throw;
             }
 
-            if (!_throwCaughtExceptions)
-            {
-                //不抛出异常时，记录异常
-                var request = context.Request;
-                //https://github.com/dotnet/aspnetcore/tree/8dd33378697e6f8ca89116170ec3046c185724b6/src/Hosting/Hosting/src/Internal/HostingRequestStartingLog.cs
-                _logger.LogError(ex, "Request error {Protocol} {Method} {Scheme}://{Host}{PathBase}{Path}{QueryString} {ContentType} {ContentLength}",
-                                 request.Protocol,
-                                 request.Method,
-                                 request.Scheme,
-                                 request.Host.Value,
-                                 request.PathBase.Value,
-                                 request.Path.Value,
-                                 request.QueryString.Value,
-                                 request.ContentType ?? string.Empty,
-                                 request.ContentLength.HasValue ? request.ContentLength.ToString() : string.Empty);
-            }
+            var doesExceptionWrapped = false;
 
             //响应未开始，则包装响应
             if (!context.Response.HasStarted
@@ -148,6 +136,7 @@ public async Task InvokeAsync(HttpContext context)
                 if (response is not null)
                 {
                     await WriteResponseWithFormatterAsync(context, response);
+                    doesExceptionWrapped = true;
                 }
             }
             else //无法对响应进行包装，此时强制向上层抛出异常
@@ -159,6 +148,10 @@ public async Task InvokeAsync(HttpContext context)
             {
                 throw;
             }
+            else //不抛出异常时，触发回调
+            {
+                _middlewareExceptionCaptured(context.Request, ex, doesExceptionWrapped);
+            }
         }
         finally
         {
@@ -178,6 +171,31 @@ public async Task InvokeAsync(HttpContext context)
 
     #endregion Public 方法
 
+    #region Private 方法
+
+    /// <summary>
+    /// 记录中间件异常
+    /// </summary>
+    /// <param name="request">出现异常的请求</param>
+    /// <param name="exception">异常</param>
+    /// <param name="hasExceptionWrapped">异常是否已包装</param>
+    private void LogMiddlewareException(HttpRequest request, Exception exception, in bool hasExceptionWrapped)
+    {
+        //https://github.com/dotnet/aspnetcore/tree/8dd33378697e6f8ca89116170ec3046c185724b6/src/Hosting/Hosting/src/Internal/HostingRequestStartingLog.cs
+        _logger.LogError(exception, "Request error {Protocol} {Method} {Scheme}://{Host}{PathBase}{Path}{QueryString} {ContentType} {ContentLength}",
+                         request.Protocol,
+                         request.Method,
+                         request.Scheme,
+                         request.Host.Value,
+                         request.PathBase.Value,
+                         request.Path.Value,
+                         request.QueryString.Value,
+                         request.ContentType ?? string.Empty,
+                         request.ContentLength.HasValue ? request.ContentLength.ToString() : string.Empty);
+    }
+
+    #endregion Private 方法
+
     #region Internal
 
     private static MediaTypeCollection? CreateMediaTypeCollection(IList<MediaTypeHeaderValue> parsedAcceptValues)

src/Cuture.AspNetCore.ResponseAutoWrapper/ResponseAutoWrapMiddlewareOptions.cs

@@ -1,6 +1,6 @@
 using System;
 using System.Linq;
-
+using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc.Formatters;
 
 namespace Cuture.AspNetCore.ResponseAutoWrapper;
@@ -10,6 +10,18 @@ namespace Cuture.AspNetCore.ResponseAutoWrapper;
 /// </summary>
 public class ResponseAutoWrapMiddlewareOptions
 {
+    #region Public 委托
+
+    /// <summary>
+    /// 中间件异常已捕获
+    /// </summary>
+    /// <param name="request">出现异常的请求</param>
+    /// <param name="exception">异常</param>
+    /// <param name="doesExceptionWrapped">异常是否已包装</param>
+    public delegate void MiddlewareExceptionCaptured(HttpRequest request, Exception exception, in bool doesExceptionWrapped);
+
+    #endregion Public 委托
+
     #region Public 属性
 
     /// <summary>
@@ -32,6 +44,11 @@ public class ResponseAutoWrapMiddlewareOptions
     /// </summary>
     public bool IgnoreOptionsRequest { get; set; } = true;
 
+    /// <summary>
+    /// 在中间件已捕获异常时的回调
+    /// </summary>
+    public MiddlewareExceptionCaptured? OnMiddlewareExceptionCaptured { get; set; }
+
     /// <summary>
     /// 是否将捕获到的异常抛出给上层中间件<para/>
     /// default is <see langword="false"/>