ASP.NET Core 8 Web API中Mapster无法扁平化对象映射问题

问题场景 #

在ASP.NET Core 8 Web API中使用Mapster将Tenant实体转换为TenantQueryDTO时，DTO中的地址相关字段（如AddressLine1）未被填充。

相关代码 #

实体与DTO定义 #

public class Tenant : BaseEntity
{
    public Tenant()
    {
        Address = new Address();
    }

    public string TenantName { get; set; }
    public string Email { get; set; }
    public Address Address { get; set; }
}

public class TenantQueryDTO
{
    public string Description { get; set; }
    public string Email { get; set; }
    public string Phone { get; set; }
    public string Name { get; set; }
    public string AddressLine1 { get; set; }
    public string AddressLine2 { get; set; }
    public string City { get; set; }
    public string State { get; set; }
    public string Zip { get; set; }
    public object Id { get; internal set; }
}

映射调用代码 #

public async Task<List<TenantQueryDTO>> Get(CancellationToken cancellationToken)
{
    var data = await repository.GetAllAsync(cancellationToken);
    return _mapper.Map<List<TenantQueryDTO>>(data); // 地址信息未填充
}

映射配置 #

static void MapTenantAndAddressDTO()
{
    TypeAdapterConfig<Tenant, TenantQueryDTO>
           .NewConfig()
           .Map(dest => dest.Id, src => src.Id)
           .Map(dest => dest.Name, src => src.TenantName)
           .Map(dest => dest.AddressLine1, src => src.Address.AddressLine1)
           .TwoWays();
}

排查与解决步骤 #

1. 确认映射配置已被执行 #

Mapster的自定义映射规则仅在配置方法被调用后才会生效，需在应用启动阶段（如Program.cs）执行配置方法：

var builder = WebApplication.CreateBuilder(args);

// 注册Mapster服务
builder.Services.AddMapster();

// 执行映射配置
YourMappingConfigClass.MapTenantAndAddressDTO();

// 其他服务注册逻辑...

2. 验证源数据的有效性 #

检查仓储返回的Tenant对象中，Address属性是否不为null，且AddressLine1等字段存在实际值。可在映射前添加调试代码确认：

public async Task<List<TenantQueryDTO>> Get(CancellationToken cancellationToken)
{
    var data = await repository.GetAllAsync(cancellationToken);
    // 调试验证Address数据
    foreach(var tenant in data)
    {
        Console.WriteLine($"Tenant {tenant.TenantName} AddressLine1: {tenant.Address?.AddressLine1 ?? "null or empty"}");
    }
    return _mapper.Map<List<TenantQueryDTO>>(data);
}

3. 完善映射配置 #

• 移除不必要的双向映射：若无需从TenantQueryDTO反向映射回Tenant，删除.TwoWays()，避免自动生成的反向规则覆盖正向映射配置。
• 补充所有地址字段的映射规则：当前配置仅映射了AddressLine1，需添加其他地址字段的映射：

static void MapTenantAndAddressDTO()
{
    TypeAdapterConfig<Tenant, TenantQueryDTO>
           .NewConfig()
           .Map(dest => dest.Id, src => src.Id)
           .Map(dest => dest.Name, src => src.TenantName)
           .Map(dest => dest.AddressLine1, src => src.Address.AddressLine1)
           .Map(dest => dest.AddressLine2, src => src.Address.AddressLine2)
           .Map(dest => dest.City, src => src.Address.City)
           .Map(dest => dest.State, src => src.Address.State)
           .Map(dest => dest.Zip, src => src.Address.Zip);
}

4. 检查DTO属性的访问权限 #

TenantQueryDTO的Id属性使用了internal set，若Mapster默认配置不允许访问internal成员，可能导致映射失败。可全局开启允许访问internal成员：

TypeAdapterConfig.GlobalSettings.Default.AllowInternalMembers(true);

或者将Id的set修改为public。

5. 确认映射器注入正确 #

确保使用依赖注入获取的IMapper实例，而非手动创建的实例，这样才能应用全局配置的映射规则。

内容的提问来源于stack exchange，提问作者zeeshan