Mapster映射器中的继承属性类型转换问题解析

问题背景

在使用Mapster对象映射库时，开发人员可能会遇到一个特殊场景：当基类和派生类中都定义了同名但类型不同的属性时，映射过程会出现类型转换异常。这种设计模式在实际开发中并不少见，特别是在处理领域模型(Domain Model)和数据传输对象(DTO)之间的转换时。

典型场景分析

让我们通过一个典型示例来理解这个问题：

public abstract class DomBase {
    public DomPayment Payment { get; set; }
}

public class DomDerived : DomBase {
    public new DomDerivedPayment Payment {
        get => (DomDerivedPayment)base.Payment;
        set => base.Payment = (DomPayment)value;
    }
}

在这个设计中，DomBase类有一个DomPayment类型的Payment属性，而它的派生类DomDerived通过new关键字重新定义了Payment属性，将其类型改为DomDerivedPayment（DomDerivedPayment继承自DomPayment）。

问题表现

当使用Mapster进行映射时，会出现以下异常：

System.InvalidCastException: Unable to cast object of type 'DomPayment' to type 'DomDerivedPayment'

调试过程中发现，虽然属性的setter接收到了正确的派生类型值，但在getter被调用时，这个值被意外地转换为了基类类型，导致类型转换失败。

问题根源

这个问题的本质在于Mapster在处理继承层次结构中的属性映射时，对于使用new关键字隐藏的基类属性的处理不够智能。Mapster在映射过程中：

1. 首先识别到基类和派生类都有同名属性
2. 尝试直接进行属性值复制
3. 没有充分考虑属性类型之间的继承关系和转换逻辑

解决方案

方案一：使用AfterMapping回调

最直接的解决方案是在映射配置中使用AfterMapping回调手动处理特殊属性的映射：

config.NewConfig<DtoDerived, DomDerived>()
    .TwoWays()
    .AfterMapping((dto, dom) => dom.Payment = dto.Payment.Adapt<DomDerivedPayment>());

这种方法明确告诉Mapster在完成基础映射后，如何处理这个特殊属性。

方案二：自定义类型转换器

对于更复杂的情况，可以创建自定义的类型转换器：

config.NewConfig<DtoDerivedPayment, DomDerivedPayment>()
    .MapWith(src => new DomDerivedPayment {
        Prop = src.Prop,
        Test = src.Test
    });

方案三：重构模型设计

从根本上说，可以考虑重构模型设计，避免使用new关键字隐藏基类属性。例如：

public class DomDerived : DomBase {
    public DomDerivedPayment DerivedPayment {
        get => (DomDerivedPayment)Payment;
        set => Payment = value;
    }
}

这样设计更清晰，也更容易被映射工具处理。

最佳实践建议

1. 避免过度使用属性隐藏：虽然C#允许使用new关键字隐藏基类成员，但这会增加代码的复杂性和潜在的混淆。

2. 明确映射配置：对于复杂的继承层次结构，应该为每个特殊情况编写明确的映射配置。

3. 考虑使用接口：使用接口而非继承来定义公共契约，可以减少这类映射问题。

4. 单元测试保障：为所有映射场景编写单元测试，确保映射行为的正确性。

总结

Mapster作为一款优秀的对象映射库，在大多数场景下都能很好地工作。但在处理复杂的继承关系和属性隐藏时，需要开发者提供额外的配置指导。理解这些边界情况并掌握相应的解决方案，可以帮助开发者更高效地使用Mapster进行对象映射工作。

当遇到类似问题时，开发者应该首先分析模型设计的合理性，然后根据具体情况选择最合适的解决方案，无论是通过回调函数、自定义映射器还是模型重构。