深入浅出：AutoMapper 的使用与最佳实践

甘桔 · 发表于 2024-11-1 11:55:35

在现代软件开发中，特别是在 .NET 环境中，数据传输对象（DTO）与实体模型之间的映射是一个常见的需求。AutoMapper 是一个强大的库，可以简化这一过程，减少样板代码，提高开发效率。本文将详细讲解 AutoMapper 的基本概念、各种用法以及最佳实践。
什么是 AutoMapper？

AutoMapper 是一个对象到对象的映射工具，允许开发者在不同类型之间轻松转换数据。它通过约定优于配置的方式来简化映射过程，减少手动编写转换逻辑的需要。
安装 AutoMapper

首先，你需要在项目中安装 AutoMapper。可以通过 NuGet 包管理器来安装：

Install-Package AutoMapper

复制代码

或者使用 .NET CLI：

dotnet add package AutoMapper

复制代码

基本使用

1. 创建映射配置

在使用 AutoMapper 之前，需要先配置映射。通常，在应用程序启动时配置一次。

using AutoMapper; public class Startup { public void ConfigureServices(IServiceCollection services) { var config = new MapperConfiguration(cfg => { cfg.CreateMap<Source, Destination>(); }); IMapper mapper = config.CreateMapper(); services.AddSingleton(mapper); } }

复制代码

2. 定义源和目标类

以下是简单的源类和目标类：

public class Source { public string Name { get; set; } public int Age { get; set; } } public class Destination { public string FullName { get; set; } public int Age { get; set; } }

复制代码

3. 执行映射

一旦配置完成，你可以在代码中使用 AutoMapper 进行对象转换：

var source = new Source { Name = "John", Age = 30 }; var destination = mapper.Map<Destination>(source); // destination.FullName 将是 "John"，destination.Age 将是 30

复制代码

高级特性

1. 属性映射

如果目标类的属性名称与源类不完全相同，可以使用 ForMember 方法自定义映射：

cfg.CreateMap<Source, Destination>() .ForMember(dest => dest.FullName, opt => opt.MapFrom(src => src.Name));

复制代码

2. 嵌套映射

AutoMapper 支持嵌套对象的映射。例如，如果 Source 类有一个嵌套对象：

public class Address { public string City { get; set; } } public class SourceWithAddress { public string Name { get; set; } public Address Address { get; set; } } public class DestinationWithAddress { public string FullName { get; set; } public string City { get; set; } }

复制代码

可以这样配置：

cfg.CreateMap<SourceWithAddress, DestinationWithAddress>() .ForMember(dest => dest.FullName, opt => opt.MapFrom(src => src.Name)) .ForMember(dest => dest.City, opt => opt.MapFrom(src => src.Address.City));

复制代码

3. 自定义类型转换

对于一些复杂的映射需求，AutoMapper 允许定义自定义的转换逻辑：

cfg.CreateMap<Source, Destination>()
.ForMember(dest => dest.FullName, opt => opt.MapFrom(src => $"{src.Name} (Processed)"));

复制代码

4. 集合映射

AutoMapper 支持集合之间的映射，例如从 List 到 List：

var sources = new List<Source> { new Source { Name = "John", Age = 30 }, new Source { Name = "Jane", Age = 25 } }; var destinations = mapper.Map<List<Destination>>(sources);

复制代码

5. 条件映射

你可以根据特定条件进行映射，比如当某个值不为 null 时：

cfg.CreateMap<Source, Destination>() .ForMember(dest => dest.FullName, opt => opt.MapFrom(src => string.IsNullOrEmpty(src.Name) ? "Unknown" : src.Name));

复制代码

6. 执行转换时忽略属性

如果需要在映射时忽略某个属性，可以使用 ForMember 方法：

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

复制代码

7. 使用 Profile 组织映射

在大型项目中，使用 AutoMapper 的 Profiles 功能将不同的映射逻辑分组是个好主意：

public class MappingProfile : Profile { public MappingProfile() { CreateMap<Source, Destination>(); CreateMap<SourceWithAddress, DestinationWithAddress>(); } } // 在 Startup 中添加配置 services.AddAutoMapper(typeof(MappingProfile));

复制代码

性能优化

1. 缓存映射配置

AutoMapper 支持缓存映射配置，以提高性能。只需在应用启动时配置一次，并在整个应用中重用相同的 IMapper 实例。
2. 使用 Projection

对于查询操作，可以使用 LINQ 的投影功能，将映射逻辑直接应用于数据库查询，从而避免不必要的对象创建：

var result = dbContext.Sources .ProjectTo<Destination>(mapper.ConfigurationProvider) .ToList();

复制代码

测试映射

确保映射的准确性通过单元测试验证映射结果是个好习惯。可以使用 FluentAssertions 来断言映射结果：

[Test] public void Should_Map_Source_To_Destination_Correctly() { var source = new Source { Name = "John", Age = 30 }; var destination = mapper.Map<Destination>(source); destination.FullName.Should().Be("John"); destination.Age.Should().Be(30); }

复制代码

最佳实践

集中配置：将所有映射配置放在一个地方，通常是在应用启动时，以便于管理和维护。
避免过度映射：只映射需要的属性，避免不必要的性能开销。
使用 DTO：确保使用 DTO 来隔离外部接口与内部数据结构，增强系统的可维护性。
定期审查映射配置：随着项目的发展，映射配置可能需要调整，定期审查可以确保映射的正确性和性能。
使用注释：在复杂的映射逻辑中，添加注释以解释意图，帮助后续开发者理解。

结论

AutoMapper 是一个强大的工具，可以显著简化对象映射的工作。通过合理的配置和最佳实践，你可以有效地提高代码的可读性和可维护性。在你的下一个 .NET 项目中，不妨尝试使用 AutoMapper，让数据映射变得更加高效。

来源:https://www.cnblogs.com/forges/p/18519671
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】我们会及时删除侵权内容，谢谢合作！