ABP DTO 与对象映射：AutoMapper Profile 配置与 Mapperly 源生成器

DTO 基类的设计

ABP 提供了标准的 DTO 基类，看其源码继承关系：

// framework/src/Volo.Abp.Ddd.Application.Contracts/Volo/Abp/Application/Dtos/

// 单个实体输出
public abstract class EntityDto : EntityDto, IEntityDto
{
    public TKey Id { get; set; }
}

// 分页响应
public class PagedResultDto : ListResultDto, IPagedResult
{
    public long TotalCount { get; set; }

    public PagedResultDto(long totalCount, IReadOnlyList items) : base(items)
    {
        TotalCount = totalCount;
    }
}

// 分页请求参数
public class PagedAndSortedResultRequestDto : PagedResultRequestDto, IPagedAndSortedResultRequest
{
    public virtual string? Sorting { get; set; }
}

public class LimitedResultRequestDto : ILimitedResultRequest, IValidatableObject
{
    public static int DefaultMaxResultCount { get; set; } = 10;   // 默认每页 10 条
    public static int MaxMaxResultCount { get; set; } = 1000;     // 最大 1000 条

    [Range(1, int.MaxValue)]
    public virtual int MaxResultCount { get; set; } = DefaultMaxResultCount;
}

LimitedResultRequestDto 自带验证逻辑，当 MaxResultCount > 1000 时会返回验证错误。这个限制可以有效防止恶意请求拉取全量数据。

AutoMapper 集成源码

ABP 的 AutoMapper 集成在 Volo.Abp.AutoMapper 包中。核心是 AbpAutoMapperModule：

[DependsOn(typeof(AbpObjectMappingModule), typeof(AbpObjectExtendingModule))]
public class AbpAutoMapperModule : AbpModule
{
    public override void ConfigureServices(ServiceConfigurationContext context)
    {
        context.Services.AddAutoMapperObjectMapper();

        context.Services.AddSingleton(sp =>
        {
            var options = sp.GetRequiredService>().Value;
            // 执行所有配置器
            foreach (var configurator in options.Configurators)
            {
                configurator(autoMapperConfigurationContext);
            }
            return new MapperConfiguration(mapperConfigurationExpression);
        });
    }
}

AbpAutoMapperOptions 支持两种注册 Profile 的方式：

// 方式 1：通过 AbpAutoMapperOptions 配置
Configure(options =>
{
    options.AddProfile();
    options.AddProfile();
});

// 方式 2：通过 ASP.NET Core 的 AddAutoMapper 扩展
context.Services.AddAutoMapper(typeof(BookProfile), typeof(UserProfile));

Mapperly 方案

Mapperly 是 ABP 提供的另一种映射方案，通过源生成器在编译时生成映射代码：

// 定义映射
[Mapper]
public static partial class BookMapper
{
    public static partial BookDto MapToDto(Book book);
}

// 注入 ObjectMapper 后使用
ObjectMapper.Map(book);

与 AutoMapper 的关键区别：

实战：Profile 配置的最佳实践

// 1. 命名实体和 DTO 一一对应
CreateMap();  // 按属性名自动匹配

// 2. 明确忽略不应由客户端传入的字段
CreateMap()
    .ForMember(x => x.Id, opt => opt.Ignore())              // ID 由服务端生成
    .ForMember(x => x.CreationTime, opt => opt.Ignore())    // 时间由服务端设置
    .ForMember(x => x.TenantId, opt => opt.Ignore());       // 租户由上下文注入

// 3. 敏感字段不出现在 DTO 中
public class UserDto : EntityDto
{
    public string UserName { get; set; }
    // PasswordHash 不在这里，自动忽略
}

使用注意事项

// 一般不建议把实体直接返回
[HttpGet("{id}")]
public async Task GetUser(Guid id)    // ❌ 直接暴露实体
{
    return await _userRepo.GetAsync(id);
}

// 使用 DTO
[HttpGet("{id}")]
public async Task GetUser(Guid id) // ✅ 使用 DTO
{
    var user = await _userRepo.GetAsync(id);
    return ObjectMapper.Map(user);
}