‫مدیریت خطاها در MediatR با استفاده از Pipeline Behaviors و IRequestExceptionHandler

public class MyRequestHandler : IRequestHandler<MyRequest, string>
{
    public Task<string> Handle(MyRequest request, CancellationToken cancellationToken)
    {
        if (string.IsNullOrEmpty(request.Input))
            return Task.FromResult("Input cannot be empty");

        throw new InvalidOperationException("An unexpected error occurred during processing.");

        return Task.FromResult($"Processed: {request.Input}");
    }
}

public class ExceptionHandlingBehavior<TRequest, TResponse>
    : IPipelineBehavior<TRequest, TResponse>
{
    private readonly ILogger<ExceptionHandlingBehavior<TRequest, TResponse>> _logger;

    public ExceptionHandlingBehavior(ILogger<ExceptionHandlingBehavior<TRequest, TResponse>> logger)
    {
        _logger = logger;
    }

    public async Task<TResponse> Handle(TRequest request, RequestHandlerDelegate<TResponse> next, CancellationToken cancellationToken)
    {
        try
        {
            return await next();
        }
        catch (Exception ex)
        {
            // Log the exception details
            _logger.LogError(ex, "An error occurred while handling request {Request}", typeof(TRequest).Name);

            // Return a custom response indicating an error occurred
            return CreateErrorResponse<TResponse>("An unexpected error occurred. Please try again later.");
        }
    }

    private TResponse CreateErrorResponse<TResponse>(string errorMessage)
    {
        // You can customize this method to return a specific type of error response
        // For example, a DTO object with error details
        var errorResponse = new
        {
            Success = false,
            ErrorMessage = errorMessage
        };

        // Assuming TResponse can be implicitly cast or converted to the type of errorResponse
        // Replace the return statement below with the appropriate casting logic
        return (TResponse)Convert.ChangeType(errorResponse, typeof(TResponse));
    }
}

services.AddTransient(typeof(IPipelineBehavior<,>), typeof(ExceptionHandlingBehavior<,>));

public class SpecificRequest : IRequest<string>
{
    public int Number { get; set; }
}

public class SpecificRequestHandler : IRequestHandler<SpecificRequest, string>
{
    public Task<string> Handle(SpecificRequest request, CancellationToken cancellationToken)
    {
        if (request.Number < 0)
            throw new ArgumentOutOfRangeException("Number cannot be negative!");

        return Task.FromResult($"Number is {request.Number}");
    }
}

public class SpecificRequestExceptionHandler : IRequestExceptionHandler<SpecificRequest, string>
{
    public Task Handle(SpecificRequest request, Exception exception, RequestExceptionHandlerState<string> state, CancellationToken cancellationToken)
    {
        if (exception is ArgumentOutOfRangeException)
        {
            state.SetHandled("The provided number is invalid.");
        }
        else
        {
            state.SetHandled("An unexpected error occurred.");
        }

        return Task.CompletedTask;
    }
}

services.AddTransient(typeof(IRequestExceptionHandler<,>), typeof(SpecificRequestExceptionHandler));

• وظیفه: در ابتدا، درخواست‌ها از طریق IPipelineBehaviorها پردازش می‌شوند. این رفتارها وظیفه دارند که استثنائات عمومی مانند ArgumentNullException, InvalidOperationException را مدیریت کنند و تصمیم بگیرند که آیا باید پردازش درخواست ادامه یابد یا خیر.

• مثال: LoggingBehavior یکی از این رفتارها است که لاگ درخواست‌ها و استثنائات را در سطح عمومی مدیریت می‌کند.

public class LoggingBehavior<TRequest, TResponse> : IPipelineBehavior<TRequest, TResponse>
{
    private readonly ILogger<LoggingBehavior<TRequest, TResponse>> _logger;

    public LoggingBehavior(ILogger<LoggingBehavior<TRequest, TResponse>> logger)
    {
        _logger = logger;
    }

    public async Task<TResponse> Handle(TRequest request, RequestHandlerDelegate<TResponse> next, CancellationToken cancellationToken)
    {
        _logger.LogInformation($"Handling request: {typeof(TRequest).Name}");

        try
        {
            var response = await next();
            _logger.LogInformation($"Handled request: {typeof(TRequest).Name}");

            return response;
        }
        catch (Exception ex)
        {
            _logger.LogError(ex, $"Exception in {typeof(TRequest).Name}: {ex.Message}");
            throw; // Rethrow exception to be handled by IRequestExceptionHandler if not handled here
        }
    }
}

• وظیفه: پس از اینکه Pipeline Behaviors درخواست را پردازش کردند، اگر خطایی رخ دهد که در آن مرحله مدیریت نشده باشد، مسئولیت مدیریت آن به IRequestExceptionHandler واگذار می‌شود. این قسمت از سیستم به صورت تخصصی روی استثنائات خاص مانند ArgumentNullException, InvalidOperationException و سایر خطاهای غیرمنتظره کار می‌کند.

• مثال: MyRequestExceptionHandler مسئولیت مدیریت استثنائات خاصی را بر عهده دارد و بر اساس نوع استثنا یک پاسخ مناسب ایجاد می‌کند.

public class MyRequestExceptionHandler : IRequestExceptionHandler<MyRequest, string, Exception>
{
    public Task Handle(MyRequest request, Exception exception, RequestExceptionHandlerState<string> state, CancellationToken cancellationToken)
    {
        var response = exception switch
        {
            ArgumentNullException => "Required value is missing.",
            InvalidOperationException => "Invalid operation.",
            _ => "Unexpected error occurred."
        };

        state.SetHandled(response);
        return Task.CompletedTask;
    }
}

• وظیفه: پس از اینکه درخواست از IRequestExceptionHandler عبور کرد، اگر همچنان استثنای رخ داده باشد که قابل مدیریت نبوده است، درخواست به Middlewareهای پیاده‌سازی‌شده برای مدیریت استثنائات فرستاده می‌شود. این Middlewareها معمولاً برای ارسال پاسخ‌های استاندارد به کاربران طراحی شده‌اند.

• مثال: ExceptionHandlingMiddleware مسئول ارسال پاسخ به کاربر است که توضیح دهد چه اتفاقی افتاده است.

public class ExceptionHandlingMiddleware
{
    private readonly RequestDelegate _next;
    private readonly ILogger<ExceptionHandlingMiddleware> _logger;

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

    public async Task InvokeAsync(HttpContext context)
    {
        try
        {
            await _next(context);
        }
        catch (Exception ex)
        {
            _logger.LogError(ex, "An unexpected error occurred.");
            context.Response.StatusCode = StatusCodes.Status500InternalServerError;
            await context.Response.WriteAsync("An unexpected error occurred.");
        }
    }
}

• ابتدا درخواست از طریق IPipelineBehaviorها پردازش می‌شود. هر Pipeline Behavior یک وظیفه عمومی را بر عهده دارد، مثلاً لاگ‌کردن درخواست‌ها، اعتبارسنجی ورودی‌ها یا مدیریت استثنائات عمومی.
• اگر در طول این مرحله خطایی رخ دهد، LoggingBehavior آن را لاگ کرده و تصمیم می‌گیرد که درخواست را ادامه دهد یا متوقف کند.
• اگر خطایی رخ دهد و LoggingBehavior نتواند آن را مدیریت کند، درخواست به IRequestExceptionHandler فرستاده می‌شود.

• پس از اجرای Pipeline Behaviors، اینترفیس IRequestExceptionHandler برای مدیریت استثنائات خاص فراخوانی می‌شود.
• اگر خطای رخ داده به Pipeline Behaviors مدیریت نشده باشد، MyRequestExceptionHandler نوع خاصی از استثنائات مانند ArgumentNullException یا InvalidOperationException را مدیریت کرده و یک پیام خطا مناسب تولید می‌کند.
• اگر IRequestExceptionHandler نیز نتواند خطا را مدیریت کند، درخواست به Middlewareهای پیاده‌سازی‌شده برای مدیریت استثناها واگذار می‌شود.

• اگر IRequestExceptionHandler نیز نتواند خطا را مدیریت کند، درخواست به Middlewareها ارسال می‌شود.
• این Middlewareها معمولاً به صورت یک لایه اضافی برای ارسال پاسخ‌های استاندارد به کاربر عمل می‌کنند.
• ExceptionHandlingMiddleware می‌تواند پاسخ‌های HTTP مانند 500 Internal Server Error را برگرداند و جزئیات استثنا را در لاگ‌ها ثبت کند.