FastEndpoints项目中的全局响应包装器实现指南

引言

在Web API开发中，统一响应格式是一个常见的需求。FastEndpoints作为一个高效的.NET Web API框架，提供了灵活的机制来实现全局响应包装。本文将详细介绍如何在FastEndpoints项目中实现一个全局的API响应包装器，统一处理成功和失败的响应格式。

响应包装的必要性

统一API响应格式有以下优势：

1. 前端处理更一致，减少适配代码
2. 便于错误信息的统一传递
3. 提高API的可维护性和可扩展性
4. 标准化API文档

实现方案

基础配置

首先需要在项目启动时进行基础配置：

var builder = WebApplication.CreateBuilder(args);
builder.Services
   .AddFastEndpoints()
   .SwaggerDocument();

var app = builder.Build();
app.UseFastEndpoints(c => {
    c.Endpoints.Configurator = ep => {
        ep.DontAutoSendResponse();
        ep.PostProcessor<ResponseSender>(Order.Before);
        ep.AllowAnonymous();
    };
})
.UseSwaggerGen();
app.Run();

关键点说明：

1. DontAutoSendResponse()：禁用自动发送响应，让我们可以自定义响应格式
2. 注册全局后处理器ResponseSender，并设置为最先执行
3. 根据需要设置匿名访问

响应包装器实现

响应包装器需要实现IGlobalPostProcessor接口：

public class ResponseSender : IGlobalPostProcessor
{
    public async Task PostProcessAsync(IPostProcessorContext ctx, CancellationToken ct)
    {
        if (ctx.HttpContext.ResponseStarted())
            throw new InvalidOperationException("响应已开始，无法修改");
            
        if (ctx.ValidationFailures.Count > 0)
            await ctx.HttpContext.Response.SendAsync(new ApiResponse<object>(ctx.ValidationFailures));
        else
            await ctx.HttpContext.Response.SendAsync(new ApiResponse<object>(ctx.Response));
    }
}

统一响应模型

定义统一的API响应模型：

public class ApiResponse<TData>
{
    public bool Success => Data != null && !Errors.Any();
    public IEnumerable<ApiResponseError> Errors { get; } = [];
    public TData? Data { get; }

    public ApiResponse(TData data)
    {
        Data = data;
    }

    public ApiResponse(IReadOnlyCollection<ValidationFailure> failures)
    {
        Errors = failures.Select(f => new ApiResponseError(f.PropertyName, f.ErrorMessage));
    }
}

public class ApiResponseError(string name, string reason)
{
    public string Name { get; set; } = name;
    public string Reason { get; set; } = reason;
}

端点实现示例

端点实现时需要注意：

[HttpGet("example")]
public class ExampleEndpoint : Endpoint<MyRequest, ApiResponse<MyData>>
{
    public override async Task HandleAsync(MyRequest req, CancellationToken ct)
    {
        await Task.CompletedTask;

        if (req.IsValid)
        {
            Response = new MyData { Message = "处理成功" };
        }
        else
        {
            AddError(r => r.Field, "错误信息");
        }
    }
}

重要注意事项：

1. 不要使用ThrowError方法，因为它会直接写入响应流
2. 使用AddError方法添加验证错误
3. 直接设置Response属性，包装器会自动处理

高级技巧

隐式转换简化代码

可以在ApiResponse中添加隐式转换操作符：

public static implicit operator ApiResponse<TData>(TData data)
    => new(data);

这样端点中可以更简洁地设置响应：

Response = new MyData { Message = "处理成功" };

自定义错误处理

可以扩展ApiResponse类来支持更多错误场景：

public ApiResponse(Exception ex)
{
    Errors = [new ApiResponseError("System", ex.Message)];
}

最佳实践

1. 保持响应模型简单明了
2. 错误信息应当对用户友好
3. 考虑添加请求追踪ID便于调试
4. 文档化你的API响应格式
5. 考虑添加API版本信息

总结

通过FastEndpoints的全局后处理器机制，我们可以优雅地实现API响应格式的统一包装。这种方法不仅保持了代码的整洁性，还提供了极大的灵活性。关键在于正确配置端点的响应发送行为，并合理设计响应包装模型。

这种实现方式特别适合中大型项目，可以显著提高API的一致性和可维护性，同时为前端开发提供更友好的接口。