FastEndpoints框架中如何实现必填查询参数验证

在Web API开发中，查询参数(Query Parameters)是常见的数据传递方式。FastEndpoints作为一款高效的.NET Web API框架，提供了灵活的请求参数绑定机制。本文将深入探讨如何在FastEndpoints中实现必填查询参数的验证。

查询参数绑定的基本用法

FastEndpoints默认提供了简洁的查询参数绑定方式。开发者只需在请求DTO的属性上添加[QueryParam]特性即可自动完成绑定：

public class MyRequest
{
    [QueryParam]
    public string Query { get; init; } = null!;
}

这种基础绑定方式虽然方便，但存在一个潜在问题：默认情况下，查询参数是可选的，即使客户端没有提供该参数，请求也能正常处理。

必填参数验证的需求场景

在实际业务中，某些查询参数是必须提供的。例如：

• 分页查询中的页码参数
• 排序字段参数
• 关键业务标识参数

FastEndpoints最初版本没有直接支持标记查询参数为必填的功能，这可能导致：

1. 业务逻辑错误：缺少必要参数仍能进入处理流程
2. 数据不一致：使用默认值代替实际业务值
3. 调试困难：难以追踪参数缺失问题

解决方案演进

初始方案：手动验证

早期版本中，开发者需要在端点处理程序中手动验证参数：

public override async Task HandleAsync(MyRequest req, CancellationToken ct)
{
    if(string.IsNullOrEmpty(req.Query))
    {
        AddError("Query参数是必填的");
        await SendErrorsAsync();
        return;
    }
    // 正常处理逻辑
}

这种方式虽然可行，但存在代码重复和维护成本高的问题。

进阶方案：FluentValidation集成

FastEndpoints集成了FluentValidation库，开发者可以创建验证器：

public class MyValidator : Validator<MyRequest>
{
    public MyValidator()
    {
        RuleFor(x => x.Query).NotEmpty();
    }
}

这种方法对于字符串类型参数有效，但对于值类型(bool/int等)存在局限性。例如，当查询参数为bool类型时，.NotEmpty()验证器会将false值也视为无效。

最终方案：IsRequired属性

FastEndpoints在v5.34.0.10-beta版本中引入了IsRequired属性，完美解决了上述问题：

public class MyRequest
{
    [QueryParam(IsRequired = true)]
    public bool Correct { get; set; }

    [RouteParam(IsRequired = true)]
    public int Count { get; set; }

    [FormField(IsRequired = true)]
    public Guid Id { get; set; }
}

这一改进具有以下优势：

1. 统一性：与其他绑定特性(如[FromBody])保持一致
2. 类型安全：在绑定阶段即进行验证，避免无效数据进入处理流程
3. 开发体验：简洁直观的声明式编程

实现原理

在底层实现上，FastEndpoints在参数绑定阶段会检查IsRequired标记。当参数为必填时：

1. 检查请求中是否包含指定参数
2. 验证参数值是否有效(非空且类型匹配)
3. 任一条件不满足即返回400 Bad Request响应

这种设计遵循了"快速失败"原则，在请求处理的最早阶段就拦截无效请求。

最佳实践

基于实际项目经验，建议：

1. 对于关键业务参数，始终使用IsRequired=true
2. 值类型参数优先使用IsRequired而非验证器
3. 字符串类型可以结合使用IsRequired和验证器实现更复杂的规则
4. 在API文档中明确标注必填参数

总结

FastEndpoints框架通过不断演进，提供了灵活且强大的参数验证机制。IsRequired属性的引入使得必填参数验证变得简单而直观，同时保持了框架的高性能特性。开发者现在可以更加自信地构建健壮的Web API，确保输入数据的完整性和正确性。