本文基于 AutoMapper 9.0.0

AutoMapper 是一个对象-对象映射器,可以将一个对象映射到另一个对象。

官网地址:http://automapper.org/

官方文档:https://docs.automapper.org/en/latest/

1 入门例子

  1. public class Foo
  2. {
  3. public int ID { get; set; }
  4. public string Name { get; set; }
  5. }
  6. public class FooDto
  7. {
  8. public int ID { get; set; }
  9. public string Name { get; set; }
  10. }
  11. public void Map()
  12. {
  13. var config = new MapperConfiguration(cfg => cfg.CreateMap<Foo, FooDto>());
  14. var mapper = config.CreateMapper();
  15. Foo foo = new Foo { ID = 1, Name = "Tom" };
  16. FooDto dto = mapper.Map<FooDto>(foo);
  17. }

2 注册

在使用 Map 方法之前,首先要告诉 AutoMapper 什么类可以映射到什么类。

  1. var config = new MapperConfiguration(cfg => cfg.CreateMap<Foo, FooDto>());

每个 AppDomain 只能进行一次配置。这意味着放置配置代码的最佳位置是在应用程序启动中,例如 ASP.NET 应用程序的 Global.asax 文件。

从 9.0 开始 Mapper.Initialize 方法就不可用了。

2.1 Profile

Profile 是组织映射的另一种方式。新建一个类,继承 Profile,并在构造函数中配置映射。

  1. public class EmployeeProfile : Profile
  2. {
  3. public EmployeeProfile()
  4. {
  5. CreateMap<Employee, EmployeeDto>();
  6. }
  7. }
  8. var config = new MapperConfiguration(cfg =>
  9. {
  10. cfg.AddProfile<EmployeeProfile>();
  11. });

Profile 内部的配置仅适用于 Profile 内部的映射。应用于根配置的配置适用于所有创建的映射。

AutoMapper 也可以在指定的程序集中扫描从 Profile 继承的类,并将其添加到配置中。

  1. var config = new MapperConfiguration(cfg =>
  2. {
  3. // 扫描当前程序集
  4. cfg.AddMaps(System.AppDomain.CurrentDomain.GetAssemblies());
  5. // 也可以传程序集名称(dll 名称)
  6. cfg.AddMaps("LibCoreTest");
  7. });

3 配置

3.1 命名约定

默认情况下,AutoMapper 基于相同的字段名映射,并且是 不区分大小写 的。

但有时,我们需要处理一些特殊的情况。

  • SourceMemberNamingConvention 表示源类型命名规则
  • DestinationMemberNamingConvention 表示目标类型命名规则

LowerUnderscoreNamingConventionPascalCaseNamingConvention 是 AutoMapper 提供的两个命名规则。前者命名是小写并包含下划线,后者就是帕斯卡命名规则(每个单词的首字母大写)。

我的理解,如果源类型和目标类型分别采用了 蛇形命名法驼峰命名法,那么就需要指定命名规则,使其能正确映射。

  1. public class Foo
  2. {
  3. public int Id { get; set; }
  4. public string MyName { get; set; }
  5. }
  6. public class FooDto
  7. {
  8. public int ID { get; set; }
  9. public string My_Name { get; set; }
  10. }
  11. public void Map()
  12. {
  13. var config = new MapperConfiguration(cfg =>
  14. {
  15. cfg.CreateMap<Foo, FooDto>();
  16. cfg.SourceMemberNamingConvention = new PascalCaseNamingConvention();
  17. cfg.DestinationMemberNamingConvention = new LowerUnderscoreNamingConvention();
  18. });
  19. var mapper = config.CreateMapper();
  20. Foo foo = new Foo { Id = 2, MyName = "Tom" };
  21. FooDto dto = mapper.Map<FooDto>(foo);
  22. }

3.2 配置可见性

默认情况下,AutoMapper 仅映射 public 成员,但其实它是可以映射到 private 属性的。

  1. var config = new MapperConfiguration(cfg =>
  2. {
  3. cfg.ShouldMapProperty = p => p.GetMethod.IsPublic || p.SetMethod.IsPrivate;
  4. cfg.CreateMap<Source, Destination>();
  5. });

需要注意的是,这里属性必须添加 private set,省略 set 是不行的。

3.3 全局属性/字段过滤

默认情况下,AutoMapper 尝试映射每个公共属性/字段。以下配置将忽略字段映射。

  1. var config = new MapperConfiguration(cfg =>
  2. {
  3. cfg.ShouldMapField = fi => false;
  4. });

3.4 识别前缀和后缀

  1. var config = new MapperConfiguration(cfg =>
  2. {
  3. cfg.RecognizePrefixes("My");
  4. cfg.RecognizePostfixes("My");
  5. }

3.5 替换字符

  1. var config = new MapperConfiguration(cfg =>
  2. {
  3. cfg.ReplaceMemberName("Ä", "A");
  4. });

这功能我们基本上用不上。

4 调用构造函数

有些类,属性的 set 方法是私有的。

  1. public class Commodity
  2. {
  3. public string Name { get; set; }
  4. public int Price { get; set; }
  5. }
  6. public class CommodityDto
  7. {
  8. public string Name { get; }
  9. public int Price { get; }
  10. public CommodityDto(string name, int price)
  11. {
  12. Name = name;
  13. Price = price * 2;
  14. }
  15. }

AutoMapper 会自动找到相应的构造函数调用。如果在构造函数中对参数做一些改变的话,其改变会反应在映射结果中。如上例,映射后 Price 会乘 2。

禁用构造函数映射:

  1. var config = new MapperConfiguration(cfg => cfg.DisableConstructorMapping());

禁用构造函数映射的话,目标类要有一个无参构造函数。

5 数组和列表映射

数组和列表的映射比较简单,仅需配置元素类型,定义简单类型如下:

  1. public class Source
  2. {
  3. public int Value { get; set; }
  4. }
  5. public class Destination
  6. {
  7. public int Value { get; set; }
  8. }

映射:

  1. var config = new MapperConfiguration(cfg =>
  2. {
  3. cfg.CreateMap<Source, Destination>();
  4. });
  5. IMapper mapper = config.CreateMapper();
  6. var sources = new[]
  7. {
  8. new Source { Value = 5 },
  9. new Source { Value = 6 },
  10. new Source { Value = 7 }
  11. };
  12. IEnumerable<Destination> ienumerableDest = mapper.Map<Source[], IEnumerable<Destination>>(sources);
  13. ICollection<Destination> icollectionDest = mapper.Map<Source[], ICollection<Destination>>(sources);
  14. IList<Destination> ilistDest = mapper.Map<Source[], IList<Destination>>(sources);
  15. List<Destination> listDest = mapper.Map<Source[], List<Destination>>(sources);
  16. Destination[] arrayDest = mapper.Map<Source[], Destination[]>(sources);

具体来说,支持的源集合类型包括:

  • IEnumerable
  • IEnumerable
  • ICollection
  • ICollection
  • IList
  • IList
  • List
  • Arrays

映射到现有集合时,将首先清除目标集合。如果这不是你想要的,请查看AutoMapper.Collection。

5.1 处理空集合

映射集合属性时,如果源值为 null,则 AutoMapper 会将目标字段映射为空集合,而不是 null。这与 Entity Framework 和 Framework Design Guidelines 的行为一致,认为 C# 引用,数组,List,Collection,Dictionary 和 IEnumerables 永远不应该为 null

5.2 集合中的多态

这个官方的文档不是很好理解。我重新举个例子。实体类如下:

  1. public class Employee
  2. {
  3. public int ID { get; set; }
  4. public string Name { get; set; }
  5. }
  6. public class Employee2 : Employee
  7. {
  8. public string DeptName { get; set; }
  9. }
  10. public class EmployeeDto
  11. {
  12. public int ID { get; set; }
  13. public string Name { get; set; }
  14. }
  15. public class EmployeeDto2 : EmployeeDto
  16. {
  17. public string DeptName { get; set; }
  18. }

数组映射代码如下:

  1. var config = new MapperConfiguration(cfg =>
  2. {
  3. cfg.CreateMap<Employee, EmployeeDto>().Include<Employee2, EmployeeDto2>();
  4. cfg.CreateMap<Employee2, EmployeeDto2>();
  5. });
  6. IMapper mapper = config.CreateMapper();
  7. var employees = new[]
  8. {
  9. new Employee { ID = 1, Name = "Tom" },
  10. new Employee2 { ID = 2, Name = "Jerry", DeptName = "R & D" }
  11. };
  12. var dto = mapper.Map<Employee[], EmployeeDto[]>(employees);

可以看到,映射后,dto 中两个元素的类型,一个是 EmployeeDto,一个是 EmployeeDto2,即实现了父类映射到父类,子类映射到子类。

如果去掉 Include 方法,则映射后 dto 中两个元素的类型均为 EmployeeDto

6 方法到属性映射

AutoMapper 不仅能实现属性到属性映射,还可以实现方法到属性的映射,并且不需要任何配置,方法名可以和属性名一致,也可以带有 Get 前缀。

例如下例的 Employee.GetFullName() 方法,可以映射到 EmployeeDto.FullName 属性。

  1. public class Employee
  2. {
  3. public int ID { get; set; }
  4. public string FirstName { get; set; }
  5. public string LastName { get; set; }
  6. public string GetFullName()
  7. {
  8. return $"{FirstName} {LastName}";
  9. }
  10. }
  11. public class EmployeeDto
  12. {
  13. public int ID { get; set; }
  14. public string FirstName { get; set; }
  15. public string LastName { get; set; }
  16. public string FullName { get; set; }
  17. }

7 自定义映射

当源类型与目标类型名称不一致时,或者需要对源数据做一些转换时,可以用自定义映射。

  1. public class Employee
  2. {
  3. public int ID { get; set; }
  4. public string Name { get; set; }
  5. public DateTime JoinTime { get; set; }
  6. }
  7. public class EmployeeDto
  8. {
  9. public int EmployeeID { get; set; }
  10. public string EmployeeName { get; set; }
  11. public int JoinYear { get; set; }
  12. }

如上例,IDEmployeeID 属性名不同,JoinTimeJoinYear 不仅属性名不同,属性类型也不同。

  1. var config = new MapperConfiguration(cfg =>
  2. {
  3. cfg.CreateMap<Employee, EmployeeDto>()
  4. .ForMember("EmployeeID", opt => opt.MapFrom(src => src.ID))
  5. .ForMember(dest => dest.EmployeeName, opt => opt.MapFrom(src => src.Name))
  6. .ForMember(dest => dest.JoinYear, opt => opt.MapFrom(src => src.JoinTime.Year));
  7. });

8 扁平化映射

对象-对象映射的常见用法之一是将复杂的对象模型并将其展平为更简单的模型。

  1. public class Employee
  2. {
  3. public int ID { get; set; }
  4. public string Name { get; set; }
  5. public Department Department { get; set; }
  6. }
  7. public class Department
  8. {
  9. public int ID { get; set; }
  10. public string Name { get; set; }
  11. }
  12. public class EmployeeDto
  13. {
  14. public int ID { get; set; }
  15. public string Name { get; set; }
  16. public int DepartmentID { get; set; }
  17. public string DepartmentName { get; set; }
  18. }

如果目标类型上的属性,与源类型的属性、方法都对应不上,则 AutoMapper 会将目标成员名按驼峰法拆解成单个单词,再进行匹配。例如上例中,EmployeeDto.DepartmentID 就对应到了 Employee.Department.ID

8.1 IncludeMembers

如果属性命名不符合上述的规则,而是像下面这样:

  1. public class Employee
  2. {
  3. public int ID { get; set; }
  4. public string Name { get; set; }
  5. public Department Department { get; set; }
  6. }
  7. public class Department
  8. {
  9. public int DepartmentID { get; set; }
  10. public string DepartmentName { get; set; }
  11. }
  12. public class EmployeeDto
  13. {
  14. public int ID { get; set; }
  15. public string Name { get; set; }
  16. public int DepartmentID { get; set; }
  17. public string DepartmentName { get; set; }
  18. }

Department 类中的属性名,直接跟 EmployeeDto 类中的属性名一致,则可以使用 IncludeMembers 方法指定。

  1. var config = new MapperConfiguration(cfg =>
  2. {
  3. cfg.CreateMap<Employee, EmployeeDto>().IncludeMembers(e => e.Department);
  4. cfg.CreateMap<Department, EmployeeDto>();
  5. });

9 嵌套映射

有时,我们可能不需要展平。看如下例子:

  1. public class Employee
  2. {
  3. public int ID { get; set; }
  4. public string Name { get; set; }
  5. public int Age { get; set; }
  6. public Department Department { get; set; }
  7. }
  8. public class Department
  9. {
  10. public int ID { get; set; }
  11. public string Name { get; set; }
  12. public string Heads { get; set; }
  13. }
  14. public class EmployeeDto
  15. {
  16. public int ID { get; set; }
  17. public string Name { get; set; }
  18. public DepartmentDto Department { get; set; }
  19. }
  20. public class DepartmentDto
  21. {
  22. public int ID { get; set; }
  23. public string Name { get; set; }
  24. }

我们要将 Employee 映射到 EmployeeDto,并且将 Department 映射到 DepartmentDto

  1. var config = new MapperConfiguration(cfg =>
  2. {
  3. cfg.CreateMap<Employee, EmployeeDto>();
  4. cfg.CreateMap<Department, DepartmentDto>();
  5. });

【C#】AutoMapper 使用手册的更多相关文章

  1. AutoMapper使用手册(一)

    阅读目录 1. 介绍 2. 基本使用 3. 自动分割映射(Flattening) 4. 自定义字段映射(Projection) 5. 验证配置(Configuration validation) 介绍 ...

  2. 恋爱虽易,相处不易:当EntityFramework爱上AutoMapper

    剧情开始 为何相爱? 相处的问题? 女人的伟大? 剧情收尾? 有时候相识即是一种缘分,相爱也不需要太多的理由,一个眼神足矣,当EntityFramework遇上AutoMapper,就是如此,恋爱虽易 ...

  3. 【AutoMapper官方文档】DTO与Domin Model相互转换(上)

    写在前面 AutoMapper目录: [AutoMapper官方文档]DTO与Domin Model相互转换(上) [AutoMapper官方文档]DTO与Domin Model相互转换(中) [Au ...

  4. AutoMapper

    什么是AutoMapper? AutoMapper是一个对象和对象间的映射器.对象与对象的映射是通过转变一种类型的输入对象为一种不同类型的输出对象工作的.让AutoMapper有意思的地方在于它提供了 ...

  5. FREERTOS 手册阅读笔记

    郑重声明,版权所有! 转载需说明. FREERTOS堆栈大小的单位是word,不是byte. 根据处理器架构优化系统的任务优先级不能超过32,If the architecture optimized ...

  6. AutoMapper随笔记

    平台之大势何人能挡? 带着你的Net飞奔吧! http://www.cnblogs.com/dunitian/p/4822808.html#skill 先看效果:(完整Demo:https://git ...

  7. AutoMapper:Unmapped members were found. Review the types and members below. Add a custom mapping expression, ignore, add a custom resolver, or modify the source/destination type

    异常处理汇总-后端系列 http://www.cnblogs.com/dunitian/p/4523006.html 应用场景:ViewModel==>Mode映射的时候出错 AutoMappe ...

  8. JS魔法堂:不完全国际化&本地化手册 之 理論篇

    前言  最近加入到新项目组负责前端技术预研和选型,其中涉及到一个熟悉又陌生的需求--国际化&本地化.熟悉的是之前的项目也玩过,陌生的是之前的实现仅仅停留在"有"的阶段而已. ...

  9. AutoMapper的介绍与使用(一)

    软件环境 vs2015 asp.net mvc 5 .NET Framework 4.5.2 AutoMapper 5.2.0.0 AutoMapper安装 新建asp.net mvc 项目 Auto ...

随机推荐

  1. 汇编语言 简单的Hello World

    DATA SEGMENT STRING DB 'Hello World!','$' DATA ENDS CODE SEGMENT ASSUME CS:CODE, DS:DATA START: MOV ...

  2. SpringBoot切面Aop的demo简单讲解

    前言 本篇文章主要介绍的是SpringBoot切面Aop的demo简单讲解. SpringBoot Aop 说明:如果想直接获取工程那么可以直接跳到底部,通过链接下载工程代码. 切面(Aop) 一.概 ...

  3. django中ckeditor富文本编辑器使用

    1.安装模块 (pillow是python的一个图像处理库) pip install django-ckeditor pip install pillow 2.编辑seetings.py配置文件 IN ...

  4. shipyard的安装与一般维护

    #一.安装前的准备: docker pull alpine docker pull library/rethinkdb docker pull microbox/etcd docker pull sh ...

  5. mysql小白系列_12 sysbench

    压测 1.查看机器负载load top - load average 1m 5m 15m cat /proc/loadavg 与CPU个数有关,1个load表示1个CPUcat /proc/cpuin ...

  6. 王艳 201771010127《面向对象程序设计(java)》第十四周学习总结

    实验十四  Swing图形界面组件 一理论部分 1.Layout Manager(布局管理器):布局管理器是一组类,实现 java.awt.LayoutManager 接口,决定容器中组件的位置和大小 ...

  7. poj3764字典树路径最大异或和

    The xor-longest Path Time Limit: 2000MS   Memory Limit: 65536K Total Submissions: 6853   Accepted: 1 ...

  8. 【MySQL】覆盖索引和回表

    先来了解一下两大类索引 聚簇索引(也称聚集索引,主键索引等) 普通索引(也成非聚簇索引,二级索引等) 聚簇索引 如果表设置了主键,则主键就是聚簇索引 如果表没有主键,则会默认第一个NOT NULL,且 ...

  9. (STL初步)不定长数组:vector

    STL是指C++的标准模板库.(存储着一些常用的算法和容器) vector是一个不定长数组.它把一些常用的操作”封装“在vector类型内部. 例如,a是一个vector.1对元素的操作有,可以用a. ...

  10. Xmind写测试点

    引入: 既然我们这篇要说<Xmind写测试点>,那么先来回顾一下,什么情况下才写测试点,而不写测试用例. 之前写过一篇<测试用例-20问20答>,没看过的朋友戳这里:,其中就有 ...