如何解决MassTransit反序列化多态属性时出现的类型不兼容问题

问题根因 #

报错的核心原因是MassTransit默认会为用作消息契约的接口类型自动生成GreenPipes动态代理类，你响应中PaymentMethods属性的类型是IPaymentMethod接口，反序列化时MassTransit默认尝试将JSON内容映射到自动生成的GreenPipes.DynamicInternal.Models\+Messages.Models\+IPaymentMethod代理类，和你JSON中$type指定的实际实现类CreditCard/PayPal类型不匹配，所以抛出兼容错误。

解决方案 #

方案1（最推荐）：禁用指定接口的动态代理生成 #

直接告诉MassTransit不要为IPaymentMethod接口生成动态代理，反序列化时会直接使用JSON中$type指定的实际实现类实例化，完全匹配你的序列化输出。
在消费端程序启动时、总线配置前添加如下代码即可：

// 禁用IPaymentMethod接口的动态代理生成
MassTransit.MessageTypeCache.DisableTypeGenerator<Models.IPaymentMethod>();

如果有多个多态接口，依次调用该方法禁用即可。

方案2：改用抽象基类替代接口作为属性类型 #

MassTransit不会为抽象类生成动态代理，你可以将IPaymentMethod从接口改为抽象记录类，原有实现逻辑无需大幅调整：

public abstract record PaymentMethod
{
    public Guid Id { get; init; }
    public decimal Amount { get; init; }
}

public record CreditCard : PaymentMethod
{
    [property: JsonConverter(typeof(ExpirationDateOnlyJsonConverter))]
    public DateOnly Expiration { get; init; }
    public string HolderName { get; init; }
    public string Number { get; init; }
    public string SecurityNumber { get; init; }
}

public record PayPal : PaymentMethod
{
    public string UserName { get; init; }
    public string Password { get; init; }
}

// 响应类同步修改
public record CartDetails : Response
{
    public IEnumerable<PaymentMethod> PaymentMethods { get; init; }
    // 其余属性不变
}

方案3：自定义序列化绑定器（适配复杂场景） #

如果不能修改原有接口定义，也可以自定义Newtonsoft的序列化绑定器，将动态代理类型映射到你的实际实现类：

public class CustomSerializationBinder : ISerializationBinder
{
    private readonly DefaultSerializationBinder _default = new DefaultSerializationBinder();

    public Type BindToType(string assemblyName, string typeName)
    {
        // 替换动态代理类型为实际接口类型
        if (typeName.Contains("GreenPipes.DynamicInternal") && typeName.Contains("IPaymentMethod"))
        {
            return typeof(Models.IPaymentMethod);
        }
        return _default.BindToType(assemblyName, typeName);
    }

    public void BindToName(Type serializedType, out string assemblyName, out string typeName)
    {
        _default.BindToName(serializedType, out assemblyName, out typeName);
    }
}

然后在消费端反序列化配置中注册该绑定器：

bus.ConfigureJsonDeserializer(settings =>
{
    settings.TypeNameHandling = TypeNameHandling.Objects;
    settings.SerializationBinder = new CustomSerializationBinder();
    return settings;
});

补充配置校验 #

1. 确保发布端和消费端的TypeNameHandling配置完全一致，推荐统一使用TypeNameHandling.Auto减少冗余$type输出
2. 确保所有IPaymentMethod的实现类在消费端都可以访问，程序集版本、命名空间完全和发布端一致
3. 移除之前加在PaymentMethods属性上的[JsonProperty(TypeNameHandling = TypeNameHandling.Objects)]特性，避免和全局配置冲突导致$type丢失

内容的提问来源于stack exchange，提问作者Antônio Falcão Jr.