AutoMapper 是一个对象-对象映射器,可以将一个对象映射到另一个对象。
官网地址:http://automapper.org/
官方文档:https://docs.automapper.org/en/latest/
1 入门例子
public class Foo
{
public int ID { get; set; }
public string Name { get; set; }
}
public class FooDto
{
public int ID { get; set; }
public string Name { get; set; }
}
public void Map()
{
var config = new MapperConfiguration(cfg => cfg.CreateMap<Foo, FooDto>());
var mapper = config.CreateMapper();
Foo foo = new Foo { ID = 1, Name = "Tom" };
FooDto dto = mapper.Map<FooDto>(foo);
}
2 注册
在使用 Map 方法之前,首先要告诉 AutoMapper 什么类可以映射到什么类。
var config = new MapperConfiguration(cfg => cfg.CreateMap<Foo, FooDto>());
每个 AppDomain 只能进行一次配置。这意味着放置配置代码的最佳位置是在应用程序启动中,例如 ASP.NET 应用程序的 Global.asax 文件。
从 9.0 开始 Mapper.Initialize 方法就不可用了。
2.1 Profile
Profile 是组织映射的另一种方式。新建一个类,继承 Profile,并在构造函数中配置映射。
public class EmployeeProfile : Profile
{
public EmployeeProfile()
{
CreateMap<Employee, EmployeeDto>();
}
}
var config = new MapperConfiguration(cfg =>
{
cfg.AddProfile<EmployeeProfile>();
});
Profile 内部的配置仅适用于 Profile 内部的映射。应用于根配置的配置适用于所有创建的映射。
AutoMapper 也可以在指定的程序集中扫描从 Profile 继承的类,并将其添加到配置中。
var config = new MapperConfiguration(cfg =>
{
// 扫描当前程序集
cfg.AddMaps(System.AppDomain.CurrentDomain.GetAssemblies());
// 也可以传程序集名称(dll 名称)
cfg.AddMaps("LibCoreTest");
});
3 配置
3.1 命名约定
默认情况下,AutoMapper 基于相同的字段名映射,并且是 不区分大小写 的。
但有时,我们需要处理一些特殊的情况。
SourceMemberNamingConvention 表示源类型命名规则
DestinationMemberNamingConvention 表示目标类型命名规则
LowerUnderscoreNamingConvention 和 PascalCaseNamingConvention 是 AutoMapper 提供的两个命名规则。前者命名是小写并包含下划线,后者就是帕斯卡命名规则(每个单词的首字母大写)。
我的理解,如果源类型和目标类型分别采用了 蛇形命名法 和 驼峰命名法,那么就需要指定命名规则,使其能正确映射。
public class Foo
{
public int Id { get; set; }
public string MyName { get; set; }
}
public class FooDto
{
public int ID { get; set; }
public string My_Name { get; set; }
}
public void Map()
{
var config = new MapperConfiguration(cfg =>
{
cfg.CreateMap<Foo, FooDto>();
cfg.SourceMemberNamingConvention = new PascalCaseNamingConvention();
cfg.DestinationMemberNamingConvention = new LowerUnderscoreNamingConvention();
});
var mapper = config.CreateMapper();
Foo foo = new Foo { Id = 2, MyName = "Tom" };
FooDto dto = mapper.Map<FooDto>(foo);
}
3.2 配置可见性
默认情况下,AutoMapper 仅映射 public 成员,但其实它是可以映射到 private 属性的。
var config = new MapperConfiguration(cfg =>
{
cfg.ShouldMapProperty = p => p.GetMethod.IsPublic || p.SetMethod.IsPrivate;
cfg.CreateMap<Source, Destination>();
});
需要注意的是,这里属性必须添加 private set,省略 set 是不行的。
3.3 全局属性/字段过滤
默认情况下,AutoMapper 尝试映射每个公共属性/字段。以下配置将忽略字段映射。
var config = new MapperConfiguration(cfg =>
{
cfg.ShouldMapField = fi => false;
});
3.4 识别前缀和后缀
var config = new MapperConfiguration(cfg =>
{
cfg.RecognizePrefixes("My");
cfg.RecognizePostfixes("My");
}
3.5 替换字符
var config = new MapperConfiguration(cfg =>
{
cfg.ReplaceMemberName("Ä", "A");
});
这功能我们基本上用不上。
4 调用构造函数
有些类,属性的 set 方法是私有的。
public class Commodity
{
public string Name { get; set; }
public int Price { get; set; }
}
public class CommodityDto
{
public string Name { get; }
public int Price { get; }
public CommodityDt