.NET如何使用AutoMapper进行对象映射_AutoMapper对象映射配置指南

AutoMapper 是 .NET 中常用的对象映射工具,用于简化实体与 DTO 之间的转换。通过安装 AutoMapper.Extensions.Microsoft.DependencyInjection 包并注册服务,可在 .NET 项目中快速集成。创建 Profile 类定义映射规则,如 CreateMap,并在 Program.cs 中调用 AddAutoMapper。在控制器中注入 IMapper 实例,使用 Map 方法完成对象转换。支持自定义配置,如字段重命名、值转换(MapFrom)、忽略字段(Ignore),以及处理空值(NullSubstitute)和条件映射(Condition)。集合映射自动生效,只要单个类型已配置。合理使用 AutoMapper 可显著提升开发效率与代码可维护性。

在 .NET 开发中,对象之间的映射是常见需求,尤其是在分层架构中(如从实体模型转换为 DTO)。手动赋值不仅繁琐还容易出错,AutoMapper 是一个流行的对象映射库,能够自动将一个对象的属性映射到另一个对象,极大提升开发效率。本文介绍如何在 .NET 项目中使用 AutoMapper 进行对象映射,并完成基本与高级配置。

安装 AutoMapper

在开始前,需通过 NuGet 安装 AutoMapper 包。在 .NET 6+ 或 ASP.NET Core 项目中,推荐使用以下命令:

dotnet add package AutoMapper.Extensions.Microsoft.DependencyInjection

该包整合了依赖注入支持,便于在 ASP.NET Core 中注册服务。

基本对象映射配置

假设我们有两个类:数据库实体 User 和用于返回前端的 DTO UserDto

public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Email { get; set; }
    public DateTime CreatedAt { get; set; }
}

public class UserDto { public int Id { get; set; } public string Name { get; set; } public string Email { get; set; } }

创建一个 Profile 类来定义映射规则:

using AutoMapper;

public class UserProfile : Profile { public UserProfile() { CreateMap(); } }

Program.cs(.NET 6 及以上)中注册 AutoMapper:

var builder = WebApplication.CreateBuilder(args);

// 添加 AutoMapper 服务 builder.Services.AddAutoMapper(typeof(UserProfile));

var app = builder.Build();

在控制器中使用 IMapper

在 Controller 或 Service 中注入 IMapper 实例进行映射:

[ApiController]
[Route("[controller]")]
public class UsersController : ControllerBase
{
    private readonly IMapper _mapper;
public UsersController(IMapper mapper)
{
    _mapper = mapper;
}

[HttpGet("{id}")]
public IActionResult Get(int id)
{
    var user = new User 
    { 
        Id = id, 
        Name = "张三", 
        Email = "zhangsan@example.com",
        CreatedAt = DateTime.Now 
    };

    var dto = _mapper.MapzuojiankuohaophpcnUserDtoyoujiankuohaophpcn(user);
    return Ok(dto);
}

}

此时,AutoMapper 会自动将同名属性进行映射。

自定义映射规则

当源和目标对象字段不一致时,可自定义映射方式:

  • 字段重命名:使用 ForMember
  • 值转换:使用 MapFrom
  • 忽略某些字段:使用 Ignore

示例:将 CreatedAt 转为字符串格式:

CreateMap()
    .ForMember(dest => dest.Email, opt => opt.MapFrom(src => src.Email.ToLower()))
    .ForMember(dest => dest.Name, opt => opt.MapFrom(src => "用户:" + src.Name))
    .ForMember(dest => dest.Id, opt => opt.Ignore());

条件映射与空值处理

可设置条件映射,仅当满足条件时才映射:

CreateMap()
    .ForMember(dest => dest.Name, opt => opt
        .NullSubstitute("未知用户"))
    .ForMember(dest => dest.Email, opt => opt
        .Condition(src => !string.IsNullOrEmpty(src.Email)));

NullSubstitute 表示源为 null 时使用默认值;Condition 用于判断是否执行映射。

集合映射

AutoMapper 支持集合自动映射:

var users = new List{ /* ... */ };
var dtos = _mapper.Map>(users);

无需额外配置,只要单个对象映射已定义,集合会自动逐项映射。

基本上就这些。AutoMapper 简化了对象转换流程,配合 Profile 分类管理映射关系,代码更清晰、可维护性更强。合理使用自定义规则,能应对大多数业务场景。