FastEndpoints项目中的全局异常处理与请求DTO捕获实践

引言

在FastEndpoints项目中，开发者经常需要处理API请求过程中的异常情况，并记录相关日志以便后续分析。本文将探讨如何在FastEndpoints框架中实现全局异常处理，并捕获请求DTO信息用于错误日志记录。

问题背景

在API开发中，异常处理是一个关键环节。开发者通常希望：

1. 捕获请求过程中发生的异常
2. 记录请求的具体内容（包括请求DTO）
3. 保持原有的异常处理流程不变

在FastEndpoints项目中，最初尝试使用.NET 7引入的IEndpointFilter接口来实现这一功能，但在实践中发现无法直接获取请求DTO对象。

解决方案演进

初始方案：IEndpointFilter尝试

最初尝试使用IEndpointFilter接口，类似于MediatR中的管道行为(IPipelineBehavior)：

public class PermissiveExceptionFilter : IEndpointFilter
{
    public async ValueTask<object?> InvokeAsync(EndpointFilterInvocationContext context, EndpointFilterDelegate next)
    {
        try
        {
            return await next(context);
        }
        catch (Exception exception)
        {
            var requestDto = context.GetArgument<BaseRequest>(0); // 尝试获取请求DTO
            // 记录错误日志...
            throw; // 保持原有异常处理
        }
    }
}

然而这种方法在FastEndpoints中无法直接获取到请求DTO对象。

最终方案：IGlobalPostProcessor实现

FastEndpoints提供了更合适的解决方案——使用IGlobalPostProcessor接口：

public class PermissiveExceptionPostProcessor : IGlobalPostProcessor
{
    public async Task PostProcessAsync(IPostProcessorContext context, CancellationToken ct)
    {
        if (!context.HasExceptionOccurred) return;
        
        if (context.Request is BaseRequest requestDto)
        {
            // 从DI容器解析所需服务
            var dbContext = context.HttpContext.Resolve<PostgresDbContext>();
            var errorLogRepository = context.HttpContext.Resolve<IGenericRepositoryBase<ErrorLog>>();
            
            try
            {
                var exception = context.ExceptionDispatchInfo.SourceException;
                var errorLog = new ErrorLog(timeProvider, requestDto, exception);
                await errorLogRepository.AddAsync(errorLog, ct);
                await dbContext.SaveChangesAsync(ct);
            }
            catch (Exception e)
            {
                logger.LogError(e, e.Message);
            }
        }
        
        context.ExceptionDispatchInfo.Throw();
    }
}

技术要点解析

1. 请求上下文访问：

   • 通过IPostProcessorContext可以访问完整的请求上下文
   • context.Request属性直接提供了请求DTO对象

2. 服务解析：

   • 使用context.HttpContext.Resolve()方法从DI容器获取所需服务
   • 避免了构造函数注入可能带来的循环依赖问题

3. 异常处理：

   • 通过HasExceptionOccurred判断是否有异常发生
   • ExceptionDispatchInfo提供了原始异常信息
   • 最后调用Throw()保持原有异常处理流程

4. 请求DTO处理：

   • 定义BaseRequest基类，所有请求DTO继承自它
   • 通过类型检查确保安全访问请求DTO

最佳实践建议

1. 处理器选择：

   • 在FastEndpoints中，优先考虑使用预处理器(PreProcessor)和后处理器(PostProcessor)
   • 仅在特定场景下使用IEndpointFilter

2. 日志记录设计：

   • 将请求DTO、异常信息和时间戳一起记录
   • 考虑使用结构化日志以便后续分析

3. 错误处理策略：

   • 保持原有异常处理流程不变(context.ExceptionDispatchInfo.Throw())
   • 内部错误处理使用try-catch块，避免影响主流程

4. 性能考虑：

   • 异步保存日志到数据库
   • 考虑使用后台队列处理非关键日志

总结

在FastEndpoints项目中实现全局异常处理和请求DTO捕获，使用IGlobalPostProcessor接口是最佳选择。这种方法不仅能够访问完整的请求上下文和DTO对象，还能与FastEndpoints的依赖注入系统良好集成。通过定义请求DTO基类和合理设计错误日志结构，可以构建出强大而灵活的异常处理系统。