Refactor DIExtensions and add exception handling middleware
- Improved documentation in DIExtensions.cs for clarity. - Added project reference to DigitalData.Core.Exceptions. - Updated solution file to include DigitalData.Core.Exceptions. - Introduced ExceptionHandlingMiddleware for global exception handling. - Added BadRequestException and NotFoundException classes. - Created DigitalData.Core.Exceptions project with .NET 7.0, 8.0, and 9.0 support.
This commit is contained in:
Developer 02
@@ -1,53 +1,50 @@
|
||||
using Microsoft.AspNetCore.Builder;
|
||||
using System.Configuration;
|
||||
namespace DigitalData.Core.API;
|
||||
|
||||
namespace DigitalData.Core.API
|
||||
/// <summary>
|
||||
/// Provides extension methods for adding middleware to the application's request pipeline.
|
||||
/// </summary>
|
||||
public static class DIExtensions
|
||||
{
|
||||
/// <summary>
|
||||
/// Provides extension methods for adding middleware to the application's request pipeline.
|
||||
/// Adds the <see cref="CSPMiddleware"/> to the application's request pipeline to include
|
||||
/// Content Security Policy (CSP) headers in the HTTP response.
|
||||
/// </summary>
|
||||
public static class DIExtensions
|
||||
{
|
||||
/// <summary>
|
||||
/// Adds the <see cref="CSPMiddleware"/> to the application's request pipeline to include
|
||||
/// Content Security Policy (CSP) headers in the HTTP response.
|
||||
/// </summary>
|
||||
/// <param name="app">The application builder.</param>
|
||||
/// <param name="policy">
|
||||
/// The CSP policy string with placeholders. The first format parameter {0} will be replaced
|
||||
/// by the nonce value.
|
||||
/// </param>
|
||||
/// <returns>The application builder with the CSP middleware added.</returns>
|
||||
public static IApplicationBuilder UseCSPMiddleware(this IApplicationBuilder app, string policy)
|
||||
=> app.UseMiddleware<CSPMiddleware>(policy);
|
||||
/// <param name="app">The application builder.</param>
|
||||
/// <param name="policy">
|
||||
/// The CSP policy string with placeholders. The first format parameter {0} will be replaced
|
||||
/// by the nonce value.
|
||||
/// </param>
|
||||
/// <returns>The application builder with the CSP middleware added.</returns>
|
||||
public static IApplicationBuilder UseCSPMiddleware(this IApplicationBuilder app, string policy)
|
||||
=> app.UseMiddleware<CSPMiddleware>(policy);
|
||||
|
||||
/// <summary>
|
||||
/// Checks if the DiP (Development in Production) mode is enabled for the WebApplicationBuilder.
|
||||
/// </summary>
|
||||
/// <param name="builder">The WebApplicationBuilder instance.</param>
|
||||
/// <returns>True if DiP mode is enabled; otherwise, false.</returns>
|
||||
public static bool IsDiP(this WebApplicationBuilder builder) => builder.Configuration.GetValue<bool>("DiPMode");
|
||||
/// <summary>
|
||||
/// Checks if the DiP (Development in Production) mode is enabled for the WebApplicationBuilder.
|
||||
/// </summary>
|
||||
/// <param name="builder">The WebApplicationBuilder instance.</param>
|
||||
/// <returns>True if DiP mode is enabled; otherwise, false.</returns>
|
||||
public static bool IsDiP(this WebApplicationBuilder builder) => builder.Configuration.GetValue<bool>("DiPMode");
|
||||
|
||||
/// <summary>
|
||||
/// Checks if the DiP (Development in Production) mode is enabled for the WebApplication.
|
||||
/// </summary>
|
||||
/// <param name="app">The WebApplication instance.</param>
|
||||
/// <returns>True if DiP mode is enabled; otherwise, false.</returns>
|
||||
public static bool IsDiP(this WebApplication app) => app.Configuration.GetValue<bool>("DiPMode");
|
||||
/// <summary>
|
||||
/// Checks if the DiP (Development in Production) mode is enabled for the WebApplication.
|
||||
/// </summary>
|
||||
/// <param name="app">The WebApplication instance.</param>
|
||||
/// <returns>True if DiP mode is enabled; otherwise, false.</returns>
|
||||
public static bool IsDiP(this WebApplication app) => app.Configuration.GetValue<bool>("DiPMode");
|
||||
|
||||
/// <summary>
|
||||
/// Checks if the environment is Development or DiP (Development in Production) mode is enabled for the WebApplicationBuilder.
|
||||
/// </summary>
|
||||
/// <param name="builder">The WebApplicationBuilder instance.</param>
|
||||
/// <returns>True if the environment is Development or DiP mode is enabled; otherwise, false.</returns>
|
||||
public static bool IsDevOrDiP(this WebApplicationBuilder builder) => builder.Environment.IsDevelopment() || builder.IsDiP();
|
||||
/// <summary>
|
||||
/// Checks if the environment is Development or DiP (Development in Production) mode is enabled for the WebApplicationBuilder.
|
||||
/// </summary>
|
||||
/// <param name="builder">The WebApplicationBuilder instance.</param>
|
||||
/// <returns>True if the environment is Development or DiP mode is enabled; otherwise, false.</returns>
|
||||
public static bool IsDevOrDiP(this WebApplicationBuilder builder) => builder.Environment.IsDevelopment() || builder.IsDiP();
|
||||
|
||||
/// <summary>
|
||||
/// Checks if the environment is Development or DiP (Development in Production) mode is enabled for the WebApplication.
|
||||
/// </summary>
|
||||
/// <param name="app">The WebApplication instance.</param>
|
||||
/// <returns>True if the environment is Development or DiP mode is enabled; otherwise, false.</returns>
|
||||
public static bool IsDevOrDiP(this WebApplication app) => app.Environment.IsDevelopment() || app.IsDiP();
|
||||
/// <summary>
|
||||
/// Checks if the environment is Development or DiP (Development in Production) mode is enabled for the WebApplication.
|
||||
/// </summary>
|
||||
/// <param name="app">The WebApplication instance.</param>
|
||||
/// <returns>True if the environment is Development or DiP mode is enabled; otherwise, false.</returns>
|
||||
public static bool IsDevOrDiP(this WebApplication app) => app.Environment.IsDevelopment() || app.IsDiP();
|
||||
|
||||
/// <summary>
|
||||
/// Configures the services with options from the specified section of the appsettings.json file.
|
||||
@@ -65,5 +62,4 @@ namespace DigitalData.Core.API
|
||||
builder.Services.Configure<T>(section);
|
||||
return builder;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -33,6 +33,7 @@
|
||||
|
||||
<ItemGroup>
|
||||
<ProjectReference Include="..\DigitalData.Core.Application\DigitalData.Core.Application.csproj" />
|
||||
<ProjectReference Include="..\DigitalData.Core.Exceptions\DigitalData.Core.Exceptions.csproj" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
|
||||
84
DigitalData.Core.API/ExceptionHandlingMiddleware.cs
Normal file
84
DigitalData.Core.API/ExceptionHandlingMiddleware.cs
Normal file
@@ -0,0 +1,84 @@
|
||||
namespace DigitalData.Core.API;
|
||||
|
||||
using DigitalData.Core.Exceptions;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Microsoft.Extensions.Logging;
|
||||
using System.Net;
|
||||
using System.Text.Json;
|
||||
|
||||
/// <summary>
|
||||
/// Middleware for handling exceptions globally in the application.
|
||||
/// Captures exceptions thrown during the request pipeline execution,
|
||||
/// logs them, and returns an appropriate HTTP response with a JSON error message.
|
||||
/// </summary>
|
||||
public class ExceptionHandlingMiddleware
|
||||
{
|
||||
private readonly RequestDelegate _next;
|
||||
private readonly ILogger<ExceptionHandlingMiddleware> _logger;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="ExceptionHandlingMiddleware"/> class.
|
||||
/// </summary>
|
||||
/// <param name="next">The next middleware in the request pipeline.</param>
|
||||
/// <param name="logger">The logger instance for logging exceptions.</param>
|
||||
public ExceptionHandlingMiddleware(RequestDelegate next, ILogger<ExceptionHandlingMiddleware> logger)
|
||||
{
|
||||
_next = next;
|
||||
_logger = logger;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Invokes the middleware to handle the HTTP request.
|
||||
/// </summary>
|
||||
/// <param name="context">The HTTP context of the current request.</param>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
public async Task InvokeAsync(HttpContext context)
|
||||
{
|
||||
try
|
||||
{
|
||||
await _next(context); // Continue down the pipeline
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
await HandleExceptionAsync(context, ex, _logger);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Handles exceptions by logging them and writing an appropriate JSON response.
|
||||
/// </summary>
|
||||
/// <param name="context">The HTTP context of the current request.</param>
|
||||
/// <param name="exception">The exception that occurred.</param>
|
||||
/// <param name="logger">The logger instance for logging the exception.</param>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
private static async Task HandleExceptionAsync(HttpContext context, Exception exception, ILogger logger)
|
||||
{
|
||||
context.Response.ContentType = "application/json";
|
||||
|
||||
string message;
|
||||
|
||||
switch (exception)
|
||||
{
|
||||
case BadRequestException badRequestEx:
|
||||
context.Response.StatusCode = (int)HttpStatusCode.BadRequest;
|
||||
message = badRequestEx.Message;
|
||||
break;
|
||||
|
||||
case NotFoundException notFoundEx:
|
||||
context.Response.StatusCode = (int)HttpStatusCode.NotFound;
|
||||
message = notFoundEx.Message;
|
||||
break;
|
||||
|
||||
default:
|
||||
logger.LogError(exception, "Unhandled exception occurred.");
|
||||
context.Response.StatusCode = (int)HttpStatusCode.InternalServerError;
|
||||
message = "An unexpected error occurred.";
|
||||
break;
|
||||
}
|
||||
|
||||
await context.Response.WriteAsync(JsonSerializer.Serialize(new
|
||||
{
|
||||
message
|
||||
}));
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user