.NET使用AutoMapper简化对象映射

2025-03-30 .NET AutoMapper 566 0

在.NET软件开发中，常常需要将一个对象的数据转换并映射到另一个对象上。这种手动映射的过程既繁琐又容易出错，影响开发效率和代码可维护性。为了解决这一问题，AutoMapper应运而生。

AutoMapper：简化对象映射的强大工具

什么是 AutoMapper？

AutoMapper 是一个开源的对象-对象映射库，旨在通过自动化的方式将一种类型的对象转换为另一种类型。它通过约定优于配置的理念，减少了手动编写映射代码的工作量，提高了开发效率。只要源类型和目标类型的属性名称和类型匹配，AutoMapper 就能自动完成映射。

安装和配置 AutoMapper

要在项目中使用 AutoMapper，首先需要通过 NuGet 包管理器进行安装。在 Visual Studio 的“程序包管理器控制台”中执行以下命令：

Install-Package AutoMapper

安装完成后，需要进行配置。通常，我们会创建一个继承自 Profile 的类，在其中定义映射关系：

using AutoMapper;

public class MappingProfile : Profile
{
    public MappingProfile()
    {
        CreateMap<Source, Destination>();
    }
}

然后，在应用程序启动时初始化映射配置：

var config = new MapperConfiguration(cfg =>
{
    cfg.AddProfile<MappingProfile>();
});

IMapper mapper = config.CreateMapper();

ASP.NET Core中使用AutoMapper

1. 安装 AutoMapper 和相关扩展包

在项目中，使用 NuGet 包管理器安装 AutoMapper 和 AutoMapper.Extensions.Microsoft.DependencyInjection：

Install-Package AutoMapper
Install-Package AutoMapper.Extensions.Microsoft.DependencyInjection

2. 创建映射配置类

在项目中创建一个继承自 Profile 的类，例如 MappingProfile，用于定义对象之间的映射关系：

using AutoMapper;

public class MappingProfile : Profile
{
    public MappingProfile()
    {
        CreateMap<Source, Destination>();
        // 可以在此添加更多的映射配置
    }
}

通过上述配置，AutoMapper 就准备就绪，可以在应用程序中使用了。在上述代码中，Source 和 Destination 是需要映射的源和目标类。

3. 注册 AutoMapper 服务

在 Program.cs 或 Startup.cs 中，将 AutoMapper 服务添加到依赖注入容器中。以下以 Program.cs 为例：

using AutoMapper;
using AutoMapper.Extensions.Microsoft.DependencyInjection;

var builder = WebApplication.CreateBuilder(args);

// 注册 AutoMapper 服务
builder.Services.AddAutoMapper(typeof(MappingProfile));

var app = builder.Build();

// 其他中间件配置

app.Run();

通过 builder.Services.AddAutoMapper(typeof(MappingProfile));，应用程序会扫描并注册所有继承自 Profile 的映射配置类。

4. 使用 IMapper 进行对象映射

在需要进行对象映射的类中，通过构造函数注入 IMapper 接口，并使用其 Map 方法进行对象转换：

using AutoMapper;

public class SampleService
{
    private readonly IMapper _mapper;

    public SampleService(IMapper mapper)
    {
        _mapper = mapper;
    }

    public Destination GetMappedObject(Source source)
    {
        var destination = _mapper.Map<Destination>(source);
        return destination;
    }
}

通过上述步骤，即可在 ASP.NET Core 项目中初始化并使用 AutoMapper，实现对象之间的高效映射。

使用 AutoMapper 进行对象映射

假设我们有以下两个类：

public class Source
{
    public int Id { get; set; }
    public string Name { get; set; }
}

public class Destination
{
    public int Id { get; set; }
    public string Name { get; set; }
}

在 MappingProfile 中定义了从 Source 到 Destination 的映射关系后，可以使用以下代码进行对象转换：

var source = new Source { Id = 1, Name = "张三" };
var destination = mapper.Map<Destination>(source);

此时，destination 对象的 Id 和 Name 属性将与 source 对象对应的属性值相同。

自定义映射规则

在实际应用中，源类型和目标类型的属性名称可能不一致，或者需要进行特定的转换逻辑。AutoMapper 提供了灵活的配置方式来处理这些情况。

属性重命名映射

如果源类和目标类的属性名称不同，可以使用 ForMember 方法进行映射配置：

CreateMap<Source, Destination>()
    .ForMember(dest => dest.DestProperty, opt => opt.MapFrom(src => src.SourceProperty));

上述代码表示将 Source 类的 SourceProperty 属性映射到 Destination 类的 DestProperty 属性。

忽略特定属性

如果希望在映射过程中忽略某个属性，可以使用 Ignore 方法：

CreateMap<Source, Destination>()
    .ForMember(dest => dest.IgnoredProperty, opt => opt.Ignore());

这样，IgnoredProperty 将不会被映射。

类型转换

对于需要进行类型转换的属性，可以使用 ConvertUsing 方法：

CreateMap<DateTime, string>().ConvertUsing(dt => dt.ToString("yyyy-MM-dd"));

此配置将 DateTime 类型转换为指定格式的字符串。

高级功能

AutoMapper 还支持多种高级功能，如：

反向映射：使用 ReverseMap 方法，可以自动创建从目标类型到源类型的映射，方便进行双向转换。
映射前后处理：通过 BeforeMap 和 AfterMap 方法，可以在映射前后执行特定的逻辑操作。
条件映射：使用 Condition 方法，可以根据特定条件决定是否进行属性映射。

这些功能使得 AutoMapper 能够应对复杂的映射需求，提供了高度的灵活性。

AutoMapper 作为一个强大的对象映射工具，极大地简化了对象之间的数据转换过程，减少了手动编写映射代码的繁琐工作。通过灵活的配置和丰富的功能，AutoMapper 提高了开发效率，增强了代码的可读性和可维护性。在实际开发中，合理运用 AutoMapper，可以使对象映射变得更加简洁和高效。