FastEndpoints项目中处理多态请求绑定的实践指南

在FastEndpoints项目中，开发者经常会遇到需要处理多态请求绑定的场景。本文将深入探讨如何正确实现这一功能，并分析常见问题的解决方案。

多态请求绑定的基本实现

FastEndpoints框架基于System.Text.Json(STJ)进行请求反序列化，支持通过JsonDerivedType特性实现多态绑定。标准实现方式如下：

[JsonDerivedType(typeof(CreateEmailChannel), typeDiscriminator: nameof(CreateEmailChannel))]
[JsonDerivedType(typeof(CreateSmsChannel), typeDiscriminator: nameof(CreateSmsChannel))]
[JsonDerivedType(typeof(CreatePushChannel), typeDiscriminator: nameof(CreatePushChannel))]
public record CreateChannelRequestBase
{
    public required Guid Id { get; init; }
    public required string Name { get; init; }
}

public record CreateEmailChannel : CreateChannelRequestBase
{
    public required string Email { get; init; }
}

常见问题与解决方案

抽象基类问题

当基类标记为abstract时，STJ无法直接实例化基类，导致反序列化失败。解决方案有两种：

1. 移除abstract修饰符：这是最简单的解决方案，适用于大多数场景

2. 使用自定义绑定器：当必须保留abstract修饰符时，可以实现自定义绑定逻辑

internal class CreateChannel : Endpoint<CreateChannelRequestBase, Result<NotificationChannelDtoBase>>
{
    public override void Configure()
    {
        Post("/users/me/NotificationChannels");
        RequestBinder(binder: new PolymorphicRequestBinder());
    }
}

类型鉴别器配置

确保JsonDerivedType特性正确配置了类型鉴别器。鉴别器值应当唯一且易于识别：

[JsonDerivedType(typeof(CreateEmailChannel), typeDiscriminator: "email")]
[JsonDerivedType(typeof(CreateSmsChannel), typeDiscriminator: "sms")]

最佳实践建议

1. 避免抽象基类：除非有特殊需求，否则建议使用普通基类

2. 明确类型鉴别器：使用简洁明了的鉴别器值

3. 测试验证：编写单元测试验证各种子类型的反序列化

4. 考虑包装模式：对于复杂场景，可以使用包装类模式

public class ChannelCreationRequest
{
    [FromBody]
    public CreateChannelRequestBase ChannelData { get; set; }
    
    [FromQuery]
    public string AdditionalParam { get; set; }
}

通过遵循这些实践，开发者可以充分利用FastEndpoints框架的多态请求绑定能力，构建更加灵活和强大的API端点。