FastEndpoints项目中EmptyRequest的设计考量与使用建议

关于EmptyRequest的设计背景

在FastEndpoints框架中，EmptyRequest被设计为一个结构体(struct)而非类(class)，这是经过性能基准测试后的慎重选择。开发团队通过实际测试发现，使用结构体在处理空请求时具有更好的性能表现。这种设计决策体现了框架对高性能的追求。

当前版本的使用限制

由于EmptyRequest被定义为结构体，在C#语言中结构体不能被继承。这意味着开发者无法像最初设想的那样创建类似public class HelloRequest : EmptyRequest{}这样的派生类。同样，直接使用记录类型(record)作为空请求也存在一定限制。

解决方案与替代方案

从FastEndpoints v5.23.0.9-beta版本开始，框架提供了更灵活的配置选项。开发者可以通过以下方式启用空请求DTO的支持：

app.UseFastEndpoints(c => c.Endpoints.AllowEmptyRequestDtos = true)

启用此选项后，开发者可以直接使用空的记录类型作为请求DTO：

sealed record HelloRequest;

sealed class MyEndpoint : Endpoint<HelloRequest>
{
    public override void Configure()
    {
        Post("test");
        Description(x => x.ClearDefaultAccepts()); // 对于POST请求需要此配置
        AllowAnonymous();
    }
}

技术细节说明

1. 性能考量：结构体在栈上分配，避免了堆内存分配和垃圾回收的开销，这对于高频调用的端点处理程序尤为重要。

2. POST请求的特殊处理：当使用空记录作为POST请求的DTO时，需要调用ClearDefaultAccepts()方法，这是因为框架默认会期望请求体包含某些内容。

3. 版本兼容性：此功能从v5.23.0.9-beta版本开始提供，使用前需确保项目引用了足够新的框架版本。

最佳实践建议

1. 对于确实不需要任何请求参数的端点，优先考虑使用框架提供的EmptyRequest结构体。

2. 当需要语义化的空请求类型时，可以使用空记录，但要注意性能影响。

3. 在性能敏感的场景中，建议进行基准测试比较两种方式的差异。

4. 保持请求类型的密封(sealed)可以带来微小的性能提升并防止意外的类型扩展。

通过理解框架背后的设计理念和提供的配置选项，开发者可以在保持代码清晰性的同时，充分利用FastEndpoints框架的高性能特性。