AutoMapper 是一个对象-对象映射器，可以将一个对象映射到另一个对象。 官网地址：http:/// 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 注册在使用 var config = new MapperConfiguration(cfg => cfg.CreateMap<Foo, FooDto>()); 每个 AppDomain 只能进行一次配置。这意味着放置配置代码的最佳位置是在应用程序启动中，例如 ASP.NET 应用程序的 Global.asax 文件。 从 9.0 开始 2.1 Profile
public class EmployeeProfile : Profile
{
public EmployeeProfile()
{
CreateMap<Employee, EmployeeDto>();
}
}
var config = new MapperConfiguration(cfg =>
{
cfg.AddProfile<EmployeeProfile>();
});
AutoMapper 也可以在指定的程序集中扫描从 var config = new MapperConfiguration(cfg =>
{
// 扫描当前程序集
cfg.AddMaps(System.AppDomain.CurrentDomain.GetAssemblies());
// 也可以传程序集名称（dll 名称）
cfg.AddMaps("LibCoreTest");
});3 配置3.1 命名约定默认情况下，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 仅映射 var config = new MapperConfiguration(cfg =>
{
cfg.ShouldMapProperty = p => p.GetMethod.IsPublic || p.SetMethod.IsPrivate;
cfg.CreateMap<Source, Destination>();
});需要注意的是，这里属性必须添加 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 调用构造函数有些类，属性的 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 CommodityDto(string name, int price)
{
Name = name;
Price = price * 2;
}
}AutoMapper 会自动找到相应的构造函数调用。如果在构造函数中对参数做一些改变的话，其改变会反应在映射结果中。如上例，映射后 禁用构造函数映射： var config = new MapperConfiguration(cfg => cfg.DisableConstructorMapping()); 禁用构造函数映射的话，目标类要有一个无参构造函数。 5 数组和列表映射数组和列表的映射比较简单，仅需配置元素类型，定义简单类型如下： public class Source
{
public int Value { get; set; }
}
public class Destination
{
public int Value { get; set; }
}映射： var config = new MapperConfiguration(cfg =>
{
cfg.CreateMap<Source, Destination>();
});
IMapper mapper = config.CreateMapper();
var sources = new[]
{
new Source { Value = 5 },
new Source { Value = 6 },
new Source { Value = 7 }
};
IEnumerable<Destination> ienumerableDest = mapper.Map<Source[], IEnumerable<Destination>>(sources);
ICollection<Destination> icollectionDest = mapper.Map<Source[], ICollection<Destination>>(sources);
IList<Destination> ilistDest = mapper.Map<Source[], IList<Destination>>(sources);
List<Destination> listDest = mapper.Map<Source[], List<Destination>>(sources);
Destination[] arrayDest = mapper.Map<Source[], Destination[]>(sources);具体来说，支持的源集合类型包括：
5.1 处理空集合映射集合属性时，如果源值为 5.2 集合中的多态这个官方的文档不是很好理解。我重新举个例子。实体类如下： public class Employee
{
public int ID { get; set; }
public string Name { get; set; }
}
public class Employee2 : Employee
{
public string DeptName { get; set; }
}
public class EmployeeDto
{
public int ID { get; set; }
public string Name { get; set; }
}
public class EmployeeDto2 : EmployeeDto
{
public string DeptName { get; set; }
}数组映射代码如下： var config = new MapperConfiguration(cfg =>
{
cfg.CreateMap<Employee, EmployeeDto>().Include<Employee2, EmployeeDto2>();
cfg.CreateMap<Employee2, EmployeeDto2>();
});
IMapper mapper = config.CreateMapper();
var employees = new[]
{
new Employee { ID = 1, Name = "Tom" },
new Employee2 { ID = 2, Name = "Jerry", DeptName = "R & D" }
};
var dto = mapper.Map<Employee[], EmployeeDto[]>(employees);可以看到，映射后， 如果去掉 6 方法到属性映射AutoMapper 不仅能实现属性到属性映射，还可以实现方法到属性的映射，并且不需要任何配置，方法名可以和属性名一致，也可以带有 例如下例的 public class Employee
{
public int ID { get; set; }
public string FirstName { get; set; }
public string LastName { get; set; }
public string GetFullName()
{
return $"{FirstName} {LastName}";
}
}
public class EmployeeDto
{
public int ID { get; set; }
public string FirstName { get; set; }
public string LastName { get; set; }
public string FullName { get; set; }
}7 自定义映射当源类型与目标类型名称不一致时，或者需要对源数据做一些转换时，可以用自定义映射。 public class Employee
{
public int ID { get; set; }
public string Name { get; set; }
public DateTime JoinTime { get; set; }
}
public class EmployeeDto
{
public int EmployeeID { get; set; }
public string EmployeeName { get; set; }
public int JoinYear { get; set; }
}如上例， var config = new MapperConfiguration(cfg =>
{
cfg.CreateMap<Employee, EmployeeDto>()
.ForMember("EmployeeID", opt => opt.MapFrom(src => src.ID))
.ForMember(dest => dest.EmployeeName, opt => opt.MapFrom(src => src.Name))
.ForMember(dest => dest.JoinYear, opt => opt.MapFrom(src => src.JoinTime.Year));
});8 扁平化映射对象-对象映射的常见用法之一是将复杂的对象模型并将其展平为更简单的模型。 public class Employee
{
public int ID { get; set; }
public string Name { get; set; }
public Department Department { get; set; }
}
public class Department
{
public int ID { get; set; }
public string Name { get; set; }
}
public class EmployeeDto
{
public int ID { get; set; }
public string Name { get; set; }
public int DepartmentID { get; set; }
public string DepartmentName { get; set; }
}如果目标类型上的属性，与源类型的属性、方法都对应不上，则 AutoMapper 会将目标成员名按驼峰法拆解成单个单词，再进行匹配。例如上例中， 8.1 IncludeMembers如果属性命名不符合上述的规则，而是像下面这样： public class Employee
{
public int ID { get; set; }
public string Name { get; set; }
public Department Department { get; set; }
}
public class Department
{
public int DepartmentID { get; set; }
public string DepartmentName { get; set; }
}
public class EmployeeDto
{
public int ID { get; set; }
public string Name { get; set; }
public int DepartmentID { get; set; }
public string DepartmentName { get; set; }
}
var config = new MapperConfiguration(cfg =>
{
cfg.CreateMap<Employee, EmployeeDto>().IncludeMembers(e => e.Department);
cfg.CreateMap<Department, EmployeeDto>();
});9 嵌套映射有时，我们可能不需要展平。看如下例子： public class Employee
{
public int ID { get; set; }
public string Name { get; set; }
public int Age { get; set; }
public Department Department { get; set; }
}
public class Department
{
public int ID { get; set; }
public string Name { get; set; }
public string Heads { get; set; }
}
public class EmployeeDto
{
public int ID { get; set; }
public string Name { get; set; }
public DepartmentDto Department { get; set; }
}
public class DepartmentDto
{
public int ID { get; set; }
public string Name { get; set; }
}我们要将 var config = new MapperConfiguration(cfg =>
{
cfg.CreateMap<Employee, EmployeeDto>();
cfg.CreateMap<Department, DepartmentDto>();
});
|
|
|
