关于AutoMapper

AutoMapper 概述

AutoMapper 是一个基于约定的对象 - 对象映射库，主要用于在不同对象类型之间自动映射属性值。它能根据配置的映射规则，将源对象的属性值填充到目标对象中，避免了手动编写大量繁琐的对象映射代码。

作用

• 提升开发效率：自动完成对象属性的映射，减少手动编写赋值代码的工作量，尤其是在处理多个属性的对象映射时，能显著缩短开发时间。
• 优化代码结构：使代码更简洁、清晰，降低冗余度，提高代码的可读性和可维护性。原本复杂的对象映射代码，使用 AutoMapper 后可简化为几行配置代码。
• 支持复杂映射处理：可处理嵌套对象、集合对象等复杂对象间的映射。例如，将包含多层嵌套属性的订单对象映射到另一种格式的订单 DTO 时，能通过配置准确完成映射。
• 便于配置与扩展：提供丰富的配置选项，可自定义类型转换器、值解析器等，方便根据项目的特殊需求进行扩展和定制。

应用场景

• DTO 与领域模型映射：在开发中，常需将数据库实体类（领域模型）转换为数据传输对象（DTO）用于网络传输或前端展示。如在 Web API 项目中，使用 AutoMapper 可将数据库中的User实体快速映射为UserDto返回给前端。
• 实体与视图模型映射：在 MVC 架构中，需要把实体对象转换为视图模型，以便在视图中展示数据。AutoMapper 能将实体对象的属性映射到视图模型的对应属性上，使数据展示更方便。
• 不同层间数据映射：在多层架构中，不同层（如表现层、业务逻辑层、数据访问层）之间传递数据时，利用 AutoMapper 可自动完成数据对象的格式转换，确保各层使用的数据格式符合其需求3。

意义

• 降低开发成本：减少了开发过程中编写对象映射代码的人力成本和时间成本，尤其是在大型项目中，对象映射关系复杂，其优势更加明显。
• 增强代码稳定性：统一的映射方式减少了因手动映射可能出现的错误，如属性遗漏、类型转换错误等，提高了代码的稳定性和可靠性。
• 促进代码标准化：遵循一定的映射规则和约定，使团队开发的代码在对象映射方面具有一致性和规范性，便于团队成员理解和维护代码。

注意事项

• 映射规则配置准确性：源对象和目标对象属性名、类型不完全一致时，需准确配置映射规则，否则可能导致映射结果错误。比如源对象属性是驼峰命名法，目标对象属性是下划线命名法，就需要手动配置映射关系。
• 性能考量：虽然 AutoMapper 性能较好，但在大规模数据映射场景下，仍需关注性能问题。可通过合理利用缓存机制、避免不必要的复杂映射等方式优化性能。
• 版本兼容性：项目升级或更换相关依赖库版本时，要注意 AutoMapper 与其他库（如 ORM 框架等）的兼容性，防止出现不兼容问题影响映射功能。
• 错误排查：由于 AutoMapper 内部机制相对复杂，映射出现问题时，排查错误可能较困难。可利用其提供的验证功能，如AssertConfigurationIsValid方法检查映射配置是否有效，辅助排查错误。

优势与劣势

• 优势：自动化映射减少代码量，提高开发效率；支持复杂映射场景；配置灵活可定制；有活跃的社区支持，文档丰富，遇到问题容易找到解决方案。
• 劣势：对于简单的少量属性映射，使用 AutoMapper 可能会增加一定的复杂性，不如手动映射直观；在某些极端情况下，性能可能不如手动优化后的映射代码；由于其自动化特性，可能会隐藏一些潜在的映射问题，需要开发者仔细检查配置。

代码案例

以下是 5 个 C# 语言结合ASP.NET Core 项目的 AutoMapper 代码案例：

案例一：简单对象映射
假设存在表示数据库实体的BookEntity类和用于 API 传输的BookDto类。

csharp

// 数据库实体类
public class BookEntity
{
    public int Id { get; set; }
    public string Title { get; set; }
    public string Author { get; set; }
}

// 数据传输对象类
public class BookDto
{
    public int Id { get; set; }
    public string Title { get; set; }
    public string Author { get; set; }
}

// 配置AutoMapper
var config = new MapperConfiguration(cfg =>
{
    cfg.CreateMap<BookEntity, BookDto>();
});
var mapper = config.CreateMapper();

// 使用AutoMapper进行映射
BookEntity bookEntity = new BookEntity { Id = 1, Title = "C#从入门到实践", Author = "张三" };
BookDto bookDto = mapper.Map<BookDto>(bookEntity);

案例二：属性名不同的对象映射
假设StudentEntity的属性名与StudentDto不同。

csharp

// 数据库实体类
public class StudentEntity
{
    public int StudentId { get; set; }
    public string StudentName { get; set; }
    public int Age { get; set; }
}

// 数据传输对象类
public class StudentDto
{
    public int Id { get; set; }
    public string Name { get; set; }
    public int StudentAge { get; set; }
}

// 配置AutoMapper
var config = new MapperConfiguration(cfg =>
{
    cfg.CreateMap<StudentEntity, StudentDto>()
       .ForMember(dest => dest.Id, opt => opt.MapFrom(src => src.StudentId))
       .ForMember(dest => dest.Name, opt => opt.MapFrom(src => src.StudentName))
       .ForMember(dest => dest.StudentAge, opt => opt.MapFrom(src => src.Age));
});
var mapper = config.CreateMapper();

// 使用AutoMapper进行映射
StudentEntity studentEntity = new StudentEntity { StudentId = 1, StudentName = "李四", Age = 20 };
StudentDto studentDto = mapper.Map<StudentDto>(studentEntity);

案例三：嵌套对象映射
假设存在包含AddressEntity的EmployeeEntity，以及对应的EmployeeDto和AddressDto。

csharp

// 地址实体类
public class AddressEntity
{
    public string Street { get; set; }
    public string City { get; set; }
}

// 员工实体类
public class EmployeeEntity
{
    public int Id { get; set; }
    public string Name { get; set; }
    public AddressEntity Address { get; set; }
}

// 地址数据传输对象类
public class AddressDto
{
    public string Street { get; set; }
    public string City { get; set; }
}

// 员工数据传输对象类
public class EmployeeDto
{
    public int Id { get; set; }
    public string Name { get; set; }
    public AddressDto Address { get; set; }
}

// 配置AutoMapper
var config = new MapperConfiguration(cfg =>
{
    cfg.CreateMap<AddressEntity, AddressDto>();
    cfg.CreateMap<EmployeeEntity, EmployeeDto>()
       .ForMember(dest => dest.Address, opt => opt.MapFrom(src => src.Address));
});
var mapper = config.CreateMapper();

// 使用AutoMapper进行映射
AddressEntity addressEntity = new AddressEntity { Street = "456 Elm St", City = "Othercity" };
EmployeeEntity employeeEntity = new EmployeeEntity { Id = 1, Name = "王五", Address = addressEntity };
EmployeeDto employeeDto = mapper.Map<EmployeeDto>(employeeEntity);

案例四：集合对象映射
假设存在OrderEntity和OrderDto，并且有一个List<OrderEntity>需要映射为List<OrderDto>。

csharp

// 订单实体类
public class OrderEntity
{
    public int OrderId { get; set; }
    public string CustomerName { get; set; }
    public decimal TotalAmount { get; set; }
}

// 订单数据传输对象类
public class OrderDto
{
    public int Id { get; set; }
    public string Customer { get; set; }
    public decimal Amount { get; set; }
}

// 配置AutoMapper
var config = new MapperConfiguration(cfg =>
{
    cfg.CreateMap<OrderEntity, OrderDto>();
});
var mapper = config.CreateMapper();

// 使用AutoMapper进行集合映射
List<OrderEntity> orderEntities = new List<OrderEntity>
{
    new OrderEntity { OrderId = 1, CustomerName = "赵六", TotalAmount = 100m },
    new OrderEntity { OrderId = 2, CustomerName = "孙七", TotalAmount = 200m }
};
List<OrderDto> orderDtos = mapper.Map<List<OrderDto>>(orderEntities);

案例五：自定义类型转换映射
假设需要将DateTime类型的属性映射为字符串类型的属性，并且进行特定的格式转换。

csharp

// 源实体类
public class EventEntity
{
    public int Id { get; set; }
    public string EventName { get; set; }
    public DateTime EventDate { get; set; }
}

// 目标数据传输对象类
public class EventDto
{
    public int Id { get; set; }
    public string EventName { get; set; }
    public string EventDateStr { get; set; }
}

// 自定义类型转换器
public class DateTimeToStringConverter : ITypeConverter<DateTime, string>
{
    public string Convert(DateTime source, string destination, ResolutionContext context)
    {
        return source.ToString("yyyy-MM-dd HH:mm:ss");
    }
}

// 配置AutoMapper
var config = new MapperConfiguration(cfg =>
{
    cfg.CreateMap<EventEntity, EventDto>()
       .ForMember(dest => dest.EventDateStr, opt => opt.MapFrom(src => src.EventDate))
       .ConvertUsing<DateTimeToStringConverter>();
});
var mapper = config.CreateMapper();

// 使用AutoMapper进行映射
EventEntity eventEntity = new EventEntity { Id = 1, EventName = "会议", EventDate = DateTime.Now };
EventDto eventDto = mapper.Map<EventDto>(eventEntity);