Mapperly 项目中数组映射与只读属性的处理问题分析

问题背景

在 Riok.Mapperly 这个强大的 .NET 对象映射库中，开发者发现了一个关于数组类型映射和只读属性处理的特殊案例。当源对象包含数组类型属性，而目标对象中存在同名但为只读的属性时，Mapperly 生成的代码会出现编译错误。

问题重现

以一个卡片管理系统为例，我们有以下关键类结构：

源对象 (DTO)

public class CardTypeDto
{
    // 其他属性...
    public string[] RequiredRelationships { get; set; }
}

目标对象

public class CardType
{
    // 其他属性...
    public string[] RequiredRelationships
    {
        get
        {
            // 复杂的只读逻辑
            if (!IsAssessChargesAllowed) return null;
            if (DefaultChargeOption == "R")
                return [DefaultChargeRelationship];
            return ["CR1", "SV1", "SV2", "SV3"];
        }
    }
}

问题表现

当使用 Mapperly 进行映射时，会出现以下两种不同版本的表现：

版本 4.0.0 的问题

1. 生成了一个空的映射方法，导致编译错误

private static string?[] MapToStringArray(string?[] source)
{
    // 缺少实现体
}

2. 完全跳过了 RequiredRelationships 属性的映射

版本 3.5.1 的表现

1. 同样跳过了 RequiredRelationships 属性的映射
2. 但没有生成会导致编译错误的空方法

技术分析

这个问题的核心在于 Mapperly 如何处理目标对象的只读属性：

1. 属性可写性检查：Mapperly 在生成映射代码时，会检查目标属性的可写性。对于只读属性，理论上应该跳过映射。

2. 数组类型处理：当遇到数组类型时，Mapperly 会尝试生成专门的数组映射方法，即使这个属性最终不会被映射。

3. 版本差异：在 4.0.0 版本中，Mapperly 更积极地尝试生成数组映射方法，但没有正确处理只读属性的特殊情况，导致生成了不完整的方法。

解决方案

对于这类问题，开发者可以采用以下几种解决方案：

1. 显式忽略目标属性：使用 [MapperIgnoreTarget] 特性明确告诉 Mapperly 忽略特定的只读属性

[MapperIgnoreTarget(nameof(CardType.RequiredRelationships))]
private partial CardType Map(CardTypeDto dto);

2. 修改目标对象设计：如果业务允许，可以考虑将只读属性改为可写属性，或者使用不同的属性名称。

3. 自定义映射方法：对于复杂的映射逻辑，可以编写完整的手动映射方法替代自动生成。

最佳实践建议

1. 明确映射意图：对于包含只读属性的类，建议在映射配置中显式声明要忽略的属性。

2. 版本选择：如果项目中有大量类似情况，可以考虑暂时使用 3.5.1 版本以避免编译错误。

3. 代码审查：在升级 Mapperly 版本后，应该检查所有生成的映射代码，特别是处理集合类型和只读属性的部分。

总结

Mapperly 在处理数组类型和只读属性的组合时存在一定的边界情况，开发者需要了解这些特殊情况并采取适当的应对措施。通过显式配置或适当的目标对象设计，可以避免这类问题，确保生成的映射代码既正确又高效。

这个问题也提醒我们，在使用任何代码生成工具时，都应该仔细检查生成的代码，特别是在处理特殊场景时。对于重要的业务对象映射，编写单元测试验证映射行为也是十分必要的。