From 83ba492b37eeee1bcccd48f373c198348425f0f0 Mon Sep 17 00:00:00 2001 From: Developer 02 Date: Mon, 19 May 2025 13:27:37 +0200 Subject: [PATCH] Add global exception handling middleware Introduces `GlobalExceptionHandlerMiddleware` for managing exceptions in the request pipeline, logging them, and returning JSON error responses. A new project, `DigitalData.Core.Exceptions.Middleware`, is created to house this middleware and related classes. The `GlobalExceptionHandlerOptions` class allows for custom exception registration with specific HTTP status codes, while a new `HttpResponse` record encapsulates status codes and messages for structured responses. The middleware is registered in the `DependencyInjection` class for easy integration. --- .../DependencyInjection.cs | 12 ++++++++++++ .../DigitalData.Core.Exceptions.Middleware.csproj | 13 +++++++++++++ .../GlobalExceptionHandlerMiddleware.cs | 2 +- .../GlobalExceptionHandlerOptions.cs | 14 ++++++++++++++ .../HttpResponse.cs | 5 +++++ DigitalData.Core.sln | 12 +++++++++++- 6 files changed, 56 insertions(+), 2 deletions(-) create mode 100644 DigitalData.Core.Exceptions.Middleware/DependencyInjection.cs create mode 100644 DigitalData.Core.Exceptions.Middleware/DigitalData.Core.Exceptions.Middleware.csproj rename {DigitalData.Core.Exceptions => DigitalData.Core.Exceptions.Middleware}/GlobalExceptionHandlerMiddleware.cs (98%) create mode 100644 DigitalData.Core.Exceptions.Middleware/GlobalExceptionHandlerOptions.cs create mode 100644 DigitalData.Core.Exceptions.Middleware/HttpResponse.cs diff --git a/DigitalData.Core.Exceptions.Middleware/DependencyInjection.cs b/DigitalData.Core.Exceptions.Middleware/DependencyInjection.cs new file mode 100644 index 0000000..f6d0424 --- /dev/null +++ b/DigitalData.Core.Exceptions.Middleware/DependencyInjection.cs @@ -0,0 +1,12 @@ +using Microsoft.AspNetCore.Builder; + +namespace DigitalData.Core.Exceptions.Middleware; + +public static class DependencyInjection +{ + public static IApplicationBuilder UseGlobalExceptionHandler(this IApplicationBuilder app) + { + app.UseMiddleware(); + return app; + } +} diff --git a/DigitalData.Core.Exceptions.Middleware/DigitalData.Core.Exceptions.Middleware.csproj b/DigitalData.Core.Exceptions.Middleware/DigitalData.Core.Exceptions.Middleware.csproj new file mode 100644 index 0000000..01a4cb5 --- /dev/null +++ b/DigitalData.Core.Exceptions.Middleware/DigitalData.Core.Exceptions.Middleware.csproj @@ -0,0 +1,13 @@ + + + + net7.0;net8.0;net9.0 + enable + enable + + + + + + + diff --git a/DigitalData.Core.Exceptions/GlobalExceptionHandlerMiddleware.cs b/DigitalData.Core.Exceptions.Middleware/GlobalExceptionHandlerMiddleware.cs similarity index 98% rename from DigitalData.Core.Exceptions/GlobalExceptionHandlerMiddleware.cs rename to DigitalData.Core.Exceptions.Middleware/GlobalExceptionHandlerMiddleware.cs index 2e889d6..c775865 100644 --- a/DigitalData.Core.Exceptions/GlobalExceptionHandlerMiddleware.cs +++ b/DigitalData.Core.Exceptions.Middleware/GlobalExceptionHandlerMiddleware.cs @@ -1,4 +1,4 @@ -namespace DigitalData.Core.Exceptions; +namespace DigitalData.Core.Exceptions.Middleware; using Microsoft.AspNetCore.Http; using Microsoft.Extensions.Logging; diff --git a/DigitalData.Core.Exceptions.Middleware/GlobalExceptionHandlerOptions.cs b/DigitalData.Core.Exceptions.Middleware/GlobalExceptionHandlerOptions.cs new file mode 100644 index 0000000..239425b --- /dev/null +++ b/DigitalData.Core.Exceptions.Middleware/GlobalExceptionHandlerOptions.cs @@ -0,0 +1,14 @@ +using System.Net; + +namespace DigitalData.Core.Exceptions.Middleware; + +public class GlobalExceptionHandlerOptions +{ + private readonly Dictionary _registeredExceptions = new(); + + public GlobalExceptionHandlerOptions RegisterException(HttpStatusCode statusCode, string? message = null) where TException : Exception + { + _registeredExceptions[typeof(TException)] = new HttpResponse(statusCode, message); + return this; + } +} \ No newline at end of file diff --git a/DigitalData.Core.Exceptions.Middleware/HttpResponse.cs b/DigitalData.Core.Exceptions.Middleware/HttpResponse.cs new file mode 100644 index 0000000..37002ea --- /dev/null +++ b/DigitalData.Core.Exceptions.Middleware/HttpResponse.cs @@ -0,0 +1,5 @@ +using System.Net; + +namespace DigitalData.Core.Exceptions.Middleware; + +public record HttpResponse(HttpStatusCode StatusCode, string? Message = null); \ No newline at end of file diff --git a/DigitalData.Core.sln b/DigitalData.Core.sln index 7ae921e..c455d1c 100644 --- a/DigitalData.Core.sln +++ b/DigitalData.Core.sln @@ -41,6 +41,10 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Infrastructure", "Infrastru EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DigitalData.Core.Exceptions", "DigitalData.Core.Exceptions\DigitalData.Core.Exceptions.csproj", "{BAEF6CC9-4FE2-4E3F-9D32-911C9E8CCFB4}" EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DigitalData.Core.Exceptions.Middleware", "DigitalData.Core.Exceptions.Middleware\DigitalData.Core.Exceptions.Middleware.csproj", "{2336AE61-A21D-437E-A11B-367D008A64B2}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Exceptions", "Exceptions", "{8C3AF25D-81D9-4651-90CA-BF0BD2A03EA7}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -106,6 +110,10 @@ Global {BAEF6CC9-4FE2-4E3F-9D32-911C9E8CCFB4}.Debug|Any CPU.Build.0 = Debug|Any CPU {BAEF6CC9-4FE2-4E3F-9D32-911C9E8CCFB4}.Release|Any CPU.ActiveCfg = Release|Any CPU {BAEF6CC9-4FE2-4E3F-9D32-911C9E8CCFB4}.Release|Any CPU.Build.0 = Release|Any CPU + {2336AE61-A21D-437E-A11B-367D008A64B2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {2336AE61-A21D-437E-A11B-367D008A64B2}.Debug|Any CPU.Build.0 = Debug|Any CPU + {2336AE61-A21D-437E-A11B-367D008A64B2}.Release|Any CPU.ActiveCfg = Release|Any CPU + {2336AE61-A21D-437E-A11B-367D008A64B2}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE @@ -127,7 +135,9 @@ Global {C9266749-9504-4EA9-938F-F083357B60B7} = {72CBAFBA-55CC-49C9-A484-F8F4550054CB} {CE00E1F7-2771-4D9C-88FB-E564894E539E} = {41795B74-A757-4E93-B907-83BFF04EEE5C} {41795B74-A757-4E93-B907-83BFF04EEE5C} = {02EA681E-C7D8-13C7-8484-4AC65E1B71E8} - {BAEF6CC9-4FE2-4E3F-9D32-911C9E8CCFB4} = {02EA681E-C7D8-13C7-8484-4AC65E1B71E8} + {BAEF6CC9-4FE2-4E3F-9D32-911C9E8CCFB4} = {8C3AF25D-81D9-4651-90CA-BF0BD2A03EA7} + {2336AE61-A21D-437E-A11B-367D008A64B2} = {8C3AF25D-81D9-4651-90CA-BF0BD2A03EA7} + {8C3AF25D-81D9-4651-90CA-BF0BD2A03EA7} = {02EA681E-C7D8-13C7-8484-4AC65E1B71E8} EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {8E2C3187-F848-493A-9E79-56D20DDCAC94}